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 -v
Feedback
--------
Open a ticket at http://github.com/dsc/bunch or send me an email at dsc@less.ly .
.. _PyYAML: http://pyyaml.org/wiki/PyYAML
Raw data
{
"_id": null,
"home_page": "http://github.com/dsc/bunch",
"name": "bunch",
"maintainer": "",
"docs_url": null,
"requires_python": null,
"maintainer_email": "",
"keywords": "bunch,dict,mapping,container,collection",
"author": "David Schoonover",
"author_email": "dsc@less.ly",
"download_url": "https://files.pythonhosted.org/packages/ef/bf/a4cf1779a4ffb4f610903fa08e15d1f4a8a2f4e3353a02afbe097c5bf4a8/bunch-1.0.1.tar.gz",
"platform": "",
"description": "bunch\r\n=====\r\n\r\nBunch is a dictionary that supports attribute-style access, a la JavaScript.\r\n\r\n>>> b = Bunch()\r\n>>> b.hello = 'world'\r\n>>> b.hello\r\n'world'\r\n>>> b['hello'] += \"!\"\r\n>>> b.hello\r\n'world!'\r\n>>> b.foo = Bunch(lol=True)\r\n>>> b.foo.lol\r\nTrue\r\n>>> b.foo is b['foo']\r\nTrue\r\n\r\n\r\nDictionary Methods\r\n------------------\r\n\r\nA Bunch is a subclass of ``dict``; it supports all the methods a ``dict`` does:\r\n\r\n>>> b.keys()\r\n['foo', 'hello']\r\n\r\nIncluding ``update()``:\r\n\r\n>>> b.update({ 'ponies': 'are pretty!' }, hello=42)\r\n>>> print repr(b)\r\nBunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\r\n\r\nAs well as iteration:\r\n\r\n>>> [ (k,b[k]) for k in b ]\r\n[('ponies', 'are pretty!'), ('foo', Bunch(lol=True)), ('hello', 42)]\r\n\r\nAnd \"splats\":\r\n\r\n>>> \"The {knights} who say {ni}!\".format(**Bunch(knights='lolcats', ni='can haz'))\r\n'The lolcats who say can haz!'\r\n\r\n\r\nSerialization\r\n-------------\r\n\r\nBunches happily and transparently serialize to JSON and YAML.\r\n\r\n>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\r\n>>> import json\r\n>>> json.dumps(b)\r\n'{\"ponies\": \"are pretty!\", \"foo\": {\"lol\": true}, \"hello\": 42}'\r\n\r\nIf JSON support is present (``json`` or ``simplejson``), ``Bunch`` will have a ``toJSON()`` method which returns the object as a JSON string.\r\n\r\nIf you have PyYAML_ installed, Bunch attempts to register itself with the various YAML Representers so that Bunches can be transparently dumped and loaded.\r\n\r\n>>> b = Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')\r\n>>> import yaml\r\n>>> yaml.dump(b)\r\n'!bunch.Bunch\\nfoo: !bunch.Bunch {lol: true}\\nhello: 42\\nponies: are pretty!\\n'\r\n>>> yaml.safe_dump(b)\r\n'foo: {lol: true}\\nhello: 42\\nponies: are pretty!\\n'\r\n\r\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.\r\n\r\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.\r\n\r\n\r\nMiscellaneous\r\n-------------\r\n\r\n* It is safe to ``import *`` from this module. You'll get: ``Bunch``, ``bunchify``, and ``unbunchify``.\r\n\r\n* Ample doctests::\r\n\r\n $ python -m bunch.test -v\r\n\r\n\r\nFeedback\r\n--------\r\n\r\nOpen a ticket at http://github.com/dsc/bunch or send me an email at dsc@less.ly .\r\n\r\n.. _PyYAML: http://pyyaml.org/wiki/PyYAML",
"bugtrack_url": null,
"license": "MIT",
"summary": "A dot-accessible dictionary (a la JavaScript objects)",
"version": "1.0.1",
"project_urls": {
"Download": "http://pypi.python.org/packages/source/b/bunch/bunch-1.0.1.tar.gz",
"Homepage": "http://github.com/dsc/bunch"
},
"split_keywords": [
"bunch",
"dict",
"mapping",
"container",
"collection"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "efbfa4cf1779a4ffb4f610903fa08e15d1f4a8a2f4e3353a02afbe097c5bf4a8",
"md5": "0a829d64e95ed96defbcae2bf9061bb0",
"sha256": "50c77a0fc0cb372dfe48b5e11937d5f70e743adbf42683f3a6d2857645a76aaa"
},
"downloads": -1,
"filename": "bunch-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0a829d64e95ed96defbcae2bf9061bb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6577,
"upload_time": "2011-12-27T21:43:57",
"upload_time_iso_8601": "2011-12-27T21:43:57.873610Z",
"url": "https://files.pythonhosted.org/packages/ef/bf/a4cf1779a4ffb4f610903fa08e15d1f4a8a2f4e3353a02afbe097c5bf4a8/bunch-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc56ceef9c8c12600a1ceb3dcefdd9e5094c72fbdba0c3af785b4a69205022c1",
"md5": "1d89b4e6ac970368cba8d8d47b2ba915",
"sha256": "3c554816ba260634b55c1edf8de6467d8122dbd18ec20f323e181869bc48ac93"
},
"downloads": -1,
"filename": "bunch-1.0.1.zip",
"has_sig": false,
"md5_digest": "1d89b4e6ac970368cba8d8d47b2ba915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11108,
"upload_time": "2011-12-27T21:43:56",
"upload_time_iso_8601": "2011-12-27T21:43:56.663580Z",
"url": "https://files.pythonhosted.org/packages/cc/56/ceef9c8c12600a1ceb3dcefdd9e5094c72fbdba0c3af785b4a69205022c1/bunch-1.0.1.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2011-12-27 21:43:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsc",
"github_project": "bunch",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "bunch"
}
JSON
