https://github.com/gahjelle/datadict

Treat dataclasses like dictionaries
https://github.com/gahjelle/datadict

Last synced: 3 months ago
JSON representation

Treat dataclasses like dictionaries

• Host: GitHub
• URL: https://github.com/gahjelle/datadict
• Owner: gahjelle
• License: mit
• Created: 2020-07-20T10:58:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-30T08:16:51.000Z (over 2 years ago)
• Last Synced: 2024-08-09T05:50:15.579Z (5 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DataDict

_Treat dataclasses like dictionaries_

[![v1.0.0](https://img.shields.io/pypi/v/datadict.svg)](https://pypi.org/project/datadict/)

[![Python versions](https://img.shields.io/pypi/pyversions/datadict.svg)](https://pypi.org/project/datadict/)

[![Tests](https://img.shields.io/github/workflow/status/gahjelle/datadict/tests?label=tests)](https://github.com/realpython/codetiming/actions)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Interrogate](https://raw.githubusercontent.com/gahjelle/datadict/master/interrogate_badge.svg)](https://interrogate.readthedocs.io/)

## Installing DataDict

DataDict is available at [PyPI](https://pypi.org/project/datadict/). You can install it using Pip:

    $ python -m pip install datadict

## Using DataDict

You can use a DataDict `dataclass` as a drop-in replacement for `dataclasses.dataclass` in the standard library:

```python

from datadict import dataclass

@dataclass(order=True)

class Point:

    x: int

    y: int

```

For instances of the new data class, you can access attributes using square brackets, similar to dictionary access:

```python

>>> point = Point(1, 2)

>>> point

Point(x=1, y=2)

>>> point.x

1

>>> point["x"]

1

>>> point["y"] = 3

>>> point

Point(x=1, y=3)

```

You can also convert the dataclass instance to a proper dictionary:

```python

>>> point.asdict()

{'x': 1, 'y': 3}

```

## Installing From Source

You can always download the [latest version of DataDict from GitHub](https://github.com/gahjelle/datadict). DataDict uses [Flit](https://flit.pypa.io/) as a build tool.

To install DataDict from the downloaded source, run Flit through `pip`:

    $ python -m pip install .

If you want to change and play with the DataDict source code, you should install it in editable mode:

    $ python -m pip install -w .[dev,test]