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 to synchronizes objects to the filesystem using type annotations. It supports a variety of file formats with round-trip preservation of formatting and comments, where possible. Object changes are automatically saved to disk and only include the minimum data needed to restore each object.

Travis CI AppVeyor Coveralls PyPI License PyPI Version Gitter

Popular use cases include:

  • Coercing user-editable files into the proper Python types
  • Storing program configuration and data in version control
  • Loading data fixtures for demonstration or testing purposes
  • Prototyping data models agnostic of persistence backends

Overview

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 decorate it with a directory pattern to synchronize instances:

from datafiles import datafile

@datafile("inventory/items/{self.name}.yml")
@dataclass
class InventoryItem:
    ...

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  # <= manually changed from "3.0"
quantity_on_hand: 100
>>> item.unit_price
2.5

Objects can also be restored from the filesystem:

>>> from datafiles import Missing
>>> item = InventoryItem("widget", Missing)
>>> item.unit_price
2.5
>>> item.quantity_on_hand
100

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

Documentation

To see additional synchronization and formatting options, please consult the full documentation.

Project details


Release history Release notifications | RSS feed

This version

0.6

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.6.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

datafiles-0.6-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file datafiles-0.6.tar.gz.

File metadata

  • Download URL: datafiles-0.6.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.7.2 Darwin/19.2.0

File hashes

Hashes for datafiles-0.6.tar.gz
Algorithm Hash digest
SHA256 16de6b56d6cfd5e9e29a52aaf63e65b1235274feab39a913bd1e98102bc97ea7
MD5 18eaf7c99771a02fb53581e3e33bd82b
BLAKE2b-256 f20413adc7a065ff0eb2714d06235c835c0011c9b0a94854627a0be44589d411

See more details on using hashes here.

File details

Details for the file datafiles-0.6-py3-none-any.whl.

File metadata

  • Download URL: datafiles-0.6-py3-none-any.whl
  • Upload date:
  • Size: 25.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.7.2 Darwin/19.2.0

File hashes

Hashes for datafiles-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ad8dcdb2fe42dbe27ebffbad9b83e3a199435dfd123b896ffa6b221c50de4891
MD5 be55a01b525d5a3fc8e01319b2322be7
BLAKE2b-256 b19ba199383355927b4b4c16427d25a88b31ef30b83512eb35b092af94719b3a

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