https://github.com/zphang/sndict

Structured Nested Dictionaries
https://github.com/zphang/sndict

Last synced: 8 months ago
JSON representation

Structured Nested Dictionaries

• Host: GitHub
• URL: https://github.com/zphang/sndict
• Owner: zphang
• License: mit
• Created: 2017-03-14T18:31:25.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-07T13:16:48.000Z (about 1 year ago)
• Last Synced: 2025-04-13T10:12:48.477Z (8 months ago)
• Language: Python
• Homepage:
• Size: 136 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
====

Home

====

.. image:: https://img.shields.io/pypi/v/sndict.svg

        :target: https://pypi.python.org/pypi/sndict

.. image:: https://img.shields.io/travis/zphang/sndict.svg

        :target: https://travis-ci.org/zphang/sndict

.. image:: https://readthedocs.org/projects/sndict/badge/?version=latest

        :target: https://sndict.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/zphang/sndict/shield.svg

     :target: https://pyup.io/repos/github/zphang/sndict/

     :alt: Updates

Nested Extensions to Python dictionaries

* Free software: MIT license

* Documentation: https://sndict.readthedocs.io

* Code: https://github.com/zphang/sndict

Introduction

------------

This module provides extensions to ``dicts`` in the python standard library, providing fast and clean manipulation of nested dictionary structures. This module exposes two new ``dict``-types:

* ``NestedDict``/``ndict``: A light-weight wrapper for ``dict`` s that provides additional functionality for operations on nested dictionary structures.

* ``StructuredNestedDict``/``sndict``: A heavy-weight data ``dict`` -based structure for operating on hierarchical data with rich functionality for filtering and transformation across nested levels.

Both implementations are use ``OrderedDict`` s under the hood.

No additional dependencies are required.

Features

--------

* ``NestedDict``/``ndict``:

    - Iterating over flattened keys and values

    - Nested getting/setting operations

    - Applicable to dictionaries of arbitrary and unbalanced depth

* ``StructuredNestedDict``/``sndict``:

    - ``flatten``/``stratify``/``rearrange`` methods allow for powerful and rich operations across different levels of hierarchy

    - Nested getting/setting operations, including intelligent filtering via ``ix``

    - Convenient data inspection via ``dim``, ``unique_keys``, etc