dot

dotted

Python library that provides a method of accessing lists and dicts with a dotted path notation.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

128

Maintenance

Last Commit

6yrs ago

Contributors

5

Package

Dependencies

0

License

The MIT License (MIT) Copyright (c) 2014 Carlos Escribano Rey 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.

Categories

Readme

dotted

.. image:: https://pypip.in/version/dotted/badge.svg?style=flat :target: https://pypi.python.org/pypi/dotted/ :alt: Latest Version .. image:: https://travis-ci.org/carlosescri/DottedDict.svg?branch=master :target: https://travis-ci.org/carlosescri/DottedDict

A Python library that provides a method of accessing lists and dicts with a dotted path notation. It is useful to access a deep path inside a complex object composed of lists and dicts.

Quick & Dirty:

.. code-block:: python

from dotted.collection import DottedCollection, DottedDict, DottedList

obj = DottedCollection.factory(dict_or_list)
obj = DottedCollection.load_json(json_value)
obj = DottedDict(a_dict)
obj = DottedList(a_list)

from dotted.utils import dot, dot_json

obj = dot(dict_or_list)
obj = dot_json(json_value)

DottedDict and DottedList have the same accessors as dict and list so you can iterate them as usual. Both type of objects support access via a dotted path key.

Examples

Example #1: DottedList

.. code-block:: python

obj = DottedList([0, 1, 2, 3, [4, 5, 6], 7, 8, [9, 10]])

All of these are true:

.. code-block:: python

obj[0]     ==  0
obj['1']   ==  1
obj['4.0'] ==  4
obj['4.2'] ==  6
obj[5]     ==  7
obj['7.1'] == 10

If you want to append you can do:

.. code-block:: python

obj.append(12)

or:

.. code-block:: python

obj[8] = 11

but the latter only works if index == len(obj). In other case you will get a very pretty exception.

Example #2: DottedDict

.. code-block:: python

obj = DottedDict({'hello': {'world': {'wide': 'web'}}})

All of these are true:

.. code-block:: python

obj['hello'] == {'world': {'wide': 'web'}}
obj['hello.world'] == {'wide': 'web'}
obj['hello.world.wide'] == 'web'

obj.hello == {'world': {'wide': 'web'}}
obj.hello.world == {'wide': 'web'}
obj.hello.world.wide == 'web'

Example #3: Both working together

.. code-block:: python

obj = DottedCollection.factory({
    'hello': [{'world': {'wide': ['web', 'web', 'web']}}]
})

You can access:

.. code-block:: python

obj['hello'][0]['world']['wide'][0]
obj.hello[0].world.wide[0]
obj.hello[0].world['wide'][0]
obj.hello[0].world['wide.0']
obj.hello['0.world'].wide[0]
...
obj['hello.0.world.wide.0']

Example #4: When new values are dicts or lists

.. code-block:: python

obj = DottedCollection.factory(some_obj)

obj['some.path'] = {'hello': 'world'}  # will be converted to a DottedDict
obj['another.path'] = ['hello']  # will be converted to a DottedList

Example #5: Shortcuts

.. code-block:: python

from dotted.utils import dot, dot_json

obj = dot({'hello': 'world'})
obj = dot_json('{"hello": "world"}')

Example #6: Keys with dots inside!

Well, you can actually use escaped keys, but it's better to avoid them:

.. code-block:: python

from dotted.utils import dot, dot_json
obj = dot({"hello\.world": "Hello!"})
obj = dot_json('{"hello\\\\.world": "Hello!"}')
value = obj["hello\.world"]  # Hello!

That's all!

Tests

Run in the terminal from the parent directory:

.. code-block:: console

python -m dotted.test.test_collection

Special Thanks

  • Marc Abramowitz (@msabramo_)
  • Ryan Witt (@ryanwitt_)

.. @msabramo: https://github.com/msabramo .. @ryanwitt: https://github.com/ryanwitt

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100