├── .gitignore ├── .hgignore ├── .hgtags ├── LICENSE ├── README.md ├── using_api_cpp_classes ├── Makefile ├── Rectangle.cpp ├── Rectangle.h ├── rect.pyx ├── rect_pythran.py ├── setup.py └── test.py ├── using_api_keyword ├── Makefile ├── README.rst ├── add.pyx ├── add_int.pyx ├── add_pythran.py ├── setup_add.py └── test.py ├── using_cpython_pycapsule ├── Makefile ├── Rectangle.cpp ├── Rectangle.h ├── call_capsule_pythran.py ├── rect.pyx ├── setup.py └── test.py ├── using_cpython_pycapsule_class ├── Makefile ├── call_capsule_c.c ├── call_capsule_pythran.py ├── setup.py ├── test.py └── twice.pyx ├── using_cpython_pycapsule_class_array ├── Makefile ├── call_capsule_pythran.py ├── setup.py ├── test.py └── twice.pyx ├── using_cpython_pycapsule_pointers ├── Makefile ├── Rectangle.cpp ├── Rectangle.h ├── call_capsule_pythran.py ├── rect.pyx ├── setup.py └── test.py ├── using_pxd ├── Makefile ├── add_int_example │ ├── Makefile │ ├── add_int.c │ ├── add_int.h │ ├── add_int.py │ ├── cy_add_int.pxd │ ├── cy_add_int.pyx │ ├── setup.py │ └── test.py ├── cy_myfunc.pxd ├── cy_myfunc.pyx ├── myfunc.c ├── myfunc.h ├── myfunc.py ├── pkg │ └── __init__.py ├── pkg_inplace │ ├── __init__.py │ ├── cy_myfunc.pxd │ ├── cy_myfunc.pyx │ └── myfunc.py ├── setup.py ├── setup_pkg.py ├── setup_pkg_inplace.py ├── test.py ├── test_pkg.py └── test_pkg_inplace.py └── using_scipy_lowlevelcallable ├── Makefile ├── test.py ├── testlib.c ├── testlib_cy.pyx └── testlib_numpy_cy.pyx /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | -------------------------------------------------------------------------------- /.hgignore: -------------------------------------------------------------------------------- 1 | syntax: glob 2 | 3 | *.pyd* 4 | *.pyc 5 | *~ 6 | *tmp 7 | 8 | \#*\# 9 | 10 | *.so 11 | *.o 12 | 13 | **/*.egg-info 14 | 15 | **/build/* 16 | 17 | using_cpython_pycapsule_class/twice.cpp -------------------------------------------------------------------------------- /.hgtags: -------------------------------------------------------------------------------- 1 | f1c9fe28c435ddf0bc5dd4155e5fc2f253ca9eed stackoverflow_question_47623241 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Experiments with Cython C API and PyCapsules 2 | 3 | Exploring different methods to activate the elusive `__pyx_capi__` attribute in 4 | Cython modules. 5 | 6 | While using pxd, it is important that: 7 | 8 | 1. the `.pyx` and `.pxd` files are built in-place, i.e. the source files are 9 | present where the `.so` file will appear. 10 | 11 | 2. `.pyx`, `.pxd` and `.so` files - all of them share the same name 12 | 13 | See the differences by building and testing `using_pxd/pkg` and 14 | `using_pxd/pkg_inplace` by running `make all_pkg` and `make all_pkg_inplace` 15 | respectively. 16 | 17 | ## Summary of the different attempts in this repo 18 | 19 | | Directory | Description | What works | What does not work | 20 | |-----------|-------------|------------|--------------------| 21 | | `using_pxd` | Demonstrates without using `api` keyword how `__pyx_capi__` attribute is generated by Cython. How it requires `pyx` and `pxd` files to be in-place during `build_ext` step. | Simple `build_ext` without packaging, in-place `build_ext` with packaging (see: `setup_pkg_inplace.py`) | When `build_ext` is done with packaging using the Cython sources in some other directory (see `setup_pkg.py`). | 22 | | `using_api_cpp_classes` | A Cython interface to a C++ class in `Rectangle.cpp`. Attempt to access a C++ bound method `getArea`. | Modified `api` can export PyCapsules for regular Cython functions alone, not for bound methods in Cython classes | Pythran cannot have a `struct` type as an argument; thus Pythran fails to compile. | 23 | | `using_api_keyword` | A pyx file containing a function which adds 2 arrays / memory-views and another pyx file which adds integers. Also, Pythran file which includes similar `add` functions and a Pythran exported PyCapsule. PyCapsules exported using Cython (`api`) and Pythran is fed into the Pythran function. | For **integer** type: Pythran calling Pythran-PyCapsule and Cython-PyCapsule. For array type: Pythran calling Pythran-PyCapsule. Direct Cython function calls. | For **array** type: Pythran calling Cython-PyCapsule | 24 | | `using_cpython_pycapsule` | Revisiting the `Rectangle.cpp` example, now with manually created PyCapsules through Cython. | A `cpdef` function which works as a wrapper to access the `getArea` C++ bound method: only has `int` as argument and return types. Different kinds of `twice` functions of unbound `cdef` type and bound `cpdef` and `static` types. | -no issues- | 25 | | `using_cpython_pycapsule_class` | A cleaner version of the previous case, containing only "twice-functions" | -ditto- | -ditto- and an attempt to write a C code with Python API to call the PyCapsule. | 26 | | `using_cpython_pycapsule_pointers` | Trying to use the `Rectangle.cpp` now with a bound-method with pointer arguments | -nothing works- | Unable to manually generate PyCapsules | 27 | | `using_cpython_pycapsule_class_array` | "Twice-functions" for an `array` of `float`s instead of a scalar `int` | Manually creating PyCapsules using `make_PyCapsule` function | Calling unbound and bound methods of `cdef`/`cpdef`/`static` types with `memoryview`/`ndarray` argument types from Pythran with the PyCapsules | 28 | | `using_scipy_lowlevelcallable` | Instead of Pythran, we try to call PyCapsules using `scipy.LowLevelCallable` feature. It extends [the `integrate.nquad` example](https://docs.scipy.org/doc/scipy/reference/tutorial/integrate.html#quad-callbacks) found in SciPy docs. We use Cython instead of `ctypes` to generate the LowLevelCallable for the same example | Cython function using `double*` argument | Cython function using a `memoryview` or `numpy` argument (Could be something related to SciPy internals, since scipy does a preliminary type checking using the PyCapsule's signature). | 29 | 30 | ## Similar Cython experiments by the community 31 | * https://github.com/pelson/calling_publicly_declared_cython_from_c 32 | * https://gist.github.com/insertinterestingnamehere/df7894b414a94a4456c5 33 | 34 | ## References 35 | * [SciPy 2015](https://github.com/scipy-conference/scipy_proceedings_2015/blob/master/papers/ian_henriksen/cython_blas_lapack_api.rst) | [PDF](http://conference.scipy.org/proceedings/scipy2015/pdfs/proceedings.pdf) 36 | * [serge-sans-paille/pythran#743](https://github.com/serge-sans-paille/pythran/issues/743) and [serge-sans-paille/pythran#746](https://github.com/serge-sans-paille/pythran/issues/746) 37 | * [cython/cython#2027](https://github.com/cython/cython/issues/2027) 38 | * [cython-devel mail, 2012 Feb](https://mail.python.org/pipermail/cython-devel/2012-February/001864.html) 39 | * [cython-users mail, 2012 Dec](http://grokbase.com/t/gg/cython-users/12cmf6zzm9/how-to-make-cython-generate-pyx-capi) 40 | * [stackexchange](https://stackoverflow.com/questions/40572073/how-to-create-a-public-cython-function-that-can-receive-c-struct-instance-or-p#40691577) 41 | * [cython-docs](http://docs.cython.org/en/latest/src/userguide/extension_types.html#name-specification-clause) 42 | -------------------------------------------------------------------------------- /using_api_cpp_classes/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | _cleanso: 4 | rm *.so 5 | 6 | clean: _cleanso 7 | rm rect_api.h rect.cpp rect.h 8 | rm -rf build 9 | 10 | build: 11 | python setup.py build_ext -i 12 | pythran -v rect_pythran.py 13 | 14 | test: 15 | python test.py 16 | -------------------------------------------------------------------------------- /using_api_cpp_classes/Rectangle.cpp: -------------------------------------------------------------------------------- 1 | #include "Rectangle.h" 2 | 3 | namespace shapes { 4 | 5 | Rectangle::Rectangle() { } 6 | 7 | Rectangle::Rectangle(int X0, int Y0, int X1, int Y1) { 8 | x0 = X0; 9 | y0 = Y0; 10 | x1 = X1; 11 | y1 = Y1; 12 | } 13 | 14 | Rectangle::~Rectangle() { } 15 | 16 | int Rectangle::getArea() { 17 | return (x1 - x0) * (y1 - y0); 18 | } 19 | 20 | void Rectangle::getSize(int *width, int *height) { 21 | (*width) = x1 - x0; 22 | (*height) = y1 - y0; 23 | } 24 | 25 | void Rectangle::move(int dx, int dy) { 26 | x0 += dx; 27 | y0 += dy; 28 | x1 += dx; 29 | y1 += dy; 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /using_api_cpp_classes/Rectangle.h: -------------------------------------------------------------------------------- 1 | 2 | namespace shapes { 3 | class Rectangle { 4 | public: 5 | int x0, y0, x1, y1; 6 | Rectangle(); 7 | Rectangle(int x0, int y0, int x1, int y1); 8 | ~Rectangle(); 9 | int getArea(); 10 | void getSize(int* width, int* height); 11 | void move(int dx, int dy); 12 | }; 13 | } 14 | -------------------------------------------------------------------------------- /using_api_cpp_classes/rect.pyx: -------------------------------------------------------------------------------- 1 | cdef extern from "Rectangle.h" namespace "shapes": 2 | cdef cppclass Rectangle: 3 | Rectangle() except + 4 | Rectangle(int, int, int, int) except + 5 | int x0, y0, x1, y1 6 | int getArea() 7 | void getSize(int* width, int* height) 8 | void move(int, int) 9 | 10 | 11 | cdef api int foo(int f): 12 | return f 13 | 14 | 15 | cdef api class PyRectangle [object cPyRectangle, type cPyRectangle_t]: 16 | cdef Rectangle c_rect # hold a C++ instance which we're wrapping 17 | def __cinit__(self, int x0, int y0, int x1, int y1): 18 | self.c_rect = Rectangle(x0, y0, x1, y1) 19 | cpdef api int get_area(self): 20 | return self.c_rect.getArea() 21 | def get_size(self): 22 | cdef int width, height 23 | self.c_rect.getSize(&width, &height) 24 | return width, height 25 | def move(self, dx, dy): 26 | self.c_rect.move(dx, dy) 27 | 28 | 29 | cdef api int getArea(Rectangle c_rect): 30 | return c_rect.getArea() 31 | 32 | 33 | cdef api int get_area_cy(PyRectangle py_rect): 34 | return py_rect.get_area() 35 | -------------------------------------------------------------------------------- /using_api_cpp_classes/rect_pythran.py: -------------------------------------------------------------------------------- 1 | from rect import PyRectangle 2 | 3 | # dont export get_area(PyRectangle, int(PyRectangle)) 4 | # pythran export get_area(struct, int (struct)) 5 | def get_area(py_rect, cy_get_area): 6 | return cy_get_area(py_rect) 7 | -------------------------------------------------------------------------------- /using_api_cpp_classes/setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | 4 | setup(ext_modules = cythonize(Extension( 5 | "rect", # the extension name 6 | sources=["rect.pyx", "Rectangle.cpp"], # the Cython source and 7 | # additional C++ source files 8 | language="c++", # generate and compile C++ code 9 | ))) 10 | -------------------------------------------------------------------------------- /using_api_cpp_classes/test.py: -------------------------------------------------------------------------------- 1 | 2 | import rect 3 | 4 | print(rect.__pyx_capi__) 5 | # {'foo': , 6 | # 'getArea': , 7 | # 'get_area_cy': } 8 | 9 | r = rect.PyRectangle(1, 2, 3, 4) 10 | print(r.__pyx_vtable__) 11 | # 12 | -------------------------------------------------------------------------------- /using_api_keyword/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | build: 4 | python setup_add.py 5 | pythran add_pythran.py -v 6 | 7 | _cleanso: 8 | rm -f *.so 9 | 10 | _cleanh: 11 | rm -f *.h 12 | 13 | _cleanc: 14 | rm -f *.c 15 | 16 | clean: _cleanc _cleanh _cleanso 17 | rm -rf build 18 | 19 | test: 20 | python test.py 21 | -------------------------------------------------------------------------------- /using_api_keyword/README.rst: -------------------------------------------------------------------------------- 1 | Using api keyword for simple function 2 | ===================================== 3 | 4 | It works for int but not for arrays (segfault) **when** the Cython PyCapsule is 5 | fed into Pythran function. 6 | 7 | I wonder if this is normal:: 8 | 9 | import add 10 | add.__pyx_capi__['add'] 11 | 12 | 13 | 14 | # Compared to ... 15 | import add_pythran 16 | 17 | add_pythran.add_capsule 18 | 19 | -------------------------------------------------------------------------------- /using_api_keyword/add.pyx: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | cimport numpy as np 3 | 4 | DTYPE = np.float64 5 | ctypedef np.float64_t DTYPE_t 6 | 7 | # cpdef api DTYPE_t[:, ::1] add( 8 | # np.ndarray[DTYPE_t, ndim=2] f, np.ndarray[DTYPE_t, ndim=2] g): 9 | cpdef api np.ndarray[DTYPE_t, ndim=2] add( 10 | DTYPE_t[:, ::1] f, DTYPE_t[:, ::1] g): 11 | cdef int i, j 12 | cdef int imax = f.shape[0] 13 | cdef int jmax = f.shape[1] 14 | cdef np.ndarray[DTYPE_t, ndim=2] r = np.zeros([imax, jmax], dtype=DTYPE) 15 | for i in range(imax): 16 | for j in range(jmax): 17 | r[i, j] = f[i, j] + g[i, j] 18 | 19 | return r 20 | -------------------------------------------------------------------------------- /using_api_keyword/add_int.pyx: -------------------------------------------------------------------------------- 1 | cdef api int add(int x, int y): 2 | cdef int r; 3 | r = x + y; 4 | return r 5 | -------------------------------------------------------------------------------- /using_api_keyword/add_pythran.py: -------------------------------------------------------------------------------- 1 | 2 | # pythran export capsule add_int_capsule(int, int) 3 | def add_int_capsule(f, g): 4 | return f + g 5 | 6 | # pythran export capsule add_capsule(float[][], float[][]) 7 | def add_capsule(f, g): 8 | return f + g 9 | 10 | # pythran export add(int, int, int(int, int)) 11 | # pythran export add(float[][], float[][], float[][](float[][], float[][])) 12 | 13 | def add(f, g, add_func): 14 | return add_func(f, g) 15 | -------------------------------------------------------------------------------- /using_api_keyword/setup_add.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | 4 | import numpy as np 5 | 6 | names = ['add', 'add_int'] 7 | 8 | 9 | extensions = [ 10 | Extension(name, [name + '.pyx'], include_dirs=[np.get_include()]) 11 | for name in names] 12 | 13 | 14 | setup( 15 | name="add", 16 | ext_modules=cythonize(extensions), 17 | script_name='setup.py', 18 | script_args=['build_ext', '--inplace'] 19 | ) 20 | -------------------------------------------------------------------------------- /using_api_keyword/test.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import numpy as np 3 | import add 4 | import add_int 5 | import add_pythran 6 | 7 | 8 | class TestAddInt(unittest.TestCase): 9 | def setUp(self): 10 | self.a = 1 11 | self.b = 2 12 | self.ans = self.a + self.b 13 | 14 | def test_pythran(self): 15 | ans2 = add_pythran.add(self.a, self.b, add_pythran.add_int_capsule) 16 | np.testing.assert_equal(ans2, self.ans) 17 | 18 | def test_pythran_cython(self): 19 | ans2 = add_pythran.add(self.a, self.b, add_int.__pyx_capi__['add']) 20 | np.testing.assert_equal(ans2, self.ans) 21 | 22 | 23 | class TestAddArray(unittest.TestCase): 24 | def setUp(self): 25 | self.a = np.ones((3, 3)) 26 | self.b = self.a * 3 27 | self.ans = self.a + self.b 28 | 29 | def test_pythran(self): 30 | ans2 = add_pythran.add(self.a, self.b, add_pythran.add_capsule) 31 | np.testing.assert_equal(ans2, self.ans) 32 | 33 | def test_cython(self): 34 | ans2 = add.add(self.a, self.b) 35 | np.testing.assert_equal(ans2, self.ans) 36 | 37 | def test_pythran_cython(self): 38 | """Results in segfault""" 39 | print('line commented because of segfault') 40 | # ans2 = add_pythran.add(self.a, self.b, add.__pyx_capi__['add']) 41 | # np.testing.assert_equal(ans2, self.ans) 42 | 43 | 44 | if __name__ == '__main__': 45 | unittest.main() 46 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | build: 4 | python setup.py build_ext -i 5 | pythran -v call_capsule_pythran.py 6 | 7 | _cleanso: 8 | rm -f *.so 9 | 10 | clean: _cleanso 11 | rm -f rect.cpp rect.h 12 | rm -rf build 13 | 14 | test: 15 | python -Wall test.py 16 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/Rectangle.cpp: -------------------------------------------------------------------------------- 1 | #include "Rectangle.h" 2 | 3 | namespace shapes { 4 | 5 | Rectangle::Rectangle() { } 6 | 7 | Rectangle::Rectangle(int X0, int Y0, int X1, int Y1) { 8 | x0 = X0; 9 | y0 = Y0; 10 | x1 = X1; 11 | y1 = Y1; 12 | } 13 | 14 | Rectangle::~Rectangle() { } 15 | 16 | int Rectangle::getArea() { 17 | return (x1 - x0) * (y1 - y0); 18 | } 19 | 20 | void Rectangle::getSize(int *width, int *height) { 21 | (*width) = x1 - x0; 22 | (*height) = y1 - y0; 23 | } 24 | 25 | void Rectangle::move(int dx, int dy) { 26 | x0 += dx; 27 | y0 += dy; 28 | x1 += dx; 29 | y1 += dy; 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/Rectangle.h: -------------------------------------------------------------------------------- 1 | 2 | namespace shapes { 3 | class Rectangle { 4 | public: 5 | int x0, y0, x1, y1; 6 | Rectangle(); 7 | Rectangle(int x0, int y0, int x1, int y1); 8 | ~Rectangle(); 9 | int getArea(); 10 | void getSize(int* width, int* height); 11 | void move(int dx, int dy); 12 | }; 13 | } 14 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/call_capsule_pythran.py: -------------------------------------------------------------------------------- 1 | 2 | # pythran export call_capsule(int(int), int) 3 | 4 | 5 | def call_capsule(capsule, n): 6 | r = capsule(n) 7 | return r 8 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/rect.pyx: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | from cpython.pycapsule cimport PyCapsule_New 4 | 5 | 6 | cdef extern from "Rectangle.h" namespace "shapes": 7 | cdef cppclass Rectangle: 8 | Rectangle() except + 9 | Rectangle(int, int, int, int) except + 10 | int x0, y0, x1, y1 11 | int getArea() 12 | void getSize(int* width, int* height) 13 | void move(int, int) 14 | 15 | 16 | ctypedef int(*f_ptr_type)(int) 17 | 18 | cdef make_PyCapsule(f_ptr_type f, string): 19 | return PyCapsule_New( 20 | f, string, NULL) 21 | 22 | _func_cache = [] 23 | 24 | cdef f_ptr_type py_to_fptr(f): 25 | import ctypes 26 | functype = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_int) 27 | ctypes_f = functype(f) 28 | _func_cache.append(ctypes_f) # ensure references are kept 29 | return (ctypes.addressof(ctypes_f))[0] 30 | 31 | 32 | cdef int twice_func(int c): 33 | return 2*c 34 | 35 | 36 | cdef class PyRectangle: 37 | cdef Rectangle c_rect # hold a C++ instance which we're wrapping 38 | cdef public dict __pyx_capi__ 39 | cdef public int myint 40 | 41 | def __cinit__(self, int x0, int y0, int x1, int y1): 42 | self.c_rect = Rectangle(x0, y0, x1, y1) 43 | 44 | def __init__(self, int x0, int y0, int x1, int y1): 45 | self.__pyx_capi__ = { 46 | 'twice_func': make_PyCapsule(twice_func, b'int (int)'), 47 | 'twice_static': make_PyCapsule(self.twice_static, b'int (int)'), 48 | 'twice_cpdef': make_PyCapsule( 49 | py_to_fptr(self.twice_cpdef), b'int (int)'), 50 | 'get_area': make_PyCapsule( 51 | py_to_fptr(self.get_area), b'int (int)'), 52 | 'twice_myint': make_PyCapsule( 53 | py_to_fptr(self.twice_myint), b'int (int)'), 54 | } 55 | 56 | # warning: cpdef is important here... 57 | cpdef int get_area(self, int c): 58 | print('in get_area', self) 59 | return self.c_rect.getArea() 60 | 61 | # warning: cpdef is important here... 62 | cpdef int twice_cpdef(self, int c): 63 | return 2*c 64 | 65 | cpdef int twice_myint(self, int c): 66 | self.myint = c 67 | return self.myint * 2 68 | 69 | @staticmethod 70 | cdef int twice_static(int c): 71 | return 2*c 72 | 73 | def get_size(self): 74 | cdef int width, height 75 | self.c_rect.getSize(&width, &height) 76 | return width, height 77 | 78 | def move(self, dx, dy): 79 | self.c_rect.move(dx, dy) 80 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | 4 | setup(ext_modules = cythonize(Extension( 5 | "rect", # the extension name 6 | sources=["rect.pyx", "Rectangle.cpp"], # the Cython source and 7 | # additional C++ source files 8 | language="c++", # generate and compile C++ code 9 | ))) 10 | -------------------------------------------------------------------------------- /using_cpython_pycapsule/test.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | try: 3 | import faulthandler 4 | faulthandler.enable() 5 | except ImportError: 6 | pass 7 | 8 | import unittest 9 | from rect import PyRectangle 10 | from call_capsule_pythran import call_capsule 11 | 12 | 13 | class TestAll(unittest.TestCase): 14 | def setUp(self): 15 | self.rect_x = 12 16 | self.rect_y = 14 17 | 18 | self.rect = PyRectangle(0, 0, self.rect_x, self.rect_y) 19 | self.capi = self.rect.__pyx_capi__ 20 | 21 | def test_pythran(self): 22 | 23 | keys = list(reversed(sorted(list(self.capi.keys())))) 24 | print(keys, '\n') 25 | value = 41 26 | 27 | for k in keys: 28 | print('function: ', k) 29 | capsule = self.capi[k] 30 | result = call_capsule(capsule, value) 31 | 32 | if k.startswith('twice'): 33 | if result != 2*value: 34 | how = 'wrong' 35 | else: 36 | how = 'good' 37 | 38 | print(how, 'result for capsule', k, '\n') 39 | 40 | if k.startswith('get_area'): 41 | print('result for get_area =', result, 'should be', 42 | self.rect_x * self.rect_y) 43 | 44 | 45 | if __name__ == '__main__': 46 | unittest.main() 47 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | build: 4 | python setup.py build_ext -i 5 | pythran -v call_capsule_pythran.py 6 | gcc `python-config --cflags --ldflags` call_capsule_c.c -o call_capsule_c.out 7 | 8 | _cleanso: 9 | rm -f *.so 10 | 11 | clean: _cleanso 12 | rm -f *.cpp *.out 13 | rm -f *_api.h 14 | rm -rf build 15 | 16 | test: 17 | python -Wall test.py 18 | @echo 'Testing call_capsule_c.c' 19 | ./call_capsule_c.out 20 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/call_capsule_c.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include "Python.h" 6 | #include "twice_api.h" 7 | 8 | // Reference: https://docs.python.org/2/extending/extending.html 9 | 10 | static void **PyTwice_API; 11 | 12 | static int 13 | import_twice2(void) 14 | { 15 | PyTwice_API = (void **)PyCapsule_Import("twice._C_API", 0); 16 | return (PyTwice_API != NULL) ? 0 : -1; 17 | } 18 | 19 | 20 | int 21 | main(int argc, char* argv[]) { 22 | int arg; 23 | 24 | arg = 123; 25 | 26 | printf("initializing..."); 27 | Py_Initialize(); 28 | printf("importing twice module..."); 29 | /* 30 | int result; 31 | if(import_twice() < 0) { 32 | printf("error importing! exiting..."); 33 | return -1; 34 | } 35 | printf("calling twice_func..."); 36 | result = twice_func(arg); 37 | printf("%d", result); 38 | */ 39 | 40 | // Trying to do everything from scratch 41 | PyObject *module; 42 | PyObject *my_callback = NULL; 43 | PyObject *arglist; 44 | PyObject *result; 45 | 46 | PyImport_ImportModule("twice"); 47 | if(import_twice2() < 0) { 48 | printf("error importing! exiting..."); 49 | return -1; 50 | } 51 | /* 52 | // Time to call the callback 53 | arglist = Py_BuildValue("(i)", arg); 54 | result = PyObject_CallObject(my_callback, arglist); 55 | Py_DECREF(arglist); 56 | Py_Finalize(); 57 | */ 58 | printf("All's well that ends well"); 59 | return 0; 60 | } 61 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/call_capsule_pythran.py: -------------------------------------------------------------------------------- 1 | 2 | # pythran export call_capsule(int(int), int) 3 | 4 | 5 | def call_capsule(capsule, n): 6 | r = capsule(n) 7 | return r 8 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | 4 | setup(ext_modules=cythonize(Extension( 5 | 'twice', sources=['twice.pyx'], language='c++'))) 6 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/test.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | try: 4 | import faulthandler 5 | faulthandler.enable() 6 | except ImportError: 7 | pass 8 | 9 | import unittest 10 | 11 | import twice as twice_module 12 | from twice import Twice 13 | from call_capsule_pythran import call_capsule 14 | 15 | 16 | class TestAll(unittest.TestCase): 17 | def setUp(self): 18 | self.obj = Twice() 19 | self.capi = self.obj.__pyx_capi__ 20 | 21 | def test_pythran_capi(self): 22 | capsule = twice_module.__pyx_capi__['twice_func'] 23 | value = 41 24 | print('Cython generated capsule twice_func') 25 | result = call_capsule(capsule, value) 26 | if result != 2 * value: 27 | how = 'wrong' 28 | else: 29 | how = 'good' 30 | 31 | print(how, 'result ({})\n'.format(result)) 32 | 33 | def test_pythran(self): 34 | value = 41 35 | print('\n') 36 | 37 | for name, capsule in self.capi.items(): 38 | print('capsule', name) 39 | result = call_capsule(capsule, value) 40 | 41 | if name.startswith('twice'): 42 | if result != 2*value: 43 | how = 'wrong' 44 | else: 45 | how = 'good' 46 | 47 | print(how, 'result ({})\n'.format(result)) 48 | 49 | 50 | if __name__ == '__main__': 51 | unittest.main() 52 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class/twice.pyx: -------------------------------------------------------------------------------- 1 | 2 | from cpython.pycapsule cimport PyCapsule_New 3 | 4 | ctypedef int(*f_ptr_type)(int) 5 | 6 | cdef make_PyCapsule(f_ptr_type f, string): 7 | return PyCapsule_New( 8 | f, string, NULL) 9 | 10 | _func_cache = [] 11 | 12 | cdef f_ptr_type py_to_fptr(f): 13 | import ctypes 14 | functype = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_int) 15 | ctypes_f = functype(f) 16 | _func_cache.append(ctypes_f) # ensure references are kept 17 | return (ctypes.addressof(ctypes_f))[0] 18 | 19 | 20 | cdef api int twice_func(int c): 21 | return 2*c 22 | 23 | 24 | cdef class Twice: 25 | cdef public dict __pyx_capi__ 26 | 27 | def __init__(self): 28 | self.__pyx_capi__ = { 29 | 'twice_func': make_PyCapsule(twice_func, b'int (int)'), 30 | 'twice_cpdef': make_PyCapsule( 31 | py_to_fptr(self.twice_cpdef), b'int (int)'), 32 | 'twice_static': make_PyCapsule(self.twice_static, b'int (int)'), 33 | } 34 | 35 | # warning: cpdef is important here... 36 | cpdef int twice_cpdef(self, int c): 37 | print('in twice_cpdef', self) 38 | return 2*c 39 | 40 | @staticmethod 41 | cdef int twice_static(int c): 42 | return 2*c 43 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class_array/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | build: 4 | python setup.py build_ext -i 5 | pythran -v call_capsule_pythran.py 6 | 7 | _cleanso: 8 | rm -f *.so 9 | 10 | clean: _cleanso 11 | rm -f *.cpp 12 | rm -f *api.h 13 | rm -rf build 14 | 15 | test: 16 | python -Wall test.py 17 | 18 | all: clean build test 19 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class_array/call_capsule_pythran.py: -------------------------------------------------------------------------------- 1 | 2 | # pythran export call_capsule(float[][](float[][]), float[][]) 3 | 4 | 5 | def call_capsule(capsule, n): 6 | r = capsule(n) 7 | return r 8 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class_array/setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | import numpy as np 4 | 5 | 6 | setup(ext_modules=cythonize( 7 | Extension( 8 | 'twice', sources=['twice.pyx'], language='c++', 9 | include_dirs=[np.get_include()]) 10 | )) 11 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class_array/test.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | try: 4 | import faulthandler 5 | faulthandler.enable() 6 | except ImportError: 7 | pass 8 | 9 | import unittest 10 | import numpy as np 11 | 12 | import twice as twice_module 13 | from twice import Twice 14 | from call_capsule_pythran import call_capsule 15 | 16 | 17 | class TestAll(unittest.TestCase): 18 | def setUp(self): 19 | self.obj = Twice() 20 | self.capi = self.obj.__pyx_capi__ 21 | self.value = np.ascontiguousarray(41 * np.eye(3)) 22 | 23 | def test_pythran(self): 24 | value = self.value 25 | print('\n') 26 | 27 | # self.capi.update(twice_module.__pyx_capi__) 28 | 29 | for name, capsule in self.capi.items(): 30 | print('capsule', name) 31 | result = call_capsule(capsule, value) 32 | 33 | if name.startswith('twice'): 34 | if np.all(np.equal(result, 2 * value)): 35 | how = 'good' 36 | else: 37 | how = 'wrong' 38 | 39 | print(how, 'result ({})\n'.format(result)) 40 | 41 | 42 | if __name__ == '__main__': 43 | unittest.main() 44 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_class_array/twice.pyx: -------------------------------------------------------------------------------- 1 | 2 | from cpython.pycapsule cimport PyCapsule_New 3 | import numpy as np 4 | cimport numpy as np 5 | from cython cimport view 6 | # from cython.view cimport memoryview as memview 7 | # from Cython.Compiler.PyrexTypes import memoryviewslice_type as memview 8 | 9 | 10 | cdef extern from "numpy/arrayobject.h": 11 | ctypedef int intp 12 | ctypedef extern class numpy.ndarray [object PyArrayObject]: 13 | pass 14 | 15 | # Basic datatypes 16 | # --------------- 17 | DTYPE = np.float64 18 | ctypedef np.float64_t DTYPE_t 19 | 20 | # Array datatypes 21 | # --------------- 22 | # DTYPE_ptr = np.ctypeslib.ndpointer(DTYPE) 23 | # ctypedef DTYPE_t_ptr np.ctypeslib.ndpointer(DTYPE_t) 24 | # ctypedef DTYPE_t[::, ::1] DTYPE_t_memview 25 | ctypedef DTYPE_t[::view.indirect_contiguous, ::view.contiguous] DTYPE_t_memview 26 | 27 | # Function datatypes 28 | # ------------------ 29 | # ctypedef np.ndarray (*f_ptr_type)(np.ndarray, int) 30 | ctypedef DTYPE_t_memview (*f_ptr_type)(DTYPE_t_memview) 31 | 32 | cdef make_PyCapsule(f_ptr_type f, string): 33 | return PyCapsule_New( 34 | f, string, NULL) 35 | 36 | _func_cache = [] 37 | 38 | 39 | # cpdef api np.ndarray[DTYPE_t, ndim=2] twice_func(np.ndarray[DTYPE_t, ndim=2] c): 40 | # cpdef api double** twice_func(double** c): 41 | # cdef api DTYPE_t[:, ::1] twice_func(DTYPE_t[:, ::1] c): 42 | # cdef DTYPE_t_memview twice_func(DTYPE_t_memview c): 43 | cdef DTYPE_t_memview twice_func(DTYPE_t_memview c) nogil: 44 | cdef int imax = c.shape[0] 45 | cdef int jmax = c.shape[1] 46 | # cdef np.ndarray[DTYPE_t, ndim=2] r = np.zeros([imax, jmax], dtype=DTYPE) 47 | for i in range(imax): 48 | for j in range(jmax): 49 | c[i, j] *= 2 50 | # r[i, j] = 2 * c[i, j] 51 | 52 | return c 53 | 54 | 55 | cdef class Twice: 56 | cdef public dict __pyx_capi__ 57 | 58 | def __init__(self): 59 | self.__pyx_capi__ = { 60 | 'twice_func': make_PyCapsule(twice_func, b'PyObject* (PyObject*)'), 61 | 'twice_static': make_PyCapsule(self.twice_static, b'PyObject* (PyObject*)'), 62 | # The following py_to_fptr call is not implemented yet: 63 | # 'twice_cpdef': make_PyCapsule( 64 | # py_to_fptr(self.twice_cpdef), b'int (int)') 65 | } 66 | 67 | # warning: cpdef is important here... 68 | cpdef DTYPE_t_memview twice_cpdef(self, DTYPE_t_memview c): 69 | print('in twice_cpdef', self) 70 | cdef int imax = c.shape[0] 71 | cdef int jmax = c.shape[1] 72 | # cdef np.ndarray[DTYPE_t, ndim=2] r = np.zeros([imax, jmax], dtype=DTYPE) 73 | for i in range(imax): 74 | for j in range(jmax): 75 | c[i, j] *= 2 76 | # r[i, j] = c[i,j] * 2 77 | 78 | return c 79 | 80 | @staticmethod 81 | cdef DTYPE_t_memview twice_static(DTYPE_t_memview c): 82 | cdef int imax = c.shape[0] 83 | cdef int jmax = c.shape[1] 84 | # cdef np.ndarray[DTYPE_t, ndim=2] r = np.zeros([imax, jmax], dtype=DTYPE) 85 | for i in range(imax): 86 | for j in range(jmax): 87 | c[i, j] *= 2 88 | # r[i, j] = c[i,j] * 2 89 | 90 | return c 91 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | build: 4 | python setup.py build_ext -i 5 | pythran -v call_capsule_pythran.py 6 | 7 | _cleanso: 8 | rm -f *.so 9 | 10 | clean: _cleanso 11 | rm -f rect.cpp rect.h 12 | rm -rf build 13 | 14 | test: 15 | python -Wall test.py 16 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/Rectangle.cpp: -------------------------------------------------------------------------------- 1 | #include "Rectangle.h" 2 | 3 | namespace shapes { 4 | 5 | Rectangle::Rectangle() { } 6 | 7 | Rectangle::Rectangle(int X0, int Y0, int X1, int Y1) { 8 | x0 = X0; 9 | y0 = Y0; 10 | x1 = X1; 11 | y1 = Y1; 12 | } 13 | 14 | Rectangle::~Rectangle() { } 15 | 16 | int Rectangle::getArea() { 17 | return (x1 - x0) * (y1 - y0); 18 | } 19 | 20 | void Rectangle::getSize(int *width, int *height) { 21 | (*width) = x1 - x0; 22 | (*height) = y1 - y0; 23 | } 24 | 25 | void Rectangle::move(int dx, int dy) { 26 | x0 += dx; 27 | y0 += dy; 28 | x1 += dx; 29 | y1 += dy; 30 | } 31 | 32 | int Rectangle::transform(double *input, double *output, int nb, double shift) { 33 | int i; 34 | for (i = 0; i < nb; i++) { 35 | output[i] = input[i] - shift; 36 | } 37 | return 1; 38 | } 39 | 40 | } 41 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/Rectangle.h: -------------------------------------------------------------------------------- 1 | 2 | namespace shapes { 3 | class Rectangle { 4 | public: 5 | int x0, y0, x1, y1; 6 | Rectangle(); 7 | Rectangle(int x0, int y0, int x1, int y1); 8 | ~Rectangle(); 9 | int getArea(); 10 | void getSize(int* width, int* height); 11 | void move(int dx, int dy); 12 | int transform(double *input, double *output, int nb_rows, double shift); 13 | }; 14 | } 15 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/call_capsule_pythran.py: -------------------------------------------------------------------------------- 1 | # pythran export call_capsule( 2 | # int(float64*, float64*, int, float64), float64*, float64*, int32, float64) 3 | 4 | 5 | def call_capsule(capsule, in_ptr, out_ptr, nb, shift): 6 | r = capsule(in_ptr, out_ptr, nb, shift) 7 | return r 8 | 9 | # Unable to do this 10 | # from numpy.ctypeslib import as_ctypes 11 | # # pythran export call_capsule( 12 | # # int(float64*, float64*, int32, float64), float64[], float64[], int32, float64) 13 | # 14 | # 15 | # def call_capsule(capsule, in_arr, out_arr, nb, shift): 16 | # in_ptr = as_ctypes(in_arr) 17 | # out_ptr = as_ctypes(out_arr) 18 | # r = capsule(in_ptr, out_ptr) 19 | # return r 20 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/rect.pyx: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | from cpython.pycapsule cimport PyCapsule_New 4 | 5 | 6 | cdef extern from "Rectangle.h" namespace "shapes": 7 | cdef cppclass Rectangle: 8 | Rectangle() except + 9 | Rectangle(int, int, int, int) except + 10 | int x0, y0, x1, y1 11 | int getArea() 12 | int transform(double *, double *, int, double) 13 | 14 | 15 | ctypedef int(*f_ptr_type)(double *, double *, int, double) 16 | 17 | cdef make_PyCapsule(f_ptr_type f, string): 18 | return PyCapsule_New( 19 | f, string, NULL) 20 | 21 | _func_cache = [] 22 | 23 | cdef f_ptr_type py_to_fptr(f): 24 | import ctypes 25 | 26 | c_double_p = ctypes.POINTER(ctypes.c_double) 27 | functype = ctypes.CFUNCTYPE( 28 | ctypes.c_int, 29 | c_double_p, c_double_p, ctypes.c_int, ctypes.c_double) 30 | ctypes_f = functype(f) 31 | _func_cache.append(ctypes_f) # ensure references are kept 32 | return (ctypes.addressof(ctypes_f))[0] 33 | 34 | 35 | cpdef int transform_func( 36 | double *in_ptr, double *out_ptr, int nb, double shift): 37 | cdef Rectangle c_rect 38 | c_rect = Rectangle(0, 0, 1, 1) 39 | return c_rect.transform(in_ptr, out_ptr, nb, shift) 40 | 41 | 42 | cdef class PyRectangle: 43 | cdef Rectangle c_rect # hold a C++ instance which we're wrapping 44 | cdef public dict __pyx_capi__ 45 | 46 | def __cinit__(self, int x0, int y0, int x1, int y1): 47 | self.c_rect = Rectangle(x0, y0, x1, y1) 48 | 49 | def __init__(self, int x0, int y0, int x1, int y1): 50 | self.__pyx_capi__ = { 51 | # 'get_area': make_PyCapsule( 52 | # py_to_fptr(self.get_area), b'int (int)'), 53 | 'transform': make_PyCapsule( 54 | # py_to_fptr(self.transform), 55 | # self.transform, 56 | # self.c_rect.transform, 57 | transform_func, 58 | b'int (double *, double *, int, double)'), 59 | } 60 | 61 | # warning: cpdef is important here... 62 | cpdef int get_area(self, int c): 63 | print('in get_area', self) 64 | return self.c_rect.getArea() 65 | 66 | # unable to use cpdef because of double* type 67 | cdef int transform( 68 | # self, in_ptr, out_ptr, nb, shift): 69 | self, double *in_ptr, double *out_ptr, int nb, double shift): 70 | return self.c_rect.transform(in_ptr, out_ptr, nb, shift) 71 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup, Extension 2 | from Cython.Build import cythonize 3 | 4 | setup(ext_modules = cythonize(Extension( 5 | "rect", # the extension name 6 | sources=["rect.pyx", "Rectangle.cpp"], # the Cython source and 7 | # additional C++ source files 8 | language="c++", # generate and compile C++ code 9 | ))) 10 | -------------------------------------------------------------------------------- /using_cpython_pycapsule_pointers/test.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | try: 3 | import faulthandler 4 | faulthandler.enable() 5 | except ImportError: 6 | pass 7 | 8 | import unittest 9 | import numpy as np 10 | from numpy.ctypeslib import as_ctypes 11 | from rect import PyRectangle 12 | from call_capsule_pythran import call_capsule 13 | 14 | 15 | class TestAll(unittest.TestCase): 16 | def setUp(self): 17 | self.nb = 10 18 | self.rect_in = np.arange(self.nb, dtype=np.float64) 19 | self.rect_out = np.arange(self.nb, dtype=np.float64) 20 | self.shift = 2.0 21 | 22 | self.rect = PyRectangle(0, 0, 1, 1) 23 | self.capi = self.rect.__pyx_capi__ 24 | 25 | def test_pythran(self): 26 | 27 | keys = list(self.capi.keys()) 28 | print(keys, '\n') 29 | 30 | capsule = self.capi['transform'] 31 | rect_in_ptr = as_ctypes(self.rect_in) 32 | rect_out_ptr = as_ctypes(self.rect_out) 33 | result = call_capsule( 34 | capsule, rect_in_ptr, rect_out_ptr, self.nb, self.shift) 35 | 36 | print('result for get_area =', result, 'should be', 1) 37 | 38 | 39 | if __name__ == '__main__': 40 | unittest.main() 41 | -------------------------------------------------------------------------------- /using_pxd/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | _clean: 4 | rm -rf build 5 | rm -f myfunc.o 6 | 7 | clean: _clean 8 | rm -f cy_myfunc.c 9 | rm -f *.so 10 | 11 | _compile: 12 | gcc -c myfunc.c -o myfunc.o 13 | 14 | build: _compile 15 | python setup.py 16 | pythran -v myfunc.py 17 | 18 | test: 19 | python test.py 20 | 21 | clean_pkg: _clean 22 | rm -f cy_myfunc.c 23 | rm -f pkg/*.so 24 | rm -rf pkg.egg-info 25 | 26 | build_pkg: _compile 27 | python setup_pkg.py develop 28 | pythran -v myfunc.py -o pkg/myfunc.so 29 | 30 | test_pkg: 31 | python test_pkg.py 32 | 33 | clean_pkg_inplace: _clean 34 | rm -f pkg_inplace/cy_myfunc.c 35 | rm -f pkg_inplace/*.so 36 | rm -rf pkg_inplace.egg-info 37 | 38 | build_pkg_inplace: _compile 39 | python setup_pkg_inplace.py develop 40 | pythran -v myfunc.py -o pkg_inplace/myfunc.so 41 | 42 | test_pkg_inplace: 43 | python test_pkg_inplace.py 44 | 45 | 46 | all: build test clean 47 | 48 | all_pkg: build_pkg test_pkg clean_pkg 49 | 50 | all_pkg_inplace: build_pkg_inplace test_pkg_inplace clean_pkg_inplace 51 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | clean: 4 | rm cy_add_int.c *.so 5 | rm -rf build 6 | rm add_int.o 7 | 8 | build: 9 | gcc -c add_int.c -o add_int.o 10 | python setup.py 11 | pythran add_int.py 12 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/add_int.c: -------------------------------------------------------------------------------- 1 | int add(int x, int y){ 2 | return x + y; 3 | } 4 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/add_int.h: -------------------------------------------------------------------------------- 1 | int add(int x, int y); 2 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/add_int.py: -------------------------------------------------------------------------------- 1 | # pythran export capsule f_capsule(int, int) 2 | def f_capsule(x, y): 3 | return x + y 4 | 5 | 6 | # pythran export add(int, int, int(int, int)) 7 | def add(x, y, func): 8 | return func(x, y) 9 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/cy_add_int.pxd: -------------------------------------------------------------------------------- 1 | cdef int cy_add(int x, int y) 2 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/cy_add_int.pyx: -------------------------------------------------------------------------------- 1 | cdef extern from 'add_int.h': 2 | int add(int x, int y) 3 | 4 | cdef int cy_add(int x, int y): 5 | return add(x, y) 6 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, Extension 2 | 3 | 4 | setup( 5 | ext_modules=[ 6 | Extension( 7 | 'cy_add_int', 8 | ['cy_add_int.pyx'], 9 | extra_link_args=['add_int.o'], 10 | ) 11 | ], 12 | script_name=['setup.py'], 13 | script_args=['build_ext', '--inplace'] 14 | ) 15 | 16 | 17 | import cy_add_int 18 | print(cy_add_int.__pyx_capi__['cy_add']) 19 | -------------------------------------------------------------------------------- /using_pxd/add_int_example/test.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import numpy as np 3 | import cy_add_int 4 | import add_int 5 | 6 | 7 | class TestAll(unittest.TestCase): 8 | def setUp(self): 9 | self.x = x = -100 10 | self.y = y = 2001 11 | self.ans = x + y 12 | 13 | def test_pythran(self): 14 | ans2 = add_int.add(self.x, self.y, add_int.f_capsule) 15 | np.testing.assert_equal(ans2, self.ans) 16 | 17 | def test_pythran_cython(self): 18 | ans2 = add_int.add(self.x, self.y, cy_add_int.__pyx_capi__['cy_add']) 19 | np.testing.assert_equal(ans2, self.ans) 20 | 21 | 22 | if __name__ == '__main__': 23 | unittest.main() 24 | -------------------------------------------------------------------------------- /using_pxd/cy_myfunc.pxd: -------------------------------------------------------------------------------- 1 | # cy_myfunc.pxd 2 | # Don't include the header here. 3 | # Only give the signature for the 4 | # Cython-exposed version of the function. 5 | cdef double cy_f(double x, double y) nogil 6 | -------------------------------------------------------------------------------- /using_pxd/cy_myfunc.pyx: -------------------------------------------------------------------------------- 1 | # cy_myfunc.pyx 2 | # Use a file-level directive to link 3 | # against the compiled object. 4 | # distutils: extra_link_args = ['myfunc.o'] 5 | cdef extern from 'myfunc.h': 6 | double f(double x, double y) nogil 7 | # Declare both the external function and 8 | # the Cython function as nogil so they can be 9 | # used without any Python operations 10 | # (other than loading the module). 11 | cdef double cy_f(double x, double y) nogil: 12 | return f(x, y) 13 | -------------------------------------------------------------------------------- /using_pxd/myfunc.c: -------------------------------------------------------------------------------- 1 | // myfunc.c 2 | double f(double x, double y){ 3 | return x * x - x * y + 3 * y; 4 | } 5 | -------------------------------------------------------------------------------- /using_pxd/myfunc.h: -------------------------------------------------------------------------------- 1 | // myfunc.h 2 | double f(double x, double y); 3 | -------------------------------------------------------------------------------- /using_pxd/myfunc.py: -------------------------------------------------------------------------------- 1 | # pythran export capsule f_capsule(float, float) 2 | def f_capsule(x, y): 3 | return x * x - x * y + 3 * y 4 | 5 | 6 | # pythran export f(float, float, float(float, float)) 7 | def f(x, y, func): 8 | return func(x, y) 9 | -------------------------------------------------------------------------------- /using_pxd/pkg/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ashwinvis/cython_capi/db86651b4fac4452ce5b9f99186b32b4b3c0cc4a/using_pxd/pkg/__init__.py -------------------------------------------------------------------------------- /using_pxd/pkg_inplace/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ashwinvis/cython_capi/db86651b4fac4452ce5b9f99186b32b4b3c0cc4a/using_pxd/pkg_inplace/__init__.py -------------------------------------------------------------------------------- /using_pxd/pkg_inplace/cy_myfunc.pxd: -------------------------------------------------------------------------------- 1 | # cy_myfunc.pxd 2 | # Don't include the header here. 3 | # Only give the signature for the 4 | # Cython-exposed version of the function. 5 | cdef double cy_f(double x, double y) nogil 6 | -------------------------------------------------------------------------------- /using_pxd/pkg_inplace/cy_myfunc.pyx: -------------------------------------------------------------------------------- 1 | # cy_myfunc.pyx 2 | # Use a file-level directive to link 3 | # against the compiled object. 4 | # distutils: extra_link_args = ['myfunc.o'] 5 | cdef extern from 'myfunc.h': 6 | double f(double x, double y) nogil 7 | # Declare both the external function and 8 | # the Cython function as nogil so they can be 9 | # used without any Python operations 10 | # (other than loading the module). 11 | cdef double cy_f(double x, double y) nogil: 12 | return f(x, y) 13 | -------------------------------------------------------------------------------- /using_pxd/pkg_inplace/myfunc.py: -------------------------------------------------------------------------------- 1 | # pythran export capsule f_capsule(float, float) 2 | def f_capsule(x, y): 3 | return x * x - x * y + 3 * y 4 | 5 | 6 | # pythran export f(float, float, float(float, float)) 7 | def f(x, y, func): 8 | return func(x, y) 9 | -------------------------------------------------------------------------------- /using_pxd/setup.py: -------------------------------------------------------------------------------- 1 | # cy_myfunc_setup.py 2 | from distutils.core import setup 3 | from Cython.Build import cythonize 4 | setup( 5 | ext_modules=cythonize('cy_myfunc.pyx'), 6 | script_name = ['setup.py'], 7 | script_args = ['build_ext', '--inplace'] 8 | ) 9 | -------------------------------------------------------------------------------- /using_pxd/setup_pkg.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, Extension 2 | 3 | setup( 4 | name='pkg', 5 | ext_modules=[ 6 | Extension( 7 | name='pkg.cy_myfunc', 8 | sources=['cy_myfunc.pyx'], 9 | extra_link_args=['myfunc.o'], 10 | ) 11 | ], 12 | ) 13 | -------------------------------------------------------------------------------- /using_pxd/setup_pkg_inplace.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, Extension 2 | 3 | setup( 4 | name='pkg_inplace', 5 | ext_modules=[ 6 | Extension( 7 | name='pkg_inplace.cy_myfunc', 8 | sources=['pkg_inplace/cy_myfunc.pyx'], 9 | extra_link_args=['myfunc.o'], 10 | ) 11 | ], 12 | ) 13 | -------------------------------------------------------------------------------- /using_pxd/test.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import numpy as np 3 | import cy_myfunc 4 | import myfunc 5 | 6 | 7 | class TestAll(unittest.TestCase): 8 | def setUp(self): 9 | self.x = x = -100. 10 | self.y = y = 2001. 11 | self.ans = x * x - x * y + 3 * y 12 | 13 | def test_pythran(self): 14 | ans2 = myfunc.f(self.x, self.y, myfunc.f_capsule) 15 | np.testing.assert_equal(ans2, self.ans) 16 | 17 | def test_pythran_cython(self): 18 | ans2 = myfunc.f(self.x, self.y, cy_myfunc.__pyx_capi__['cy_f']) 19 | np.testing.assert_equal(ans2, self.ans) 20 | 21 | 22 | if __name__ == '__main__': 23 | unittest.main() 24 | -------------------------------------------------------------------------------- /using_pxd/test_pkg.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import numpy as np 3 | from pkg import cy_myfunc, myfunc 4 | 5 | 6 | class TestAll(unittest.TestCase): 7 | def setUp(self): 8 | self.x = x = -100. 9 | self.y = y = 2001. 10 | self.ans = x * x - x * y + 3 * y 11 | 12 | def test_pythran(self): 13 | ans2 = myfunc.f(self.x, self.y, myfunc.f_capsule) 14 | np.testing.assert_equal(ans2, self.ans) 15 | 16 | def test_pythran_cython(self): 17 | ans2 = myfunc.f(self.x, self.y, cy_myfunc.__pyx_capi__['cy_f']) 18 | np.testing.assert_equal(ans2, self.ans) 19 | 20 | 21 | if __name__ == '__main__': 22 | unittest.main() 23 | -------------------------------------------------------------------------------- /using_pxd/test_pkg_inplace.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import numpy as np 3 | from pkg_inplace import cy_myfunc, myfunc 4 | 5 | 6 | class TestAll(unittest.TestCase): 7 | def setUp(self): 8 | self.x = x = -100. 9 | self.y = y = 2001. 10 | self.ans = x * x - x * y + 3 * y 11 | 12 | def test_pythran(self): 13 | ans2 = myfunc.f(self.x, self.y, myfunc.f_capsule) 14 | np.testing.assert_equal(ans2, self.ans) 15 | 16 | def test_pythran_cython(self): 17 | ans2 = myfunc.f(self.x, self.y, cy_myfunc.__pyx_capi__['cy_f']) 18 | np.testing.assert_equal(ans2, self.ans) 19 | 20 | 21 | if __name__ == '__main__': 22 | unittest.main() 23 | -------------------------------------------------------------------------------- /using_scipy_lowlevelcallable/Makefile: -------------------------------------------------------------------------------- 1 | build: 2 | gcc -shared -fPIC -o testlib.so testlib.c 3 | cythonize -i *.pyx 4 | 5 | clean: 6 | rm -f *.so *_api.h *_cy.c 7 | 8 | 9 | test: 10 | python test.py 11 | -------------------------------------------------------------------------------- /using_scipy_lowlevelcallable/test.py: -------------------------------------------------------------------------------- 1 | import os, ctypes 2 | from importlib import import_module 3 | from scipy import integrate, LowLevelCallable 4 | import numpy as np 5 | 6 | 7 | lib = ctypes.CDLL(os.path.abspath('testlib.so')) 8 | lib.f.restype = ctypes.c_double 9 | lib.f.argtypes = (ctypes.c_int, ctypes.POINTER(ctypes.c_double), ctypes.c_void_p) 10 | 11 | c = ctypes.c_double(1.0) 12 | user_data = ctypes.cast(ctypes.pointer(c), ctypes.c_void_p) 13 | 14 | 15 | def get_c_callback(): 16 | func = LowLevelCallable(lib.f, user_data) 17 | return func 18 | 19 | 20 | # One can force LowLevelCallable to skip type-checking of the PyCapsule by 21 | # explicitly mentioning the signature. However it results in segfault. 22 | 23 | def get_cy_callback(module_name): 24 | lib = import_module(module_name) 25 | return LowLevelCallable.from_cython(lib, 'f') # , signature='double (int, double *, void *)') # , user_data) 26 | 27 | 28 | func_c = get_c_callback() 29 | func_cy = get_cy_callback('testlib_cy') 30 | func_numpy_cy = get_cy_callback('testlib_numpy_cy') 31 | 32 | # Test the functions 33 | 34 | for functype, func in zip( 35 | ['pure c', 'cython pointer args', 'cython numpy args'], 36 | [func_c, func_cy, func_numpy_cy]): 37 | print(functype) 38 | result = integrate.nquad(func, np.array([[0, 10], [-10, 0], [-1, 1]])) 39 | print(result) 40 | -------------------------------------------------------------------------------- /using_scipy_lowlevelcallable/testlib.c: -------------------------------------------------------------------------------- 1 | /* testlib.c */ 2 | double f(int n, double *x, void *user_data) { 3 | double c = *(double *)user_data; 4 | // return c + x[0] - x[1] * x[2]; /* corresponds to c + x - y * z */ 5 | return x[0] - x[1] * x[2]; /* corresponds to c + x - y * z */ 6 | } 7 | -------------------------------------------------------------------------------- /using_scipy_lowlevelcallable/testlib_cy.pyx: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | cimport numpy as np 3 | 4 | # Working! 5 | cdef api double f(int n, double* x, void* cp): 6 | # cdef double c = *(double *)cp 7 | # c = cp[0] 8 | return x[0] - x[1] * x[2] # corresponds to x - y * z 9 | -------------------------------------------------------------------------------- /using_scipy_lowlevelcallable/testlib_numpy_cy.pyx: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | cimport numpy as np 3 | 4 | 5 | # cdef api double f(int n, np.ndarray[np.float64_t, ndim=1] x, void* cp): 6 | # cdef api double f(int n, np.ndarray[double, ndim=1] x, void* cp): 7 | # cdef api double f(int n, np.float64_t[::1] x, void* cp): 8 | cdef api double f(int n, double[::1] x, void* cp): 9 | return x[0] - x[1] * x[2] 10 | --------------------------------------------------------------------------------