typeline

Write dataclasses to delimited text formats and read them back again.

Headers are matched to fields by name, values are typed by msgspec, and custom formats, comments, extra columns, and compressed files are supported.

Installation

The package can be installed with pip:

pip install typeline

Quickstart

Defining a Record

>>> from dataclasses import dataclass
>>>
>>> @dataclass
... class MyData:
...     field1: int
...     field2: str
...     field3: float | None

Writing

>>> from pathlib import Path
>>> from tempfile import NamedTemporaryFile
>>> from typeline import TsvWriter
>>>
>>> temp_file = NamedTemporaryFile(mode="w+t", suffix=".tsv")
>>>
>>> with TsvWriter.from_path[MyData](temp_file.name) as writer:
...     writer.write_header()
...     writer.write(MyData(10, "test1", 0.2))
...     writer.write(MyData(20, "test2", None))

Reading

>>> from typeline import TsvReader
>>>
>>> with TsvReader.from_path[MyData](temp_file.name) as reader:
...     for record in reader:
...         print(record)
MyData(field1=10, field2='test1', field3=0.2)
MyData(field1=20, field2='test2', field3=None)

A reader expects a header by default, and matches its columns to fields by name, in any order. Pass header=False to read columns in field order. A reader from from_path closes its file once it is read to the end, so reading everything into a list needs no with block.

>>> records = list(TsvReader.from_path[MyData](temp_file.name))

Any Text Stream

To use an open text stream instead of a path, subscript the reader or writer class itself.

Leaving the with block closes the stream.

>>> from io import StringIO
>>>
>>> with TsvReader[MyData](StringIO("10\ttest1\t0.2\n"), header=False) as reader:
...     print(list(reader))
[MyData(field1=10, field2='test1', field3=0.2)]

Files

from_path reads and writes UTF-8, skips a byte order mark, and ends lines with os.linesep. It reads gzip, bzip2, and xz files, which it recognizes by their contents, and writes them when the path ends in .gz, .bz2, or .xz.

>>> with TsvWriter.from_path[MyData](f"{temp_file.name}.gz") as writer:
...     writer.write(MyData(10, "test1", 0.2))
>>>
>>> with TsvReader.from_path[MyData](f"{temp_file.name}.gz", header=False) as reader:
...     print(list(reader))
[MyData(field1=10, field2='test1', field3=0.2)]

Missing Values

None is written as the none_field, an empty field by default. When read, an empty field is None if the field allows None, and "" if it is a str. Set none_field, e.g. to "NA", when an optional text field must tell "" and None apart. A codec's missing text, as typeline.codecs.nullable sets, takes the place of none_field for its fields.

Comments

A reader skips lines that start with any of its comment_prefixes, and hands each one to on_comment as a Comment with its line number. A writer writes comments with write_comment, so comments can be passed straight from a reader to a writer and keep their places. Readers and writers take lines starting with # as comments by default.

>>> _ = Path(temp_file.name).write_text("# made by a tool\nfield1\tfield2\tfield3\n10\ttest1\t0.2\n")
>>>
>>> with (
...     TsvWriter.from_path[MyData](f"{temp_file.name}.copy") as writer,
...     TsvReader.from_path[MyData](temp_file.name, on_comment=writer.write_comment) as reader,
... ):
...     writer.write_header()
...     for record in reader:
...         writer.write(record)
>>>
>>> print(Path(f"{temp_file.name}.copy").read_text(), end="")
# made by a tool
field1	field2	field3
10	test1	0.2

Extra Columns

A record can end with an ExtraColumns field, which holds as text the columns no other field takes, in file order. Readers fill it, writers write it back, and a header only needs to name the other fields.

>>> from typeline import ExtraColumns
>>>
>>> @dataclass
... class Region:
...     name: str
...     start: int
...     extra: ExtraColumns = ()
>>>
>>> _ = Path(temp_file.name).write_text("exon1\t10\n\nexon2\t20\t0.9\tHIGH\n")
>>>
>>> with TsvReader.from_path[Region](temp_file.name, header=False) as reader:
...     print(list(reader))
[Region(name='exon1', start=10, extra=()), Region(name='exon2', start=20, extra=('0.9', 'HIGH'))]

Counter Columns

A CounterColumns[E] field is a Counter[E] held in one column per member of the enum E, each named after its member's value, which must be text. A record may have several such fields, as long as no two columns share a name. Writers write every member's count in enum order, where the field sits among the other fields. Readers find the member columns by name in a header, wherever they sit, or in enum order at the field's place when there is no header. Every member needs a column, and every count must be a non-negative integer.

>>> from collections import Counter
>>> from enum import StrEnum
>>> from typeline import CounterColumns
>>>
>>> class Base(StrEnum):
...     A = "A"
...     C = "C"
...     G = "G"
...     T = "T"
>>>
>>> @dataclass
... class Pileup:
...     position: int
...     counts: CounterColumns[Base]
>>>
>>> with TsvWriter.from_path[Pileup](temp_file.name) as writer:
...     writer.write_header()
...     writer.write(Pileup(100, Counter({Base.A: 12, Base.G: 3})))
>>>
>>> print(Path(temp_file.name).read_text(), end="")
position	A	C	G	T
100	12	0	3	0
>>>
>>> _ = Path(temp_file.name).write_text("position\tT\tG\tC\tA\n101\t2\t0\t0\t9\n")
>>>
>>> with TsvReader.from_path[Pileup](temp_file.name) as reader:
...     print(list(reader))
[Pileup(position=101, counts=Counter({<Base.A: 'A'>: 9, <Base.T: 'T'>: 2, <Base.C: 'C'>: 0, <Base.G: 'G'>: 0}))]

With an ExtraColumns field, the columns that are neither fields nor member columns are kept as extra columns.

Turning Off Quoting

Readers and writers quote fields with " as CSV does, so text can hold the delimiter and line breaks. For formats without quoting, quoting=False reads and writes " as ordinary text. Without quoting, a writer refuses text that holds the delimiter or a line break with a ValueError.

>>> with TsvWriter.from_path[Region](temp_file.name, quoting=False) as writer:
...     writer.write(Region('"exon1', 10, ('say "hi"',)))
>>>
>>> print(Path(temp_file.name).read_text(), end="")
"exon1	10	say "hi"
>>>
>>> with TsvReader.from_path[Region](temp_file.name, header=False, quoting=False) as reader:
...     print(list(reader))
[Region(name='"exon1', start=10, extra=('say "hi"',))]

Custom Field Formats

Lists, tuples, sets, dicts, and nested dataclasses are written as JSON by default, and dates, enums, and the like as their usual text. For any other text format, a FieldCodec reads a field from its text and writes it back, chosen by the field's type. Helpers in typeline.codecs cover common formats.

>>> from datetime import date
>>> from typeline import Codecs
>>> from typeline.codecs import boolean, delimited
>>>
>>> @dataclass
... class Visit:
...     patient: str
...     seen: date
...     consented: bool
...     blocks: list[int]
>>>
>>> codecs: Codecs = {
...     bool: boolean(true="Y", false="N"),
...     list[int]: delimited(int, sep=";"),
... }
>>>
>>> with TsvWriter.from_path[Visit](temp_file.name, codecs=codecs) as writer:
...     writer.write(Visit("P-001", date(2026, 9, 29), True, [3, 1, 4]))
>>>
>>> print(Path(temp_file.name).read_text(), end="")
P-001	2026-09-29	Y	3;1;4
>>>
>>> with TsvReader.from_path[Visit](temp_file.name, header=False, codecs=codecs) as reader:
...     print(list(reader))
[Visit(patient='P-001', seen=datetime.date(2026, 9, 29), consented=True, blocks=[3, 1, 4])]

Custom types nested anywhere inside a field, like a list[Interval], are handled by enc_hook, which turns such an object into builtin values, and dec_hook, which builds it back from them. Each hook raises NotImplementedError for types it does not handle.

>>> class Interval:
...     def __init__(self, start: int, end: int) -> None:
...         self.start = start
...         self.end = end
...
...     def __repr__(self) -> str:
...         return f"Interval({self.start}, {self.end})"
>>>
>>> def enc_hook(obj: object) -> object:
...     if isinstance(obj, Interval):
...         return [obj.start, obj.end]
...     raise NotImplementedError
>>>
>>> def dec_hook(kind: type, obj: object) -> object:
...     if kind is Interval:
...         return Interval(*obj)
...     raise NotImplementedError
>>>
>>> @dataclass
... class Target:
...     gene: str
...     intervals: list[Interval]
>>>
>>> with TsvWriter.from_path[Target](temp_file.name, enc_hook=enc_hook) as writer:
...     writer.write(Target("BRCA1", [Interval(1, 9), Interval(20, 25)]))
>>>
>>> print(Path(temp_file.name).read_text(), end="")
BRCA1	[[1,9],[20,25]]
>>>
>>> with TsvReader.from_path[Target](temp_file.name, header=False, dec_hook=dec_hook) as reader:
...     print(list(reader))
[Target(gene='BRCA1', intervals=[Interval(1, 9), Interval(20, 25)])]

Your Own Format

Subclass a reader to give a format its own defaults.

>>> from typing import TextIO
>>> from typing_extensions import Unpack
>>> from typeline import ReaderOptions, RecordType
>>> from typeline.codecs import key_value
>>>
>>> class VcfLikeReader(TsvReader[RecordType]):
...     def __init__(self, handle: TextIO, /, **options: Unpack[ReaderOptions]) -> None:
...         defaults: ReaderOptions = {
...             "header": False,
...             "none_field": ".",
...             "codecs": {dict[str, str]: key_value()},
...         }
...         super().__init__(handle, **(defaults | options))
>>>
>>> @dataclass
... class Site:
...     chrom: str
...     pos: int
...     ident: str | None
...     info: dict[str, str]
>>>
>>> _ = Path(temp_file.name).write_text("#CHROM\tPOS\tID\tINFO\nchr1\t100\t.\tDP=10;AF=0.5\n")
>>>
>>> with VcfLikeReader.from_path[Site](temp_file.name) as reader:
...     print(list(reader))
[Site(chrom='chr1', pos=100, ident=None, info={'DP': '10', 'AF': '0.5'})]

Type checkers see VcfLikeReader.from_path[Site](...) as a TsvReader[Site], its closest built-in reader.

A reader fixed to one record type can add FixedRecordType to its bases, and is then built without a subscript.

>>> from typeline import FixedRecordType
>>>
>>> class SiteReader(VcfLikeReader[Site], FixedRecordType):
...     pass
>>>
>>> with SiteReader.from_path(temp_file.name) as reader:
...     print(list(reader))
[Site(chrom='chr1', pos=100, ident=None, info={'DP': '10', 'AF': '0.5'})]

More examples, from sample sheets to GFF3 and colored genomic features, are in tests/test_real_world_examples.py.

Development and Testing

See the contributing guide for more information.