Skip to main content

A nested data structure for accessing and modifying values using a delimiter

Project description

Nested Inside

The Nested Inside package provides a nested data structure that allows for easy and intuitive access and modification of nested data. The package defines a Nested class that wraps a data structure (e.g. a dictionary, list, or tuple) and allows for nested access using a specified delimiter (default "->"). The class provides several methods such as get, set, parse to access and modify the nested data, and also provides derived classes such as NestedDict, NestedList, and NestedTuple to return the data in a modifiable or immutable format. This package can be especially useful when working with complex data structures that contain multiple nested levels, as it allows you to access and modify the data using a simple key path instead of having to navigate through multiple levels of nested data manually.

Installation

To install the package, use pip:

pip install nested_inside

Usage

The package provides a Nested class that wraps a data structure (e.g. a dictionary, list, or tuple) and allows for nested access using a specified delimiter (default "->").

from nested_inside import NestedDict

data = {
    "a": {
        "b": [1, 2, 3],
        "c": "hello"
    }
}
nested_data = NestedDict(data)

# Accessing nested values using get function
value = nested_data.get("a->b->0")
print(value) # 1

# Modifying nested values using set function
nested_data.set("a->b->0", 4)
# modify or access data using [] syntax
nested_data['a->b->1'] = 3
# modify or access data using object call
nested_data('a->b->2', 4)
# modify or access data using dot notation
nested_data.a.c = "world"

print(nested_data.a.b) # [4, 3, 4]
# call object without any parameter to retrieve data
print(nested_data('a->c'))

# Retrieving default value by providing value to default
value = nested_data("a->d", default="not found")
print(value) # "not found"

# Return mutable object
value = nested_data.get("a", modify=True)
# provide tuple as key to modify
value[["b"]] = [5, 6, 7]

# provide tuple as key
print(nested_data.get(("a","b"))) # [5, 6, 7]

# provide list as key
print(nested_data[["a","b", 2]]) # 7

# provide list as key with index as string
print(nested_data[["a","b", "0"]]) # 5

Methods

  • __init__(self, data: Any, delimiter: str = "->"): Initialize a new Nested object with the given data and delimiter.
  • parse(self, value: Any, modify: bool = False) -> Any: A helper function that converts the value to a modifiable or immutable object based on the 'modify' flag
  • get(self, key: Union[int, str, list, tuple, None], default=NODEFAULT, modify: bool = False) -> Any: Retrieves the value stored at the specified key path in the nested data structure.
  • set(self, key: Union[int, str, list, tuple], value: Any) -> None: Set the value stored at the specified key path in the nested data structure.

Contributing

If you would like to contribute to the package, feel free to submit a pull request.

License

The package is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nested_inside-0.2.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

nested_inside-0.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file nested_inside-0.2.tar.gz.

File metadata

  • Download URL: nested_inside-0.2.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for nested_inside-0.2.tar.gz
Algorithm Hash digest
SHA256 1af8ca353b43e1776df145b1457af9bc33902279e687239f827f874e1b959aea
MD5 8aec63e07ba50998ba418430b74e1ce0
BLAKE2b-256 647b22b0cb90ab88c87dbb9cf5776338b597f0f0bd4de1095254472915dffc37

See more details on using hashes here.

File details

Details for the file nested_inside-0.2-py3-none-any.whl.

File metadata

  • Download URL: nested_inside-0.2-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for nested_inside-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f44f3361c35eaed8967ede94faad64a767846fff7989dbdd11ff7768059c077
MD5 ae5187b5e0f92f7d3a15ad33d7668f04
BLAKE2b-256 d0be69cb88c74200d7b74e941557cb9708417ff7ae947bd239fcde9666403f00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page