Persists information contained in dataclasses.
Project description
This program can be used to make dataclasses persistent by adding store and load functionality. The dataclass is stored in .json format which is by default compressed inside of a .zip file.
- What makes dataclass-persistence special?
Support for numpy arrays
Support for nested dataclasses
Human readable storage format with small file size
Usage
Let your dataclass inherit from Persistent
.
Then the dataclass can be stored on disk using .store()
and loaded from disk using
.load()
.
In the example below, we create an instance of dataclass, which is stored to and loaded from disk.
from dataclass_persistence import Persistent
from dataclasses import dataclass
import numpy as np
@dataclass
class SomeData(Persistent):
parameter_a: str
array: np.ndarray
data = SomeData('my_string', np.array([0, 0]))
file = 'my_file'
data.store(file)
data_reconstructed = SomeData.load(file)
On disk the code above produces my_file.zip which contains my_file.json:
{
"parameter_a": "my_string",
"array": {"data": [0, 0], "dtype": "int32"}
}
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
Built Distribution
Hashes for dataclass-persistence-0.3.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6eb543d439a332c1b1451e34fec3c9812b2e02f118eb5ec0d335dea2c296f92 |
|
MD5 | e104992be532adf2e7569ea0778dd5c9 |
|
BLAKE2b-256 | e745a8e7dc205c7e9c035ddb5a2ba68744a989e3fa27960654b945378d88656a |
Hashes for dataclass_persistence-0.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2cdc6f5b3cc0099b9e3eea9fbd8fe70d974cb78d0871c9ff5ba0471e3b9c05f |
|
MD5 | ad7a409c6701c676b53a58bb5fb18214 |
|
BLAKE2b-256 | 53c6a56739b09bf6081c14c94527ba657d01f800c0613a7891121e7fce144dcc |