Skip to main content

File-based ORM for dataclasses.

Project description

Datafiles: A file-based ORM for dataclasses

Datafiles is a bidirectional serialization library for Python dataclasses that automatically synchronizes object instances to the filesystem using type annotations. It supports a variety of file formats with round-trip preservation of formatting and comments, where possible. By default, saves are automatic and include the minimum data needed to restore an object.

Travis CI AppVeyor Coveralls PyPI Version PyPI License

Usage

Take an existing dataclass such as this example from the documentation:

from dataclasses import dataclass

@dataclass
class InventoryItem:
    """Class for keeping track of an item in inventory."""

    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand

and replace the decorator, including a directory pattern to synchronize instances:

from datafiles import datafile

@datafile("inventory/items/{self.name}.yml")
class InventoryItem:
    """Class for keeping track of an item in inventory."""
    
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand

Then, work with instances of the class as normal:

>>> item = InventoryItem("widget", 3)
# inventory/items/widget.yml

unit_price: 3.0

Changes to the object are automatically saved to the filesystem:

>>> item.quantity_on_hand += 100
# inventory/items/widget.yml

unit_price: 3.0
quantity_on_hand: 100

Changes to the filesystem are automatically reflected in the object:

# inventory/items/widget.yml

unit_price: 2.5  # was 3.0
quantity_on_hand: 100
>>> item.unit_price
2.5

Demo: Jupyter Notebook

Installation

Because datafiles relies on dataclasses and type annotations, Python 3.7+ is required. Install this library directly into an activated virtual environment:

$ pip install datafiles

or add it to your Poetry project:

$ poetry add datafiles

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

datafiles-0.1a13.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

datafiles-0.1a13-py3-none-any.whl (51.8 kB view details)

Uploaded Python 3

File details

Details for the file datafiles-0.1a13.tar.gz.

File metadata

  • Download URL: datafiles-0.1a13.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.10 CPython/3.7.1 Darwin/18.2.0

File hashes

Hashes for datafiles-0.1a13.tar.gz
Algorithm Hash digest
SHA256 e124e4f26269d7976eebb6f3cc51c8722c410b595d61332c34cf62842f771078
MD5 d5b2628f30da4a519f6323a4aa2471bf
BLAKE2b-256 f836ff765c2f46a68c55aecb66d0b3c0763cfcf130a62b0cf45ac8ab1c5cb3e2

See more details on using hashes here.

File details

Details for the file datafiles-0.1a13-py3-none-any.whl.

File metadata

  • Download URL: datafiles-0.1a13-py3-none-any.whl
  • Upload date:
  • Size: 51.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.10 CPython/3.7.1 Darwin/18.2.0

File hashes

Hashes for datafiles-0.1a13-py3-none-any.whl
Algorithm Hash digest
SHA256 6052450f1e350a0c674d429016207f7d0797f296aff20258700d484d0959e1db
MD5 121dbebba6795c24b629de0921233697
BLAKE2b-256 722c6ecec9ae4f00fd301675ba98d3c3d71f87fe92b3ab317206530636269b5b

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