[](https://travis-ci.org/clarete/forbiddenfruit)
# Forbidden Fruit
This project allows Python code to extend built-in types.
If that's a good idea or not, you tell me. The first need this project
attended was allowing a [Python assertion
library](https://github.com/gabrielfalcao/sure) to implement a similar
API to [RSpec
Expectations](https://github.com/rspec/rspec-expectations) and
[should.js](https://shouldjs.github.io/). But people got creative and
used it to among other things [spy on
things](https://github.com/ikamensh/flynt/blob/43a64ac1a030be79741402d8920a6da253a96670/src/flynt/file_spy.py)
or to [integrate
profiling](https://github.com/localstack/localstack/blob/e38eae0d1fe442924f4256d4bc87710a4cb6f142/localstack/utils/analytics/profiler.py).
## Tiny Example
It basically allows you to patch built-in objects, declared in C through
python. Just like this:
1. Add a new method to the `int` class:
```python
from forbiddenfruit import curse
def words_of_wisdom(self):
return self * "blah "
curse(int, "words_of_wisdom", words_of_wisdom)
assert (2).words_of_wisdom() == "blah blah "
```
2. Add a `classmethod` to the `str` class:
```python
from forbiddenfruit import curse
def hello(self):
return "blah"
curse(str, "hello", classmethod(hello))
assert str.hello() == "blah"
```
### Reversing a curse
If you want to free your object from a curse, you can use the `reverse()`
function. Just like this:
```python
from forbiddenfruit import curse, reverse
curse(str, "test", "blah")
assert 'test' in dir(str)
# Time to reverse the curse
reverse(str, "test")
assert 'test' not in dir(str)
```
**Beware:** `reverse()` only deletes attributes. If you `curse()`'d to replace
a pre-existing attribute, `reverse()` won't re-install the existing attribute.
### Context Manager / Decorator
`cursed()` acts as a context manager to make a `curse()`, and then `reverse()`
it on exit. It uses
[`contextlib.contextmanager()`](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager),
so on Python 3.2+ it can also be used as a function decorator. Like so:
```python
from forbiddenfruit import cursed
with cursed(str, "test", "blah"):
assert str.test == "blah"
assert "test" not in dir(str)
@cursed(str, "test", "blah")
def function():
assert str.test == "blah"
function()
assert "test" not in dir(str)
```
## Compatibility
Forbbiden Fruit is tested on CPython 2.7, 3.0, and 3.3-3.7.
Since Forbidden Fruit is fundamentally dependent on the C API,
this library won't work on other python implementations, such
as Jython, pypy, etc.
## License
Copyright (C) 2013,2019 Lincoln Clarete <lincoln@clarete.li>
This software is available under two different licenses at your
choice:
### GPLv3
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
### MIT
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Logo by
Kimberly Chandler, from The Noun Project
### Changelog
#### 0.1.4
* Add cursed() context manager/decorator
* Conditionally build test C extension
* Allow cursing dunder methods with non functions
* Fix dual licensing issues. Distribute both GPLv3 & MIT license
files.
Raw data
{
"_id": null,
"home_page": "https://github.com/clarete/forbiddenfruit",
"name": "forbiddenfruit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Lincoln de Sousa",
"author_email": "lincoln@clarete.li",
"download_url": "https://files.pythonhosted.org/packages/e6/79/d4f20e91327c98096d605646bdc6a5ffedae820f38d378d3515c42ec5e60/forbiddenfruit-0.1.4.tar.gz",
"platform": "",
"description": "[](https://travis-ci.org/clarete/forbiddenfruit)\n\n# Forbidden Fruit\n\n\n\nThis project allows Python code to extend built-in types.\n\nIf that's a good idea or not, you tell me. The first need this project\nattended was allowing a [Python assertion\nlibrary](https://github.com/gabrielfalcao/sure) to implement a similar\nAPI to [RSpec\nExpectations](https://github.com/rspec/rspec-expectations) and\n[should.js](https://shouldjs.github.io/). But people got creative and\nused it to among other things [spy on\nthings](https://github.com/ikamensh/flynt/blob/43a64ac1a030be79741402d8920a6da253a96670/src/flynt/file_spy.py)\nor to [integrate\nprofiling](https://github.com/localstack/localstack/blob/e38eae0d1fe442924f4256d4bc87710a4cb6f142/localstack/utils/analytics/profiler.py).\n\n## Tiny Example\n\nIt basically allows you to patch built-in objects, declared in C through\npython. Just like this:\n\n1. Add a new method to the `int` class:\n\n```python\nfrom forbiddenfruit import curse\n\n\ndef words_of_wisdom(self):\n return self * \"blah \"\n\n\ncurse(int, \"words_of_wisdom\", words_of_wisdom)\n\nassert (2).words_of_wisdom() == \"blah blah \"\n```\n\n2. Add a `classmethod` to the `str` class:\n\n```python\nfrom forbiddenfruit import curse\n\n\ndef hello(self):\n return \"blah\"\n\n\ncurse(str, \"hello\", classmethod(hello))\n\nassert str.hello() == \"blah\"\n```\n\n### Reversing a curse\n\nIf you want to free your object from a curse, you can use the `reverse()`\nfunction. Just like this:\n\n```python\nfrom forbiddenfruit import curse, reverse\n\ncurse(str, \"test\", \"blah\")\nassert 'test' in dir(str)\n\n# Time to reverse the curse\nreverse(str, \"test\")\nassert 'test' not in dir(str)\n```\n\n**Beware:** `reverse()` only deletes attributes. If you `curse()`'d to replace\na pre-existing attribute, `reverse()` won't re-install the existing attribute.\n\n### Context Manager / Decorator\n\n`cursed()` acts as a context manager to make a `curse()`, and then `reverse()`\nit on exit. It uses\n[`contextlib.contextmanager()`](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager),\nso on Python 3.2+ it can also be used as a function decorator. Like so:\n\n```python\nfrom forbiddenfruit import cursed\n\nwith cursed(str, \"test\", \"blah\"):\n assert str.test == \"blah\"\n\nassert \"test\" not in dir(str)\n\n\n@cursed(str, \"test\", \"blah\")\ndef function():\n assert str.test == \"blah\"\n\n\nfunction()\n\nassert \"test\" not in dir(str)\n```\n\n## Compatibility\n\nForbbiden Fruit is tested on CPython 2.7, 3.0, and 3.3-3.7.\n\nSince Forbidden Fruit is fundamentally dependent on the C API,\nthis library won't work on other python implementations, such\nas Jython, pypy, etc.\n\n## License\n\nCopyright (C) 2013,2019 Lincoln Clarete <lincoln@clarete.li>\n\nThis software is available under two different licenses at your\nchoice:\n\n### GPLv3\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n\n### MIT\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\nBE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\nACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n### Logo by\n\nKimberly Chandler, from The Noun Project\n\n### Changelog\n\n#### 0.1.4\n\n * Add cursed() context manager/decorator\n * Conditionally build test C extension\n * Allow cursing dunder methods with non functions\n * Fix dual licensing issues. Distribute both GPLv3 & MIT license\n files.",
"bugtrack_url": null,
"license": "",
"summary": "Patch python built-in objects",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/clarete/forbiddenfruit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e679d4f20e91327c98096d605646bdc6a5ffedae820f38d378d3515c42ec5e60",
"md5": "2f6765447076f15bbfa34da39dbdba03",
"sha256": "e3f7e66561a29ae129aac139a85d610dbf3dd896128187ed5454b6421f624253"
},
"downloads": -1,
"filename": "forbiddenfruit-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "2f6765447076f15bbfa34da39dbdba03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43756,
"upload_time": "2021-01-16T21:03:35",
"upload_time_iso_8601": "2021-01-16T21:03:35.401084Z",
"url": "https://files.pythonhosted.org/packages/e6/79/d4f20e91327c98096d605646bdc6a5ffedae820f38d378d3515c42ec5e60/forbiddenfruit-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-01-16 21:03:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "clarete",
"github_project": "forbiddenfruit",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "forbiddenfruit"
}
JSON
