# antibiotics
### NamedTuple / dataclasses <-> delimited text
> "The best treatment for acute episodes of PANDAS is to treat the strep
infection causing the symptoms, if it is still present, with antibiotics."
-- [National Institute of Mental Health](https://www.nimh.nih.gov/health/publications/pandas/index.shtml)
`antibiotics` is a minimalist type-driven serialization/deserialization library
inspired by [Serde](https://serde.rs/) and
[cassava](http://hackage.haskell.org/package/cassava).
It uses type annotations to automatically read and write `NamedTuple` or
`@dataclass` objects to or from delimited text files.
Out of the box, it only knows about Python scalar types and `typing.Union`s
of them (including `typing.Optional`), but an extension mechanism for
arbitrary type-directed serialization and deserialization is provided
through the `type_serde_ext` argument to the `Delimited` constructor - see
`examples/advanced.py`.
For `Union` types, serialization is driven by the runtime type,
and deserialization is attempted in the order of declaration of the
`Union` arguments - except that `NoneType` is tried first if present,
to preserve the expected behavior when deserializing null/missing values
of types whose deserializers do not throw when receiving `''` as an argument.
### Basic example
```python
from antibiotics import Delimited
from dataclasses import dataclass
from typing import NamedTuple, Optional
@dataclass
class SampleDC():
w: Optional[float]
x: int
y: bool
z: str
class SampleNT(NamedTuple):
w: Optional[float]
x: int
y: bool
z: str
if __name__ == '__main__':
dcs = list()
nts = list()
for i in range(10):
even = i % 2 == 0
dcs.append(SampleDC(
i * 3.5 if even else None,
i,
not even,
f'_",\t_{i}'
))
nts.append(SampleNT(
i * 3.5 if even else None,
i,
not even,
f'_",\t_{i}'
))
csv = Delimited()
with open('dcs.csv', 'w') as f:
csv.write(SampleDC, dcs, f)
tsv = Delimited(sep='\t', escape='\\')
with open('nts.tsv', 'w') as f:
tsv.write(SampleNT, dcs, f, header=False)
with open('dcs.csv', 'r') as f:
for r in csv.read(SampleDC, f):
print(r)
with open('nts.tsv', 'r') as f:
for r in tsv.read(SampleNT, f, header=False):
print(r)
```
View the full [pdoc3-generated API documentation](https://ghcdn.rawgit.org/derrickturk/antibiotics/master/doc/antibiotics/index.html).
Install with:
pip install --index-url https://test.pypi.org/simple/ antibiotics
Or download directly [from Test PyPI](https://test.pypi.org/project/antibiotics/0.1/).
#### (c) 2020 dwt | terminus data science, LLC
#### available under the Apache License 2.0
