strct 0.0.16

A small pure-python package for data structure relatedutility functions.

A small pure-python package for data strcture related utility functions.

from strct.dict import get_nested_val

>>> dict_obj = {'a': {'b': 7}}
>>> get_nested_val(('a', 'b'), dict_obj)
7

Contents

• 1 Installation

• 2 Use

  • 2.1 dict

  • 2.2 list

  • 2.3 set

  • 2.4 sortedlist

  • 2.5 hash

• 3 Contributing

  • 3.1 Installing for development

  • 3.2 Running the tests

  • 3.3 Adding documentation

• 4 Credits

1 Installation

Install strct with:

pip install strct

2 Use

strct is divided into five sub-modules:

2.1 dict

Getting values from nested dicts in various ways; operations on number-valued dicts; merging, normalizing, reversing and printing dicts (nicely)

2.2 list

Index and element shifts that preserve order.

2.3 set

Getting a set element by a priority list.

2.4 sortedlist

Operations on sortedcontainers.SortedList objects.

2.5 hash

Provide cross-kernel stable hash functions that work for built-in data structures and types, and for any custom data structure complying with the iterable or dict schemes.

3 Contributing

Package author and current maintainer is Shay Palachy ([e-mail]); You are more than welcome to approach him for help. Contributions are very welcomed.

3.1 Installing for development

Clone:

git clone [e-mail]:shaypal5/strct.git

Install in development mode with test dependencies:

cd strct
pip install -e ".[test]"

3.2 Running the tests

To run the tests, use:

python -m pytest --cov=strct --doctest-modules

3.3 Adding documentation

This project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings (in my personal opinion, of course). When documenting code you add to this project, please follow these conventions.

4 Credits

Created by Shay Palachy ([e-mail]).