bunch
=====
Bunch is a dictionary that supports attribute-style access, a la JavaScript.
>>> b = Bunch()
>>> b.hello = 'world'
>>> b.hello
'world'
>>> b['hello'] += "!"
>>> b.hello
'world!'
>>> b.foo = Bunch(lol=True)
>>> b.foo.lol
True
>>> b.foo is b['foo']
True
Dictionary Methods
------------------
A Bunch is a subclass of ``dict``; it supports all the methods a ``dict`` does:
>>> b.keys()
['foo', 'hello']
Including ``update()``:
>>> b.update({ 'ponies': 'are pretty!' }, hello=42)
>>> print repr(b)
Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')
As well as iteration:
>>> [ (k,b[k]) for k in b ]
[('ponies', 'are pretty!'), ('foo', Bunch(lol=True)), ('hello', 42)]
And "splats":
>>> "The {knights} who say {ni}!".format(**Bunch(knights='lolcats', ni='can haz'))
'The lolcats who say can haz!'
Serialization
-------------
Bunches happily and transparently serialize to JSON and YAML.
>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')
>>> import json
>>> json.dumps(b)
'{"ponies": "are pretty!", "foo": {"lol": true}, "hello": 42}'
If JSON support is present (``json`` or ``simplejson``), ``Bunch`` will have a ``toJSON()`` method which returns the object as a JSON string.
If you have PyYAML_ installed, Bunch attempts to register itself with the various YAML Representers so that Bunches can be transparently dumped and loaded.
>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')
>>> import yaml
>>> yaml.dump(b)
'!bunch.Bunch\nfoo: !bunch.Bunch {lol: true}\nhello: 42\nponies: are pretty!\n'
>>> yaml.safe_dump(b)
'foo: {lol: true}\nhello: 42\nponies: are pretty!\n'
In addition, Bunch instances will have a ``toYAML()`` method that returns the YAML string using ``yaml.safe_dump()``. This method also replaces ``__str__`` if present, as I find it far more readable. You can revert back to Python's default use of ``__repr__`` with a simple assignment: ``Bunch.__str__ = Bunch.__repr__``. The Bunch class will also have a static method ``Bunch.fromYAML()``, which loads a Bunch out of a YAML string.
Finally, Bunch converts easily and recursively to (``unbunchify()``, ``Bunch.toDict()``) and from (``bunchify()``, ``Bunch.fromDict()``) a normal ``dict``, making it easy to cleanly serialize them in other formats.
Miscellaneous
-------------
* It is safe to ``import *`` from this module. You'll get: ``Bunch``, ``bunchify``, and ``unbunchify``.
* Ample doctests::
$ python -m bunch.test
$ python -m bunch.test -v | tail -n22
1 items had no tests:
bunch.fromYAML
16 items passed all tests:
8 tests in bunch
13 tests in bunch.Bunch
7 tests in bunch.Bunch.__contains__
4 tests in bunch.Bunch.__delattr__
7 tests in bunch.Bunch.__getattr__
3 tests in bunch.Bunch.__repr__
5 tests in bunch.Bunch.__setattr__
2 tests in bunch.Bunch.fromDict
2 tests in bunch.Bunch.toDict
5 tests in bunch.bunchify
2 tests in bunch.from_yaml
3 tests in bunch.toJSON
6 tests in bunch.toYAML
3 tests in bunch.to_yaml
3 tests in bunch.to_yaml_safe
4 tests in bunch.unbunchify
77 tests in 17 items.
77 passed and 0 failed.
Test passed.
Feedback
--------
Open a ticket / fork the project on GitHub_, or send me an email at `dsc@less.ly`_.
.. _PyYAML: http://pyyaml.org/wiki/PyYAML
.. _GitHub: http://github.com/dsc/bunch
.. _dsc@less.ly: mailto:dsc@less.ly
Raw data
{
"_id": null,
"home_page": "https://github.com/wilbertom/bunch-py3",
"name": "bunch-py3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bunch,dict,mapping,container,collection,python 3",
"author": "Wilberto Morales",
"author_email": "wil@wilbertom.com",
"download_url": "https://files.pythonhosted.org/packages/14/92/5ba3f796212df4b5a8baf39dd7f082786cfde78cfbc45a73aa6a006b1771/bunch_py3-2.0.0.tar.gz",
"platform": null,
"description": "bunch\n=====\n\nBunch is a dictionary that supports attribute-style access, a la JavaScript.\n\n>>> b = Bunch()\n>>> b.hello = 'world'\n>>> b.hello\n'world'\n>>> b['hello'] += \"!\"\n>>> b.hello\n'world!'\n>>> b.foo = Bunch(lol=True)\n>>> b.foo.lol\nTrue\n>>> b.foo is b['foo']\nTrue\n\n\nDictionary Methods\n------------------\n\nA Bunch is a subclass of ``dict``; it supports all the methods a ``dict`` does:\n\n>>> b.keys()\n['foo', 'hello']\n\nIncluding ``update()``:\n\n>>> b.update({ 'ponies': 'are pretty!' }, hello=42)\n>>> print repr(b)\nBunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\n\nAs well as iteration:\n\n>>> [ (k,b[k]) for k in b ]\n[('ponies', 'are pretty!'), ('foo', Bunch(lol=True)), ('hello', 42)]\n\nAnd \"splats\":\n\n>>> \"The {knights} who say {ni}!\".format(**Bunch(knights='lolcats', ni='can haz'))\n'The lolcats who say can haz!'\n\n\nSerialization\n-------------\n\nBunches happily and transparently serialize to JSON and YAML.\n\n>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\n>>> import json\n>>> json.dumps(b)\n'{\"ponies\": \"are pretty!\", \"foo\": {\"lol\": true}, \"hello\": 42}'\n\nIf JSON support is present (``json`` or ``simplejson``), ``Bunch`` will have a ``toJSON()`` method which returns the object as a JSON string.\n\nIf you have PyYAML_ installed, Bunch attempts to register itself with the various YAML Representers so that Bunches can be transparently dumped and loaded.\n\n>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\n>>> import yaml\n>>> yaml.dump(b)\n'!bunch.Bunch\\nfoo: !bunch.Bunch {lol: true}\\nhello: 42\\nponies: are pretty!\\n'\n>>> yaml.safe_dump(b)\n'foo: {lol: true}\\nhello: 42\\nponies: are pretty!\\n'\n\nIn addition, Bunch instances will have a ``toYAML()`` method that returns the YAML string using ``yaml.safe_dump()``. This method also replaces ``__str__`` if present, as I find it far more readable. You can revert back to Python's default use of ``__repr__`` with a simple assignment: ``Bunch.__str__ = Bunch.__repr__``. The Bunch class will also have a static method ``Bunch.fromYAML()``, which loads a Bunch out of a YAML string.\n\nFinally, Bunch converts easily and recursively to (``unbunchify()``, ``Bunch.toDict()``) and from (``bunchify()``, ``Bunch.fromDict()``) a normal ``dict``, making it easy to cleanly serialize them in other formats.\n\n\nMiscellaneous\n-------------\n\n* It is safe to ``import *`` from this module. You'll get: ``Bunch``, ``bunchify``, and ``unbunchify``.\n\n* Ample doctests::\n\n $ python -m bunch.test\n $ python -m bunch.test -v | tail -n22\n 1 items had no tests:\n bunch.fromYAML\n 16 items passed all tests:\n 8 tests in bunch\n 13 tests in bunch.Bunch\n 7 tests in bunch.Bunch.__contains__\n 4 tests in bunch.Bunch.__delattr__\n 7 tests in bunch.Bunch.__getattr__\n 3 tests in bunch.Bunch.__repr__\n 5 tests in bunch.Bunch.__setattr__\n 2 tests in bunch.Bunch.fromDict\n 2 tests in bunch.Bunch.toDict\n 5 tests in bunch.bunchify\n 2 tests in bunch.from_yaml\n 3 tests in bunch.toJSON\n 6 tests in bunch.toYAML\n 3 tests in bunch.to_yaml\n 3 tests in bunch.to_yaml_safe\n 4 tests in bunch.unbunchify\n 77 tests in 17 items.\n 77 passed and 0 failed.\n Test passed.\n\n\nFeedback\n--------\n\nOpen a ticket / fork the project on GitHub_, or send me an email at `dsc@less.ly`_.\n\n.. _PyYAML: http://pyyaml.org/wiki/PyYAML\n.. _GitHub: http://github.com/dsc/bunch\n.. _dsc@less.ly: mailto:dsc@less.ly\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A dot-accessible dictionary (a la JavaScript objects)",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/wilbertom/bunch-py3"
},
"split_keywords": [
"bunch",
"dict",
"mapping",
"container",
"collection",
"python 3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14925ba3f796212df4b5a8baf39dd7f082786cfde78cfbc45a73aa6a006b1771",
"md5": "f7d8753e9c904d6a9d1dcd354c90fbcb",
"sha256": "53a4ddc3e0d8d133534fb9f3570911a17f029ae71d499872064e37bfdbb40810"
},
"downloads": -1,
"filename": "bunch_py3-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f7d8753e9c904d6a9d1dcd354c90fbcb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7446,
"upload_time": "2023-06-15T04:12:28",
"upload_time_iso_8601": "2023-06-15T04:12:28.234363Z",
"url": "https://files.pythonhosted.org/packages/14/92/5ba3f796212df4b5a8baf39dd7f082786cfde78cfbc45a73aa6a006b1771/bunch_py3-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 04:12:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wilbertom",
"github_project": "bunch-py3",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "bunch-py3"
}
JSON
