├── .gitignore ├── .travis.yml ├── COPYING ├── COPYING.mit ├── MANIFEST.in ├── Makefile ├── README.md ├── development.txt ├── forbiddenfruit └── __init__.py ├── logo.png ├── requirements.txt ├── setup.py ├── tests ├── __init__.py └── unit │ ├── __init__.py │ ├── ffruit.c │ └── test_forbidden_fruit.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.pyc 3 | *.DS_Store 4 | *.egg-info 5 | *.log 6 | *.so 7 | .coverage 8 | MANIFEST 9 | build/ 10 | dist/ 11 | .tox/ 12 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: jammy 2 | language: python 3 | python: 4 | - 3.7 5 | - 3.8 6 | - 3.9 7 | - 3.10 8 | - 3.11 9 | - 3.12 10 | - 3.13 11 | script: make 12 | install: 13 | - pip install -r development.txt 14 | - python setup.py build 15 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /COPYING.mit: -------------------------------------------------------------------------------- 1 | The MIT License 2 | 3 | Copyright (c) 2013, 2019 Lincoln Clarete 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include COPYING 3 | include COPYING.mit 4 | include requirements.txt 5 | graft tests 6 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Variables you might need to change in the first place 2 | # 3 | # This is probably the only section you'll need to change in this Makefile. 4 | # Also, make sure you don't remove the `' tag. Cause those marks 5 | # are going to be used to update this file automatically. 6 | # 7 | # 8 | PACKAGE=forbiddenfruit 9 | CUSTOM_PIP_INDEX= 10 | export FFRUIT_EXTENSION=true 11 | # 12 | 13 | all: unit functional integration 14 | 15 | unit: 16 | @make run_test suite=unit 17 | 18 | functional: 19 | @make run_test suite=functional 20 | 21 | integration: 22 | @make run_test suite=integration 23 | 24 | run_test: 25 | @if [ -d tests/$(suite) ]; then \ 26 | echo "Running \033[0;32m$(suite)\033[0m test suite"; \ 27 | make prepare; \ 28 | nosetests --stop --with-coverage --cover-package=$(PACKAGE) \ 29 | --cover-branches --verbosity=2 -s tests/$(suite) ; \ 30 | fi 31 | 32 | prepare: clean install_deps build_test_stub 33 | 34 | install_deps: 35 | @if [ -z $$SKIP_DEPS ]; then \ 36 | echo "Installing missing dependencies..."; \ 37 | [ -e requirements.txt ] && pip install -r requirements.txt &> .build.log; \ 38 | [ -e development.txt ] && pip install -r development.txt &> .build.log; \ 39 | fi 40 | 41 | build_test_stub: 42 | @python setup.py build 43 | @find ./build -name '*.so' -exec mv {} tests/unit \; 44 | 45 | clean: 46 | @echo "Removing garbage..." 47 | @find . -name '*.pyc' -delete 48 | @find . -name '*.so' -delete 49 | @find . -name __pycache__ -delete 50 | @rm -rf .coverage *.egg-info *.log build dist MANIFEST 51 | 52 | publish: 53 | @if [ -e "$$HOME/.pypirc" ]; then \ 54 | echo "Uploading to '$(CUSTOM_PIP_INDEX)'"; \ 55 | python setup.py sdist upload -r "$(CUSTOM_PIP_INDEX)"; \ 56 | else \ 57 | echo "You should create a file called \`.pypirc' under your home dir.\n"; \ 58 | echo "That's the right place to configure \`pypi' repos.\n"; \ 59 | echo "Read more about it here: https://github.com/Yipit/yipit/blob/dev/docs/rfc/RFC00007-python-packages.md"; \ 60 | exit 1; \ 61 | fi 62 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/clarete/forbiddenfruit.png?branch=master)](https://travis-ci.org/clarete/forbiddenfruit) 2 | 3 | # Forbidden Fruit 4 | 5 | ![Forbidden Fruit](logo.png) 6 | 7 | This project allows Python code to extend built-in types. 8 | 9 | If that's a good idea or not, you tell me. The first need this project 10 | attended was allowing a [Python assertion 11 | library](https://github.com/gabrielfalcao/sure) to implement a similar 12 | API to [RSpec 13 | Expectations](https://github.com/rspec/rspec-expectations) and 14 | [should.js](https://shouldjs.github.io/). But people got creative and 15 | used it to among other things [spy on 16 | things](https://github.com/ikamensh/flynt/blob/43a64ac1a030be79741402d8920a6da253a96670/src/flynt/file_spy.py) 17 | or to [integrate 18 | profiling](https://github.com/localstack/localstack/blob/e38eae0d1fe442924f4256d4bc87710a4cb6f142/localstack/utils/analytics/profiler.py). 19 | 20 | ## Tiny Example 21 | 22 | It basically allows you to patch built-in objects, declared in C through 23 | python. Just like this: 24 | 25 | 1. Add a new method to the `int` class: 26 | 27 | ```python 28 | from forbiddenfruit import curse 29 | 30 | 31 | def words_of_wisdom(self): 32 | return self * "blah " 33 | 34 | 35 | curse(int, "words_of_wisdom", words_of_wisdom) 36 | 37 | assert (2).words_of_wisdom() == "blah blah " 38 | ``` 39 | 40 | 2. Add a `classmethod` to the `str` class: 41 | 42 | ```python 43 | from forbiddenfruit import curse 44 | 45 | 46 | def hello(self): 47 | return "blah" 48 | 49 | 50 | curse(str, "hello", classmethod(hello)) 51 | 52 | assert str.hello() == "blah" 53 | ``` 54 | 55 | ### Reversing a curse 56 | 57 | If you want to free your object from a curse, you can use the `reverse()` 58 | function. Just like this: 59 | 60 | ```python 61 | from forbiddenfruit import curse, reverse 62 | 63 | curse(str, "test", "blah") 64 | assert 'test' in dir(str) 65 | 66 | # Time to reverse the curse 67 | reverse(str, "test") 68 | assert 'test' not in dir(str) 69 | ``` 70 | 71 | **Beware:** `reverse()` only deletes attributes. If you `curse()`'d to replace 72 | a pre-existing attribute, `reverse()` won't re-install the existing attribute. 73 | 74 | ### Context Manager / Decorator 75 | 76 | `cursed()` acts as a context manager to make a `curse()`, and then `reverse()` 77 | it on exit. It uses 78 | [`contextlib.contextmanager()`](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager), 79 | so on Python 3.2+ it can also be used as a function decorator. Like so: 80 | 81 | ```python 82 | from forbiddenfruit import cursed 83 | 84 | with cursed(str, "test", "blah"): 85 | assert str.test == "blah" 86 | 87 | assert "test" not in dir(str) 88 | 89 | 90 | @cursed(str, "test", "blah") 91 | def function(): 92 | assert str.test == "blah" 93 | 94 | 95 | function() 96 | 97 | assert "test" not in dir(str) 98 | ``` 99 | 100 | ## Compatibility 101 | 102 | Forbbiden Fruit is tested on CPython 3.7-3.13. 103 | 104 | Since Forbidden Fruit is fundamentally dependent on the C API, 105 | this library won't work on other python implementations, such 106 | as Jython, pypy, etc. 107 | 108 | ## License 109 | 110 | Copyright (C) 2013,2024 Lincoln Clarete 111 | 112 | This software is available under two different licenses at your 113 | choice: 114 | 115 | ### GPLv3 116 | 117 | This program is free software: you can redistribute it and/or modify 118 | it under the terms of the GNU General Public License as published by 119 | the Free Software Foundation, either version 3 of the License, or 120 | (at your option) any later version. 121 | 122 | This program is distributed in the hope that it will be useful, 123 | but WITHOUT ANY WARRANTY; without even the implied warranty of 124 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 125 | GNU General Public License for more details. 126 | 127 | You should have received a copy of the GNU General Public License 128 | along with this program. If not, see . 129 | 130 | ### MIT 131 | 132 | Permission is hereby granted, free of charge, to any person obtaining a copy 133 | of this software and associated documentation files (the "Software"), to deal 134 | in the Software without restriction, including without limitation the rights 135 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 136 | copies of the Software, and to permit persons to whom the Software is 137 | furnished to do so, subject to the following conditions: 138 | 139 | The above copyright notice and this permission notice shall be 140 | included in all copies or substantial portions of the Software. 141 | 142 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 143 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 144 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 145 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 146 | BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 147 | ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 148 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 149 | SOFTWARE. 150 | 151 | ### Logo by 152 | 153 | Kimberly Chandler, from The Noun Project 154 | 155 | ### Changelog 156 | 157 | #### 0.1.4 158 | 159 | * Add cursed() context manager/decorator 160 | * Conditionally build test C extension 161 | * Allow cursing dunder methods with non functions 162 | * Fix dual licensing issues. Distribute both GPLv3 & MIT license 163 | files. 164 | -------------------------------------------------------------------------------- /development.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | nose==1.2.1 3 | coverage==3.6 4 | tox==1.4.3 5 | -------------------------------------------------------------------------------- /forbiddenfruit/__init__.py: -------------------------------------------------------------------------------- 1 | # forbiddenfruit - Patch built-in python objects 2 | # 3 | # Copyright (c) 2013-2020 Lincoln de Sousa 4 | # 5 | # This program is dual licensed under GPLv3 and MIT. 6 | # 7 | # GPLv3 8 | # ----- 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | # 22 | # MIT 23 | # --- 24 | # Permission is hereby granted, free of charge, to any person obtaining a copy 25 | # of this software and associated documentation files (the "Software"), to deal 26 | # in the Software without restriction, including without limitation the rights 27 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 28 | # copies of the Software, and to permit persons to whom the Software is 29 | # furnished to do so, subject to the following conditions: 30 | # 31 | # The above copyright notice and this permission notice shall be 32 | # included in all copies or substantial portions of the Software. 33 | # 34 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 35 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 36 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 37 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 38 | # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 39 | # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 40 | # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 41 | # SOFTWARE. 42 | 43 | import gc 44 | import sys 45 | from types import FunctionType 46 | import ctypes 47 | import inspect 48 | from functools import wraps 49 | from collections import defaultdict 50 | from contextlib import contextmanager 51 | 52 | try: 53 | import __builtin__ 54 | except ImportError: 55 | # Python 3 support 56 | import builtins as __builtin__ 57 | 58 | __version__ = '0.1.4' 59 | 60 | __all__ = 'curse', 'curses', 'reverse' 61 | 62 | 63 | Py_ssize_t = ctypes.c_int64 if ctypes.sizeof(ctypes.c_void_p) == 8 else ctypes.c_int32 64 | 65 | 66 | # dictionary holding references to the allocated function resolution 67 | # arrays to type objects 68 | tp_as_dict = {} 69 | # container to cfunc callbacks 70 | tp_func_dict = {} 71 | 72 | 73 | class PyObject(ctypes.Structure): 74 | def incref(self): 75 | self.ob_refcnt += 1 76 | 77 | def decref(self): 78 | self.ob_refcnt -= 1 79 | 80 | class PyFile(ctypes.Structure): 81 | pass 82 | 83 | PyObject_p = ctypes.py_object 84 | Inquiry_p = ctypes.CFUNCTYPE(ctypes.c_int, PyObject_p) 85 | # return type is void* to allow ctypes to convert python integers to 86 | # plain PyObject* 87 | UnaryFunc_p = ctypes.CFUNCTYPE(ctypes.py_object, PyObject_p) 88 | BinaryFunc_p = ctypes.CFUNCTYPE(ctypes.py_object, PyObject_p, PyObject_p) 89 | TernaryFunc_p = ctypes.CFUNCTYPE(ctypes.py_object, PyObject_p, PyObject_p, PyObject_p) 90 | LenFunc_p = ctypes.CFUNCTYPE(Py_ssize_t, PyObject_p) 91 | SSizeArgFunc_p = ctypes.CFUNCTYPE(ctypes.py_object, PyObject_p, Py_ssize_t) 92 | SSizeObjArgProc_p = ctypes.CFUNCTYPE(ctypes.c_int, PyObject_p, Py_ssize_t, PyObject_p) 93 | ObjObjProc_p = ctypes.CFUNCTYPE(ctypes.c_int, PyObject_p, PyObject_p) 94 | 95 | FILE_p = ctypes.POINTER(PyFile) 96 | 97 | 98 | def get_not_implemented(): 99 | namespace = {} 100 | name = "_Py_NotImplmented" 101 | not_implemented = ctypes.cast( 102 | ctypes.pythonapi._Py_NotImplementedStruct, ctypes.py_object) 103 | 104 | ctypes.pythonapi.PyDict_SetItem( 105 | ctypes.py_object(namespace), 106 | ctypes.py_object(name), 107 | not_implemented 108 | ) 109 | return namespace[name] 110 | 111 | 112 | # address of the _Py_NotImplementedStruct singleton 113 | NotImplementedRet = get_not_implemented() 114 | 115 | class PyNumberMethods(ctypes.Structure): 116 | _fields_ = [ 117 | ('nb_add', BinaryFunc_p), 118 | ('nb_subtract', BinaryFunc_p), 119 | ('nb_multiply', BinaryFunc_p), 120 | ('nb_remainder', BinaryFunc_p), 121 | ('nb_divmod', BinaryFunc_p), 122 | ('nb_power', BinaryFunc_p), 123 | ('nb_negative', UnaryFunc_p), 124 | ('nb_positive', UnaryFunc_p), 125 | ('nb_absolute', UnaryFunc_p), 126 | ('nb_bool', Inquiry_p), 127 | ('nb_invert', UnaryFunc_p), 128 | ('nb_lshift', BinaryFunc_p), 129 | ('nb_rshift', BinaryFunc_p), 130 | ('nb_and', BinaryFunc_p), 131 | ('nb_xor', BinaryFunc_p), 132 | ('nb_or', BinaryFunc_p), 133 | ('nb_int', UnaryFunc_p), 134 | ('nb_reserved', ctypes.c_void_p), 135 | ('nb_float', UnaryFunc_p), 136 | 137 | ('nb_inplace_add', BinaryFunc_p), 138 | ('nb_inplace_subtract', BinaryFunc_p), 139 | ('nb_inplace_multiply', BinaryFunc_p), 140 | ('nb_inplace_remainder', BinaryFunc_p), 141 | ('nb_inplace_power', TernaryFunc_p), 142 | ('nb_inplace_lshift', BinaryFunc_p), 143 | ('nb_inplace_rshift', BinaryFunc_p), 144 | ('nb_inplace_and', BinaryFunc_p), 145 | ('nb_inplace_xor', BinaryFunc_p), 146 | ('nb_inplace_or', BinaryFunc_p), 147 | 148 | ('nb_floor_divide', BinaryFunc_p), 149 | ('nb_true_divide', BinaryFunc_p), 150 | ('nb_inplace_floor_divide', BinaryFunc_p), 151 | ('nb_inplace_true_divide', BinaryFunc_p), 152 | 153 | ('nb_index', BinaryFunc_p), 154 | 155 | ('nb_matrix_multiply', BinaryFunc_p), 156 | ('nb_inplace_matrix_multiply', BinaryFunc_p), 157 | ] 158 | 159 | class PySequenceMethods(ctypes.Structure): 160 | _fields_ = [ 161 | ('sq_length', LenFunc_p), 162 | ('sq_concat', BinaryFunc_p), 163 | ('sq_repeat', SSizeArgFunc_p), 164 | ('sq_item', SSizeArgFunc_p), 165 | ('was_sq_slice', ctypes.c_void_p), 166 | ('sq_ass_item', SSizeObjArgProc_p), 167 | ('was_sq_ass_slice', ctypes.c_void_p), 168 | ('sq_contains', ObjObjProc_p), 169 | ('sq_inplace_concat', BinaryFunc_p), 170 | ('sq_inplace_repeat', SSizeArgFunc_p), 171 | ] 172 | 173 | class PyMappingMethods(ctypes.Structure): 174 | pass 175 | 176 | class PyTypeObject(ctypes.Structure): 177 | pass 178 | 179 | class PyAsyncMethods(ctypes.Structure): 180 | pass 181 | 182 | 183 | PyObject._fields_ = [ 184 | ('ob_refcnt', Py_ssize_t), 185 | ('ob_type', ctypes.POINTER(PyTypeObject)), 186 | ] 187 | 188 | PyTypeObject._fields_ = [ 189 | # varhead 190 | ('ob_base', PyObject), 191 | ('ob_size', Py_ssize_t), 192 | # declaration 193 | ('tp_name', ctypes.c_char_p), 194 | ('tp_basicsize', Py_ssize_t), 195 | ('tp_itemsize', Py_ssize_t), 196 | ('tp_dealloc', ctypes.CFUNCTYPE(None, PyObject_p)), 197 | ('printfunc', ctypes.CFUNCTYPE(ctypes.c_int, PyObject_p, FILE_p, ctypes.c_int)), 198 | ('getattrfunc', ctypes.CFUNCTYPE(PyObject_p, PyObject_p, ctypes.c_char_p)), 199 | ('setattrfunc', ctypes.CFUNCTYPE(ctypes.c_int, PyObject_p, ctypes.c_char_p, PyObject_p)), 200 | ('tp_as_async', ctypes.CFUNCTYPE(PyAsyncMethods)), 201 | ('tp_repr', ctypes.CFUNCTYPE(PyObject_p, PyObject_p)), 202 | ('tp_as_number', ctypes.POINTER(PyNumberMethods)), 203 | ('tp_as_sequence', ctypes.POINTER(PySequenceMethods)), 204 | ('tp_as_mapping', ctypes.POINTER(PyMappingMethods)), 205 | ('tp_hash', ctypes.CFUNCTYPE(ctypes.c_int64, PyObject_p)), 206 | ('tp_call', ctypes.CFUNCTYPE(PyObject_p, PyObject_p, PyObject_p, PyObject_p)), 207 | ('tp_str', ctypes.CFUNCTYPE(PyObject_p, PyObject_p)), 208 | ('tp_getattro', ctypes.c_void_p), # Type not declared yet 209 | ('tp_setattro', ctypes.c_void_p), # Type not declared yet 210 | ('tp_as_buffer', ctypes.c_void_p), # Type not declared yet 211 | ('tp_flags', ctypes.c_void_p), # Type not declared yet 212 | ('tp_doc', ctypes.c_void_p), # Type not declared yet 213 | ('tp_traverse', ctypes.c_void_p), # Type not declared yet 214 | ('tp_clear', ctypes.c_void_p), # Type not declared yet 215 | ('tp_richcompare', ctypes.c_void_p), # Type not declared yet 216 | ('tp_weaklistoffset', ctypes.c_void_p), # Type not declared yet 217 | ('tp_iter', ctypes.c_void_p), # Type not declared yet 218 | ('iternextfunc', ctypes.c_void_p), # Type not declared yet 219 | ('tp_methods', ctypes.c_void_p), # Type not declared yet 220 | ('tp_members', ctypes.c_void_p), # Type not declared yet 221 | ('tp_getset', ctypes.c_void_p), # Type not declared yet 222 | ('tp_base', ctypes.c_void_p), # Type not declared yet 223 | ('tp_dict', ctypes.c_void_p), # Type not declared yet 224 | ('tp_descr_get', ctypes.c_void_p), # Type not declared yet 225 | ('tp_descr_set', ctypes.c_void_p), # Type not declared yet 226 | ('tp_dictoffset', ctypes.c_void_p), # Type not declared yet 227 | ('tp_init', ctypes.c_void_p), # Type not declared yet 228 | ('tp_alloc', ctypes.c_void_p), # Type not declared yet 229 | ('tp_new', ctypes.CFUNCTYPE(PyObject_p, PyObject_p, PyObject_p, ctypes.c_void_p)), 230 | # More struct fields follow but aren't declared here yet ... 231 | ] 232 | 233 | 234 | # redundant dict of pointee types, because ctypes doesn't allow us 235 | # to extract the pointee type from the pointer 236 | PyTypeObject_as_types_dict = { 237 | 'tp_as_async': PyAsyncMethods, 238 | 'tp_as_number': PyNumberMethods, 239 | 'tp_as_sequence': PySequenceMethods, 240 | 'tp_as_mapping': PyMappingMethods, 241 | } 242 | 243 | 244 | def patchable_builtin(klass): 245 | refs = gc.get_referents(klass.__dict__) 246 | assert len(refs) == 1 247 | return refs[0] 248 | 249 | 250 | @wraps(__builtin__.dir) 251 | def __filtered_dir__(obj=None): 252 | name = hasattr(obj, '__name__') and obj.__name__ or obj.__class__.__name__ 253 | if obj is None: 254 | # Return names from the local scope of the calling frame, 255 | # taking into account indirection added by __filtered_dir__ 256 | calling_frame = inspect.currentframe().f_back 257 | return sorted(calling_frame.f_locals.keys()) 258 | return sorted(set(__dir__(obj)).difference(__hidden_elements__[name])) 259 | 260 | # Switching to the custom dir impl declared above 261 | __hidden_elements__ = defaultdict(list) 262 | __dir__ = dir 263 | __builtin__.dir = __filtered_dir__ 264 | 265 | # build override information for dunder methods 266 | as_number = ('tp_as_number', [ 267 | ("add", "nb_add"), 268 | ("sub", "nb_subtract"), 269 | ("mul", "nb_multiply"), 270 | ("mod", "nb_remainder"), 271 | ("pow", "nb_power"), 272 | ("neg", "nb_negative"), 273 | ("pos", "nb_positive"), 274 | ("abs", "nb_absolute"), 275 | ("bool", "nb_bool"), 276 | ("inv", "nb_invert"), 277 | ("invert", "nb_invert"), 278 | ("lshift", "nb_lshift"), 279 | ("rshift", "nb_rshift"), 280 | ("and", "nb_and"), 281 | ("xor", "nb_xor"), 282 | ("or", "nb_or"), 283 | ("int", "nb_int"), 284 | ("float", "nb_float"), 285 | ("iadd", "nb_inplace_add"), 286 | ("isub", "nb_inplace_subtract"), 287 | ("imul", "nb_inplace_multiply"), 288 | ("imod", "nb_inplace_remainder"), 289 | ("ipow", "nb_inplace_power"), 290 | ("ilshift", "nb_inplace_lshift"), 291 | ("irshift", "nb_inplace_rshift"), 292 | ("iand", "nb_inplace_and"), 293 | ("ixor", "nb_inplace_xor"), 294 | ("ior", "nb_inplace_or"), 295 | ("floordiv", "nb_floor_divide"), 296 | ("div", "nb_true_divide"), 297 | ("ifloordiv", "nb_inplace_floor_divide"), 298 | ("idiv", "nb_inplace_true_divide"), 299 | ("index", "nb_index"), 300 | ("matmul", "nb_matrix_multiply"), 301 | ("imatmul", "nb_inplace_matrix_multiply"), 302 | ]) 303 | 304 | as_sequence = ("tp_as_sequence", [ 305 | ("len", "sq_length"), 306 | ("concat", "sq_concat"), 307 | ("repeat", "sq_repeat"), 308 | ("getitem", "sq_item"), 309 | ("setitem", "sq_ass_item"), 310 | ("contains", "sq_contains"), 311 | ("iconcat", "sq_inplace_concat"), 312 | ("irepeat", "sq_inplace_repeat"), 313 | ]) 314 | 315 | as_async = ("tp_as_async", [ 316 | ("await", "am_await"), 317 | ("aiter", "am_aiter"), 318 | ("anext", "am_anext"), 319 | ]) 320 | 321 | override_dict = {} 322 | for override in [as_number, as_sequence, as_async]: 323 | tp_as_name = override[0] 324 | for dunder, impl_method in override[1]: 325 | override_dict["__{}__".format(dunder)] = (tp_as_name, impl_method) 326 | 327 | # divmod isn't a dunder, still make it overridable 328 | override_dict['divmod()'] = ('tp_as_number', "nb_divmod") 329 | override_dict['__str__'] = ('tp_str', "tp_str") 330 | override_dict['__new__'] = ('tp_new', "tp_new") 331 | 332 | 333 | def _is_dunder(func_name): 334 | return func_name.startswith("__") and func_name.endswith("__") 335 | 336 | 337 | def _curse_special(klass, attr, func): 338 | """ 339 | Curse one of the "dunder" methods, i.e. methods beginning with __ which have a 340 | precial resolution code path 341 | """ 342 | assert callable(func) 343 | 344 | @wraps(func) 345 | def wrapper(*args, **kwargs): 346 | """ 347 | This wrapper returns the address of the resulting object as a 348 | python integer which is then converted to a pointer by ctypes 349 | """ 350 | try: 351 | return func(*args, **kwargs) 352 | except NotImplementedError: 353 | return NotImplementedRet 354 | 355 | tp_as_name, impl_method = override_dict[attr] 356 | 357 | # get the pointer to the correct tp_as_* structure 358 | # or create it if it doesn't exist 359 | tyobj = PyTypeObject.from_address(id(klass)) 360 | if tp_as_name in PyTypeObject_as_types_dict: 361 | struct_ty = PyTypeObject_as_types_dict[tp_as_name] 362 | tp_as_ptr = getattr(tyobj, tp_as_name) 363 | if not tp_as_ptr: 364 | # allocate new array 365 | tp_as_obj = struct_ty() 366 | tp_as_dict[(klass, attr)] = tp_as_obj 367 | tp_as_new_ptr = ctypes.cast(ctypes.addressof(tp_as_obj), 368 | ctypes.POINTER(struct_ty)) 369 | 370 | setattr(tyobj, tp_as_name, tp_as_new_ptr) 371 | tp_as = tp_as_ptr[0] 372 | 373 | # find the C function type 374 | for fname, ftype in struct_ty._fields_: 375 | if fname == impl_method: 376 | cfunc_t = ftype 377 | 378 | cfunc = cfunc_t(wrapper) 379 | tp_func_dict[(klass, attr)] = cfunc 380 | 381 | setattr(tp_as, impl_method, cfunc) 382 | else: 383 | # find the C function type 384 | for fname, ftype in PyTypeObject._fields_: 385 | if fname == impl_method: 386 | cfunc_t = ftype 387 | 388 | if not (klass, attr) in tp_as_dict: 389 | tp_as_dict[(klass, attr)] = ctypes.cast(getattr(tyobj, impl_method), cfunc_t) 390 | 391 | # override function call 392 | cfunc = cfunc_t(wrapper) 393 | tp_func_dict[(klass, attr)] = cfunc 394 | setattr(tyobj, impl_method, cfunc) 395 | 396 | def _revert_special(klass, attr): 397 | tp_as_name, impl_method = override_dict[attr] 398 | tyobj = PyTypeObject.from_address(id(klass)) 399 | tp_as_ptr = getattr(tyobj, tp_as_name) 400 | if tp_as_ptr: 401 | if tp_as_name in PyTypeObject_as_types_dict: 402 | tp_as = tp_as_ptr[0] 403 | 404 | struct_ty = PyTypeObject_as_types_dict[tp_as_name] 405 | for fname, ftype in struct_ty._fields_: 406 | if fname == impl_method: 407 | cfunc_t = ftype 408 | 409 | setattr(tp_as, impl_method, 410 | ctypes.cast(ctypes.c_void_p(None), cfunc_t)) 411 | else: 412 | if not (klass, attr) in tp_as_dict: 413 | # we didn't save this pointer 414 | # most likely never cursed 415 | return 416 | 417 | cfunc = tp_as_dict[(klass, attr)] 418 | setattr(tyobj, impl_method, cfunc) 419 | 420 | 421 | def curse(klass, attr, value, hide_from_dir=False): 422 | """Curse a built-in `klass` with `attr` set to `value` 423 | 424 | This function monkey-patches the built-in python object `attr` adding a new 425 | attribute to it. You can add any kind of argument to the `class`. 426 | 427 | It's possible to attach methods as class methods, just do the following: 428 | 429 | >>> def myclassmethod(cls): 430 | ... return cls(1.5) 431 | >>> curse(float, "myclassmethod", classmethod(myclassmethod)) 432 | >>> float.myclassmethod() 433 | 1.5 434 | 435 | Methods will be automatically bound, so don't forget to add a self 436 | parameter to them, like this: 437 | 438 | >>> def hello(self): 439 | ... return self * 2 440 | >>> curse(str, "hello", hello) 441 | >>> "yo".hello() 442 | "yoyo" 443 | """ 444 | if _is_dunder(attr): 445 | if sys.version_info < (3, 3): 446 | raise NotImplementedError( 447 | "Dunder overloading is only supported on Python >= 3.3") 448 | _curse_special(klass, attr, value) 449 | return 450 | 451 | dikt = patchable_builtin(klass) 452 | 453 | old_value = dikt.get(attr, None) 454 | old_name = '_c_%s' % attr # do not use .format here, it breaks py2.{5,6} 455 | 456 | # Patch the thing 457 | dikt[attr] = value 458 | 459 | if old_value: 460 | hide_from_dir = False # It was already in dir 461 | dikt[old_name] = old_value 462 | 463 | try: 464 | dikt[attr].__name__ = old_value.__name__ 465 | except (AttributeError, TypeError): # py2.5 will raise `TypeError` 466 | pass 467 | try: 468 | dikt[attr].__qualname__ = old_value.__qualname__ 469 | except AttributeError: 470 | pass 471 | 472 | ctypes.pythonapi.PyType_Modified(ctypes.py_object(klass)) 473 | 474 | if hide_from_dir: 475 | __hidden_elements__[klass.__name__].append(attr) 476 | 477 | 478 | def reverse(klass, attr): 479 | """Reverse a curse in a built-in object 480 | 481 | This function removes *new* attributes. It's actually possible to remove 482 | any kind of attribute from any built-in class, but just DON'T DO IT :) 483 | 484 | Good: 485 | 486 | >>> curse(str, "blah", "bleh") 487 | >>> assert "blah" in dir(str) 488 | >>> reverse(str, "blah") 489 | >>> assert "blah" not in dir(str) 490 | 491 | Bad: 492 | 493 | >>> reverse(str, "strip") 494 | >>> " blah ".strip() 495 | Traceback (most recent call last): 496 | File "", line 1, in 497 | AttributeError: 'str' object has no attribute 'strip' 498 | 499 | """ 500 | if _is_dunder(attr): 501 | _revert_special(klass, attr) 502 | return 503 | 504 | dikt = patchable_builtin(klass) 505 | del dikt[attr] 506 | 507 | ctypes.pythonapi.PyType_Modified(ctypes.py_object(klass)) 508 | 509 | 510 | def curses(klass, name): 511 | """Decorator to add decorated method named `name` the class `klass` 512 | 513 | So you can use it like this: 514 | 515 | >>> @curses(dict, 'banner') 516 | ... def dict_banner(self): 517 | ... l = len(self) 518 | ... print('This dict has {0} element{1}'.format( 519 | ... l, l is 1 and '' or 's') 520 | >>> {'a': 1, 'b': 2}.banner() 521 | 'This dict has 2 elements' 522 | """ 523 | def wrapper(func): 524 | curse(klass, name, func) 525 | return func 526 | return wrapper 527 | 528 | 529 | @contextmanager 530 | def cursed(obj, attr, val, hide_from_dir=False): 531 | curse(obj, attr, val, hide_from_dir) 532 | try: 533 | yield 534 | finally: 535 | reverse(obj, attr) 536 | -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/clarete/forbiddenfruit/e22519264833fadff09dd652e4ad24576f6989ec/logo.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/clarete/forbiddenfruit/e22519264833fadff09dd652e4ad24576f6989ec/requirements.txt -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # forbiddenfruit - Patch built-in python objects 2 | # 3 | # Copyright (c) 2013,2019 Lincoln de Sousa 4 | # 5 | # This program is dual licensed under GPLv3 and MIT. 6 | # 7 | # GPLv3 8 | # ----- 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | # 22 | # MIT 23 | # --- 24 | # Permission is hereby granted, free of charge, to any person obtaining a copy 25 | # of this software and associated documentation files (the "Software"), to deal 26 | # in the Software without restriction, including without limitation the rights 27 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 28 | # copies of the Software, and to permit persons to whom the Software is 29 | # furnished to do so, subject to the following conditions: 30 | # 31 | # The above copyright notice and this permission notice shall be 32 | # included in all copies or substantial portions of the Software. 33 | # 34 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 35 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 36 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 37 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 38 | # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 39 | # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 40 | # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 41 | # SOFTWARE. 42 | 43 | 44 | import os 45 | from setuptools import setup, find_packages, Extension 46 | 47 | if os.environ.get('FFRUIT_EXTENSION', '') == 'true': 48 | ext_modules = [Extension('ffruit', sources=['tests/unit/ffruit.c'])] 49 | else: 50 | ext_modules = [] 51 | 52 | 53 | local_file = lambda f: \ 54 | open(os.path.join(os.path.dirname(__file__), f)).read() 55 | 56 | if __name__ == '__main__': 57 | setup( 58 | name='forbiddenfruit', 59 | version='0.1.4', 60 | description='Patch python built-in objects', 61 | long_description=local_file('README.md'), 62 | long_description_content_type='text/markdown', 63 | author='Lincoln de Sousa', 64 | author_email='lincoln@clarete.li', 65 | url='https://github.com/clarete/forbiddenfruit', 66 | packages=find_packages(exclude=['*tests*']), 67 | ext_modules=ext_modules, 68 | classifiers=[ 69 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 70 | 'License :: OSI Approved :: MIT License', 71 | ], 72 | ) 73 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/clarete/forbiddenfruit/e22519264833fadff09dd652e4ad24576f6989ec/tests/__init__.py -------------------------------------------------------------------------------- /tests/unit/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/clarete/forbiddenfruit/e22519264833fadff09dd652e4ad24576f6989ec/tests/unit/__init__.py -------------------------------------------------------------------------------- /tests/unit/ffruit.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include "structmember.h" 3 | 4 | 5 | static PyObject * 6 | ffruit_sum(PyObject *self, PyObject *args) 7 | { 8 | int a, b; 9 | if (!PyArg_ParseTuple(args, "ii", &a, &b)) 10 | return NULL; 11 | return Py_BuildValue("i", a + b); 12 | } 13 | 14 | 15 | typedef struct { 16 | PyObject_HEAD 17 | PyObject *args; 18 | PyObject *kwargs; 19 | int my_attr; 20 | } Dummy; 21 | 22 | 23 | static void 24 | Dummy_dealloc(Dummy *self) 25 | { 26 | Py_XDECREF(self->args); 27 | Py_XDECREF(self->kwargs); 28 | 29 | #if PY_MAJOR_VERSION < 3 30 | self->ob_type->tp_free((PyObject *) self); 31 | #else 32 | Py_TYPE(self)->tp_free((PyObject*)self); 33 | #endif 34 | } 35 | 36 | 37 | static PyObject * 38 | Dummy_new(PyTypeObject *type, PyObject *args, PyObject *kwargs) 39 | { 40 | Dummy *self; 41 | 42 | self = (Dummy *) type->tp_alloc(type, 0); 43 | if (self != NULL) { 44 | self->args = Py_None; 45 | Py_INCREF(Py_None); 46 | 47 | self->kwargs = Py_None; 48 | Py_INCREF(Py_None); 49 | } 50 | self->my_attr = 0; 51 | 52 | return (PyObject *) self; 53 | } 54 | 55 | 56 | static PyObject * 57 | Dummy_my_method(Dummy *self, PyObject *args, PyObject *kwargs) 58 | { 59 | kwargs = (kwargs == NULL) ? PyDict_New() : kwargs; 60 | return Py_BuildValue("(OO)", args, kwargs); 61 | } 62 | 63 | 64 | static PyMemberDef Dummy_members[] = { 65 | {"args", T_OBJECT_EX, offsetof(Dummy, args), 0, 66 | "Argument list passed to the __init__ method"}, 67 | {"kwargs", T_OBJECT_EX, offsetof(Dummy, kwargs), 0, 68 | "Keyword arguments passed to the __init__ method"}, 69 | {"my_attr", T_INT, offsetof(Dummy, my_attr), 0, 70 | "An instance attribute"}, 71 | {NULL} /* Sentinel */ 72 | }; 73 | 74 | 75 | static PyMethodDef Dummy_methods[] = { 76 | {"my_method", (PyCFunction) Dummy_my_method, METH_VARARGS | METH_KEYWORDS, 77 | "Return its argument list and keyword arguments"}, 78 | {NULL} /* Sentinel */ 79 | }; 80 | 81 | 82 | static PyTypeObject DummyType = { 83 | #if PY_MAJOR_VERSION < 3 84 | PyObject_HEAD_INIT(NULL) 85 | 0, /*ob_size*/ 86 | #else 87 | PyVarObject_HEAD_INIT(NULL, 0) 88 | #endif 89 | "ffruit.Dummy", /*tp_name*/ 90 | sizeof(Dummy), /*tp_basicsize*/ 91 | 0, /*tp_itemsize*/ 92 | (destructor) Dummy_dealloc,/*tp_dealloc*/ 93 | 0, /*tp_print*/ 94 | 0, /*tp_getattr*/ 95 | 0, /*tp_setattr*/ 96 | 0, /*tp_compare*/ 97 | 0, /*tp_repr*/ 98 | 0, /*tp_as_number*/ 99 | 0, /*tp_as_sequence*/ 100 | 0, /*tp_as_mapping*/ 101 | 0, /*tp_hash */ 102 | 0, /*tp_call*/ 103 | 0, /*tp_str*/ 104 | 0, /*tp_getattro*/ 105 | 0, /*tp_setattro*/ 106 | 0, /*tp_as_buffer*/ 107 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ 108 | "Dummy forbidden fruits", /*tp_doc*/ 109 | 0, /* tp_traverse */ 110 | 0, /* tp_clear */ 111 | 0, /* tp_richcompare */ 112 | 0, /* tp_weaklistoffset */ 113 | 0, /* tp_iter */ 114 | 0, /* tp_iternext */ 115 | Dummy_methods, /* tp_methods */ 116 | Dummy_members, /* tp_members */ 117 | 0, /* tp_getset */ 118 | 0, /* tp_base */ 119 | 0, /* tp_dict */ 120 | 0, /* tp_descr_get */ 121 | 0, /* tp_descr_set */ 122 | 0, /* tp_dictoffset */ 123 | (initproc) 0, /* tp_init */ 124 | 0, /* tp_alloc */ 125 | Dummy_new, /* tp_new */ 126 | }; 127 | 128 | 129 | static PyMethodDef FFruitMethods[] = { 130 | {"sum", ffruit_sum, METH_VARARGS, "sum two numbers."}, 131 | {NULL, NULL, 0, NULL} 132 | }; 133 | 134 | #if PY_MAJOR_VERSION >= 3 135 | static struct PyModuleDef ffruitmodule = { 136 | PyModuleDef_HEAD_INIT, 137 | "ffruit", 138 | "Toy module", 139 | -1, 140 | FFruitMethods 141 | }; 142 | 143 | #endif 144 | 145 | #ifndef PyMODINIT_FUNC /* declarations for DLL import/export */ 146 | # define PyMODINIT_FUNC void 147 | #endif 148 | 149 | #if PY_MAJOR_VERSION < 3 150 | # define FUNC_NAME initffruit 151 | #else 152 | # define FUNC_NAME PyInit_ffruit 153 | #endif 154 | 155 | PyMODINIT_FUNC 156 | FUNC_NAME(void) 157 | { 158 | PyObject *m = NULL; 159 | 160 | if (PyType_Ready(&DummyType) < 0) 161 | goto end; 162 | 163 | #if PY_MAJOR_VERSION < 3 164 | m = Py_InitModule("ffruit", FFruitMethods); 165 | #else 166 | m = PyModule_Create(&ffruitmodule); 167 | #endif 168 | if (m == NULL) 169 | goto end; 170 | 171 | Py_INCREF(&DummyType); 172 | PyModule_AddObject(m, "Dummy", (PyObject *)&DummyType); 173 | 174 | end: 175 | #if PY_MAJOR_VERSION < 3 176 | return; 177 | #else 178 | return m; 179 | #endif 180 | } 181 | -------------------------------------------------------------------------------- /tests/unit/test_forbidden_fruit.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from datetime import datetime 3 | from forbiddenfruit import cursed, curses, curse, reverse 4 | from types import FunctionType 5 | from nose.tools import nottest, istest 6 | 7 | # Our stub! :) 8 | from . import ffruit 9 | 10 | 11 | 12 | def almost_equal(a, b, e=0.001): 13 | """Helper method to compare floats""" 14 | return abs(a - b) < e 15 | 16 | 17 | skip_legacy = nottest if sys.version_info < (3, 3) else istest 18 | 19 | def test_cursing_a_builtin_class(): 20 | 21 | # Given that I have a function that returns *blah* 22 | def words_of_wisdom(self): 23 | return self * "blah " 24 | 25 | # When I try to curse a built-in class with that function 26 | curse(int, "words_of_wisdom", words_of_wisdom) 27 | 28 | # Then I see that the class was cursed 29 | assert (2).words_of_wisdom() == "blah blah " 30 | assert 'words_of_wisdom' in dir(int) 31 | 32 | 33 | def test_cursing_a_builtin_class_with_a_class_method(): 34 | 35 | # Given that I have a function that returns *blah* 36 | def hello(self): 37 | return "blah" 38 | 39 | # When I try to curse a built-in class with that function 40 | curse(str, "hello", classmethod(hello)) 41 | 42 | # Then I see that the class was cursed 43 | assert str.hello() == "blah" 44 | assert 'hello' in dir(str) 45 | 46 | 47 | @skip_legacy 48 | def test_cursing_a_builtin_class_dunder_with_a_random_callable(): 49 | # Given that I have an object that returns *blah* 50 | class Twelver(object): 51 | def __call__(self, one, two): 52 | return 12 53 | 54 | # When I try to curse a built-in class's __sub__ with that function 55 | curse(str, "__sub__", Twelver()) 56 | 57 | # Then I see that the class was cursed 58 | assert ("hello" - "world") == 12 59 | 60 | 61 | def test_reversing_a_builtin(): 62 | # Given that I have a cursed object 63 | curse(str, 'stuff', property(lambda s: s * 2)) 64 | 65 | # When I bless it 66 | reverse(str, 'stuff') 67 | 68 | # Then I see that str won't contain 69 | assert 'stuff' not in dir(str) 70 | 71 | 72 | def test_dir_filtering(): 73 | # Given that I curse the `str` built-in asking the curse to hide it from 74 | # the built-in `dir()` function 75 | curse(str, "my_stuff", "blah", hide_from_dir=True) 76 | 77 | # Then I see that my new stuff is installed but without appearing on dir 78 | assert str.my_stuff == "blah" 79 | assert "my_stuff" not in dir(str) 80 | 81 | 82 | def test_dir_filtering_same_symbol_different_type(): 83 | # Given that I curse both `str` and `int` built-ins but only hide the new 84 | # attribute from the one installed on `str` 85 | curse(str, "attr_x", "blah", hide_from_dir=True) 86 | curse(int, "attr_x", "blah") 87 | 88 | # Then I see that both attributes were installed, but only one is filtered 89 | # by dir 90 | assert str.attr_x == "blah" 91 | assert "attr_x" not in dir(str) 92 | 93 | assert int.attr_x == "blah" 94 | assert "attr_x" in dir(int) 95 | 96 | 97 | def test_dir_filtering_same_symbol_different_instance(): 98 | # Given that I curse both `str` and `int` built-ins 99 | curse(str, "attr_y", "stuff", hide_from_dir=True) 100 | curse(int, "attr_y", "stuff") 101 | 102 | # Then I see that the dir() thing also works for instances 103 | assert "Hello".attr_y == "stuff" 104 | assert "attr_y" not in dir("hello") 105 | 106 | assert (1).attr_y == "stuff" 107 | assert "attr_y" in dir(1) 108 | 109 | 110 | def test_overriding_class_method(): 111 | # Given that I have a cursed object 112 | curse(datetime, 'now', classmethod(lambda *p: False)) 113 | 114 | # Then I see that the method was replaced, but we still have the original 115 | # method set as `_c_apppend` 116 | assert '_c_now' in dir(datetime) 117 | assert datetime.now() is False 118 | assert datetime(2013, 4, 5).now() is False 119 | 120 | 121 | def test_overriding_instance_method(): 122 | # Given that I have an instance of a `Dummy` object 123 | obj = ffruit.Dummy() 124 | 125 | # When I curse an instance method 126 | curse(ffruit.Dummy, "my_method", lambda *a, **k: "Yo!") 127 | 128 | # Then I see that my object was cursed properly 129 | assert obj.my_method() == "Yo!" 130 | 131 | 132 | def test_overriding_non_c_things(): 133 | "The `curse` function should not blow up on non-c python objs" 134 | 135 | # Given that I have an instance of a python class 136 | class Yo(object): 137 | pass 138 | 139 | obj = Yo() 140 | 141 | # When I curse an instance method 142 | curse(Yo, "my_method", lambda *a, **k: "Yo" * 2) 143 | 144 | # Then I see that my object was cursed properly 145 | assert obj.my_method() == "YoYo" 146 | 147 | 148 | def test_overriding_list_append(): 149 | "The `curse` function should be able to curse existing symbols" 150 | 151 | # Given that I have an instance of a python class 152 | obj = [] 153 | 154 | # When I curse an instance method 155 | fn = lambda self, v: self._c_append(v) or self 156 | foo = curse(list, "append", fn) 157 | 158 | # Then I see that my object was cursed properly 159 | assert obj.append(1) == [1] 160 | assert obj.append(2) == [1, 2] 161 | assert 1 in obj 162 | assert 2 in obj 163 | 164 | 165 | def test_curses_decorator(): 166 | "curses() should curse a given klass with the decorated function" 167 | 168 | # Given that I have a decorated func 169 | @curses(str, 'md_title') 170 | def markdown_title(self): 171 | return '# %s' % self.title() 172 | 173 | # Then I see the `str` class was patched 174 | assert "lincoln".md_title() == "# Lincoln" 175 | 176 | 177 | def test_dir_without_args_returns_names_in_local_scope(): 178 | """dir() without arguments should return the names from the local scope 179 | of the calling frame, taking into account any indirection added 180 | by __filtered_dir__ 181 | """ 182 | 183 | # Given that I have a local scope with some names bound to values 184 | z = 1 185 | some_name = 42 186 | 187 | # Then I see that `dir()` correctly returns a sorted list of those names 188 | assert 'some_name' in dir() 189 | assert dir() == sorted(locals().keys()) 190 | 191 | 192 | @skip_legacy 193 | def test_dunder_func_chaining(): 194 | """Overload * (mul) operator to to chaining between functions""" 195 | def matmul_chaining(self, other): 196 | if not isinstance(other, FunctionType): 197 | raise NotImplementedError() 198 | def wrapper(*args, **kwargs): 199 | res = other(*args, **kwargs) 200 | if hasattr(res, "__iter__"): 201 | return self(*res) 202 | return self(res) 203 | 204 | return wrapper 205 | 206 | curse(FunctionType, "__mul__", matmul_chaining) 207 | f = lambda x, y: x * y 208 | g = lambda x: (x, x) 209 | 210 | squared = f * g 211 | 212 | for i in range(0, 10, 2): 213 | assert squared(i) == i ** 2 214 | 215 | 216 | @skip_legacy 217 | def test_dunder_list_map(): 218 | """Overload * (__mul__) operator to apply function to a list""" 219 | def map_list(func, list_): 220 | if not callable(func): 221 | raise NotImplementedError() 222 | return map(func, list_) 223 | 224 | curse(list, "__mul__", map_list) 225 | 226 | list_ = list(range(10)) 227 | times_2 = lambda x: x * 2 228 | 229 | assert list(times_2 * list_) == list(range(0, 20, 2)) 230 | 231 | 232 | @skip_legacy 233 | def test_dunder_unary(): 234 | """Overload ~ operator to compute a derivative of function""" 235 | def derive_func(func): 236 | e = 0.001 237 | def wrapper(x): 238 | """Poor man's derivation""" 239 | x_0 = x - e 240 | x_1 = x + e 241 | y_delta = func(x_1) - func(x_0) 242 | return y_delta / (2 * e) 243 | return wrapper 244 | 245 | curse(FunctionType, "__inv__", derive_func) 246 | 247 | f = lambda x: x**2 + x 248 | # true derivation 249 | f_ = lambda x: 2*x + 1 250 | 251 | assert almost_equal((~f)(10), f_(10)) 252 | 253 | 254 | @skip_legacy 255 | def test_sequence_dunder(): 256 | def derive_func(func, deriv_grad): 257 | if deriv_grad == 0: 258 | return func 259 | 260 | e = 0.0000001 261 | def wrapper(x): 262 | return (func(x + e) - func(x - e)) / (2 * e) 263 | if deriv_grad == 1: 264 | return wrapper 265 | return wrapper[deriv_grad - 1] 266 | 267 | curse(FunctionType, "__getitem__", derive_func) 268 | 269 | # a function an its derivations 270 | f = lambda x: x ** 3 - 2 * x ** 2 271 | f_1 = lambda x: 3 * x ** 2 - 4 * x 272 | f_2 = lambda x: 6 * x - 4 273 | 274 | for x in range(0, 10): 275 | x = float(x) / 10. 276 | assert almost_equal(f(x), f[0](x)) 277 | assert almost_equal(f_1(x), f[1](x)) 278 | # our hacky derivation becomes numerically unstable here 279 | assert almost_equal(f_2(x), f[2](x), e=.01) 280 | 281 | 282 | @skip_legacy 283 | def test_dunder_list_revert(): 284 | """Test reversion of a curse with dunders""" 285 | def map_list(func, list_): 286 | if not callable(func): 287 | raise NotImplementedError() 288 | return map(func, list_) 289 | 290 | curse(list, "__add__", map_list) 291 | 292 | list_ = list(range(10)) 293 | times_2 = lambda x: x * 2 294 | 295 | assert list(times_2 + list_) == list(range(0, 20, 2)) 296 | 297 | reverse(list, "__add__") 298 | try: 299 | times_2 + list_ 300 | except TypeError: 301 | pass 302 | else: 303 | # should always raise an exception 304 | assert False 305 | 306 | 307 | def test_cursing_a_reversed_curse(): 308 | curse(str, 'one', 1) 309 | assert str.one == 1 310 | 311 | reverse(str, 'one') 312 | curse(str, 'one', 2) 313 | assert str.one == 2 314 | 315 | @skip_legacy 316 | def test_dunder_str(): 317 | assert str(1) == "1" 318 | def always_one(self): 319 | return 'one' 320 | curse(int, '__str__', always_one) 321 | assert str(1) == "one" 322 | reverse(int, '__str__') 323 | 324 | @skip_legacy 325 | def test_dunder_reverse(): 326 | def type_error_str(self): 327 | return 'type error' 328 | curse(TypeError, '__str__', type_error_str) 329 | te = TypeError("testing") 330 | assert str(te) == "type error" 331 | 332 | reverse(TypeError, '__str__') 333 | assert str(te) == "testing" 334 | 335 | @skip_legacy 336 | def test_dunder_new(): 337 | assert str(1) == "1" 338 | def the_answer(cls, args, kwargs): 339 | return 'fourty-two' 340 | curse(str, '__new__', the_answer) 341 | assert str(1) == "fourty-two" 342 | reverse(str, '__new__') 343 | assert str(1) == "1" 344 | 345 | def test_cursed_context_manager(): 346 | "The `cursed` context manager should curse an existing symbols in a scope" 347 | 348 | # Given that I have an instance of a python class 349 | obj = {'a': 1, 'b': 2} 350 | 351 | # When I curse an instance method 352 | with cursed(dict, "open_box", lambda self: 'surprise'): 353 | # Then I see that my object was cursed properly 354 | assert obj.open_box() == 'surprise' 355 | 356 | # And it was reversed 357 | assert "open_box" not in dir(obj) 358 | assert "open_box" not in dir(dict) 359 | 360 | 361 | @skip_legacy 362 | def test_cursed_decorator(): 363 | "The `cursed` decorator should curse an existing symbols during a function" 364 | 365 | # Given that I have an instance of a python class 366 | obj = {'a': 1, 'b': 2} 367 | 368 | # When I curse an instance method using the decorator form of `cursed` 369 | @cursed(dict, "open_box", lambda self: 'surprise') 370 | def function(): 371 | # Then I see that my object was cursed properly 372 | assert obj.open_box() == 'surprise' 373 | 374 | function() 375 | 376 | # And it was reversed 377 | assert "open_box" not in dir(obj) 378 | assert "open_box" not in dir(dict) 379 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (http://tox.testrun.org/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | 6 | [tox] 7 | envlist = py27, py30, py33, py34, py35, py36, py37 8 | 9 | [testenv] 10 | setenv = 11 | FFRUIT_EXTENSION = true 12 | whitelist_externals = make 13 | commands = make 14 | deps = 15 | nose 16 | coverage 17 | --------------------------------------------------------------------------------