File-based ORM for dataclasses.
Project description
Datafiles: A file-based ORM for dataclasses
Datafiles is a bidirectional serialization library for Python dataclasses to synchronize 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.
Some common 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
- Synchronizing application state using file sharing services
- Prototyping data models agnostic of persistence backends
Watch my lightning talk for a demo of this in action!
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")
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
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.
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
Built Distribution
File details
Details for the file datafiles-1.0.tar.gz.
File metadata
- Download URL: datafiles-1.0.tar.gz
- Upload date:
- Size: 23.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.9.2 Darwin/20.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f43b04bb5b76e8e5d9a2c9a9e83d2babba4e5e0ba9d2e50204557455d29ca727 |
|
| MD5 | a60dab587636a2d7aff0a43fb37e5251 |
|
| BLAKE2b-256 | 5dc27c9aae0da11d87bb430bd15bba5073064d15f0a4e0ba832c896a17f2e4a6 |
File details
Details for the file datafiles-1.0-py3-none-any.whl.
File metadata
- Download URL: datafiles-1.0-py3-none-any.whl
- Upload date:
- Size: 29.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.9.2 Darwin/20.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e51fe4f2cc88a702f17a5919ba4104dd3bf83d0cec825bd6ac49c24ecc84ceb |
|
| MD5 | 87e2467b12d13b669a84bb4604f36e44 |
|
| BLAKE2b-256 | 7530d259df86fc95519184045019608f40097f094d8df6f5c57e5681677c5fa7 |
