Skip to main content

TSVZ

tsvz.org: the format, its specification and its implementations.

TSVZ is a small, dependency-free library and CLI that keeps an ordered key-value store in a delimiter-separated text file. The first column of each row is the key; the file behaves like an ordered dictionary that is persisted to disk as you change it.

Version 5.1, Python 3.6+, one self-contained module (TSVZ.py): drop it next to your code and import TSVZ, or install it.

pip install tsvz          # from PyPI
pip install -e .          # editable, from this directory

Two file dialects, one API

Extension Rules
.tsv .csv .nsv .psv (and any other) The TSVZ 3.39 format, unchanged. A 3.39 host can read every file this version writes.
.tsvz .csvz .nsvz .psvz The tsvz-spec-v1 append-only key-value log.

The delimiter follows the extension: tab, comma, NUL, pipe. A trailing compression suffix (.gz, .bz2, .xz, .zst) is allowed on both; .zst needs Python 3.14. For important or sensitive data, keep the part you write to uncompressed and compress parts once they no longer change: a damaged compressed member can lose every record in it (spec §16.4.2).

TSVZed, TSVZedLite, readTabularFile, appendTabularFile, appendLinesTabularFile, clearTabularFile, scrubTabularFile (and the *TSV aliases) work on both dialects. t.dialect tells you which one a store uses.

Quick start

import TSVZ

t = TSVZ.TSVZed('people.tsvz', header='id\tname\tscore')
t['alice'] = ['alice', 'Alice', '10']
t['bob'] = 'bob\tBob\t20'
t['alice'] = ['alice', 'Alice', '11']   # last write wins
del t['bob']                            # appends a tombstone
print(t['alice'])                       # ['alice', 'Alice', '11']
t.close()
tsvz set people.tsvz carol Carol 5        # add or update a row (append is the same)
tsvz get people.tsvz carol                # one row; exit 3 if carol is missing
tsvz read people.tsvz                     # every row: a table on a terminal, records in a pipe
tsvz delete people.tsvz carol             # tombstone
tsvz read people.tsvz | tsvz set copy.tsvz -   # copy every row
tsvz clear people.tsvz                    # empty it, keeping the header and markers
tsvz scrub people.tsvz                    # compact it (for .tsvz: archival maintenance)
tsvz verify people.tsvz                   # check #_checksum_*_# segments; exit 4 on a mismatch
tsvz parts events.tsvz                    # list the parts of a multi-part store
tsvz has people.tsvz carol                # exit 0 if carol is live, 3 if not
tsvz pop people.tsvz carol                # print carol's row and delete it
tsvz serve people.tsvz &                  # keep the store loaded; tsvz commands then use it
tsvz stop people.tsvz
tsvz people.tsvz append carol Carol 5     # the 3.39 form still works
tsvz -V

What TSVZ does with .tsvz files

  • Reads everything a conformant writer can produce: markers (#_defaults_#, #_strip_trailing_whites_#, #_fill_empty_with_default_#, #_return_defaults_when_missing_#, ...), escapes (<sep>, <LF>, <lt>, <#>), tombstones, #_checksum_<algo>_# segments (crc32 and every fixed-length hashlib algorithm), compressed parts, and multi-part stores (store.tsvz.<hex>, part 0 first, .rotated parts skipped). A read starts at the last snapshot part (one that begins with #_snapshot_#, spec §19.10, and holds the store's whole state) and skips the history before it; verify and parts still read every part. A store whose parts change while they are read (another tool's in-place scrub) is read again, up to three times; a read still changing then is incomplete, as an unreadable part is.
  • Writes one file: the named file, or the highest-numbered part of a multi-part store. Rows are written as given (no padding); a lone key is a tombstone; a row of empty cells (k\t\t) is a live row.
  • Compaction is manual. scrubTabularFile / tsvz scrub f.tsvz rewrites a single-part store in place (same inode). If another writer commits while it runs, it reads the store again; after three tries it writes nothing, with a warning (clearTabularFile does the same). The automatic rewrite options of 3.39 (rewrite_on_load, rewrite_on_exit, rewrite_interval, rewrite(), mapToFile(), hardMapToFile()) are ignored for .tsvz, with a warning.
  • Missing keys: t[key] returns the defaults row while #_return_defaults_when_missing_# is true (its default); in, get, setdefault and pop behave like a dict.
  • # keys are stored (<#>key). Keys of the form #_name_# are marker writes: t['#_defaults_#'] = [...] sets the defaults, and so does setDefaults([...]) once the object is constructed. #_snapshot_# is refused (spec §19.10.2).
  • Other writers: a TSVZed notices another process's change by the active part's inode, size and times and by the list of parts, and reloads. Rows it has queued but not yet written stay in memory across that reload, and a live key is never missing while it runs.

Command line

tsvz follows tsvz-spec-v1 §20: tsvz [OPTION ...] OPERATION STORE [ARG ...], with options anywhere before a lone --. The 3.39 form tsvz STORE [OPERATION] [ARG ...] works too; a store named like an operation then needs a path prefix (./read).

  • One engine. Every operation runs through the engine tsvz serve uses, in its own process when no server runs, so a command prints the same with or without a server.
  • stdout carries only rows. It gets a table on a terminal and records otherwise; --format table|records overrides. Records use the store's delimiter and escaping, so tsvz read A | tsvz set B - copies a store of the same variant.
  • stderr carries every message. -q prints errors only; -v adds detail.
  • Exit status:
    • 0: done.
    • 1: failed or refused. Also a missing store for read, get, scrub, verify and parts, a store that set, append or delete could not create, and a .tsvz part that could not be read (the rows of the other parts are still printed).
    • 2: usage error.
    • 3: get found a missing key.
    • 4: verify found a checksum mismatch.
  • Arguments are literal. tsvz set s.tsvz k 'a<b' stores a<b. Values may begin with - (-5); after -- every argument is positional. set KEY alone deletes KEY, as in 3.39. set KEY '' stores an empty cell in a .tsvz store; in a .tsv file it deletes KEY, as in 3.39.
  • Bulk input. set STORE - and delete STORE - read records or keys from stdin and append them in one write. An unterminated last line is ignored, with a warning.
  • TSVZ extensions:
    • --x-header H and --x-defaults KEY<d>D1<d>... decode backslash escapes such as \t;
    • --x-strict / --x-force turn 3.39's column and header checks on or off.

Serving a store

tsvz serve STORE keeps a store loaded in one process and answers requests on a local socket (tsvz-spec-v1 §21). tsvz commands and TSVZ.TSVZClient find it through the pointer file STORE.serve and use it instead of re-reading the store. Their output and exit status stay the same.

  • One appender. The server batches the writes it receives into single appends. Other writers may still append to the files; the server reads what they add before it answers.
  • Acknowledgement. A write is acknowledged once it is queued (#_write_ack_# memory, the default), or after fsync (#_write_ack_# disk, or TSVZClient(..., sync=True)). Reads always see acknowledged writes.
  • Access. Only the user who started the server can connect (socket mode 0600). --x-group G or --x-mode 0660 opens it on purpose. The server listens on a Unix-domain socket only; reaching it from other hosts is left to a separate adapter (for example TCP with TLS) that would relay to the socket.
  • Trust. Clients use STORE.serve only when it is a regular file owned by them or by the store's owner, not writable by anyone else, naming a socket that belongs to that owner. Otherwise they warn and use the files. serve never writes through a symbolic link or into a file it did not create.
  • Lifetime. It runs in the foreground until tsvz stop STORE, SIGINT or SIGTERM, or --x-idle-timeout S seconds without connections. It then writes and fsyncs everything and removes STORE.serve.
  • Bypassing it. --x-direct makes a tsvz command use the files. Command lines with --x-header, --x-defaults or --x-strict, or another delimiter than the server's, use the files too.
import TSVZ

with TSVZ.TSVZClient('people.tsvz') as people:  # served, or in this process when no server runs
    people['dave'] = ['dave', 'Dave', '41']
    print(people['dave'], len(people), 'alice' in people)
    print(people.pop('dave'))

TSVZClient has TSVZed's semantics for reading and setting keys, del, in, len, iteration, pop, popitem, setdefault, update, clear and setDefaults. Its writes return once they are written (raising OSError if they cannot be), one client may be shared between threads, and without a server it warns once and works on the files in-process, finishing its writes when the program exits. A server of a .tsv-family file names its delimiter in STORE.serve, and TSVZClient splits string values on it.

Fault tolerance

TSVZ keeps your data and keeps going when a file is not what it expects, and says so on stderr (or through teeLogger) with one summarised line per problem:

TSVZ warning: data.tsvz: invalid UTF-8 replaced with U+FFFD (3 occurrences, first at line 17)

Examples: bytes after the last newline (ignored on read; truncated before the next append, and quoted), invalid UTF-8, a byte order mark, a newer #_version_#, a marker with a bad value, a checksum mismatch, a damaged compressed member or a zero-filled line (a member cut short by a crash keeps the whole lines it decoded; a corrupt member or a zero-filled line is recovered, skipped or stops the read, as the store's #_on_corruption_# says, recover by default, spec §4.9, §4.10, §16.6; a scrub that rewrites such a part keeps the original as <part>.damaged-<time>), an unreadable part, and a delimiter or encoding argument that conflicts with the extension.

Writing is stricter than reading: a key, value, header or marker that cannot be encoded as UTF-8, such as the lone surrogate os.fsdecode gives for a non-UTF-8 file name, raises a ValueError (TSVZEncodeError) that names it and writes nothing, instead of storing ?. Pass errors='replace' (or any codec error handler) to the writing functions or to TSVZed, TSVZedLite and TSVZClient to get the old ?. TSVZed and TSVZedLite refuse such a row when it is set. A rewrite that meets such text leaves the file as it is: mapToFile() and hardMapToFile() raise the error, and the rewrites TSVZed makes itself report it once. With a non-UTF-8 encoding=, U+FFFD (what the reader puts for a byte it could not decode) is text that encoding may lack, and it is refused like any other: such a store is not rewritten (rewrite_on_load leaves the file as it is, without failing), appends of rows that can be written still work, and the delete or update of a key that holds U+FFFD raises. Such a key stays until the file is edited, the store cleared, or the store opened with the encoding it was written in; errors='replace' would write ? for U+FFFD, losing the bytes the file holds there. The tsvz command exits 1 with the message.

A TSVZed writes a .tsv, .csv, .nsv or .psv file (compressed or not) from its background thread only: rewrite(), mapToFile(), hardMapToFile(), commitAppendToFile(), clear(), clear_file(), reload(), close() and the constructor's load hand it the job and wait, so a Ctrl-C stops the wait, never the write (the call still raises KeyboardInterrupt). At exit a write in progress is finished: a Ctrl-C then says so and keeps waiting, and a second one abandons it. A closed store is freed. (get_file_obj() and release_file_obj(), kept from 3.39, hand the locked file to the calling thread.) A file another process removed is made again from memory by the store's next write, an append included (a removal in the microseconds as a write starts is followed as a rotation instead); while that rewrite fails or is refused, the rows are appended to a new file there, and memory keeps all of them for the rewrite that gets through. A compressed file another writer left damaged is made again too (L5: every read stops at the damage, so rows appended after it would be read by no one); the bytes after the damage go. While that rewrite fails, the rows are appended after the damage and memory keeps them for the next rewrite that gets through; while it is refused (a row changed in place to text the encoding cannot hold), they are appended after it as in 4.9, and the next read drops them. Either way close() tries the rewrite once more, whatever rewrite_on_exit says. Appends that do not read the store first (tsvz set, appendTabularFile, TSVZedLite, and a TSVZed with monitor_external_changes=False for damage that lands after it loaded the file) still land after it, and so do a TSVZed's rows when a writer that takes no lock leaves the damage between the store's read and its append (docs/limitations.md).

It knows the size and SHA-256 of the bytes it last read or wrote. When another process has changed the file, and it is the same file (device and inode) and still begins with those bytes, nothing this store set is still waiting to be written, and setDefaults() has not changed its defaults since, only what follows is read and applied to memory, as a read of the file applies it: memory keeps an order set by move_to_end, and its # keys. Any other change reloads the file, changing memory in place, so a live key is never missing meanwhile.

A rewrite writes over the file and then cuts it to its new length, so a reader never meets it emptied. One that fails part way (a full disk, an I/O error), or that cannot make again a file that was removed, leaves the file damaged: the new bytes it wrote, then the old ones after them. Memory then holds the only good copy, as it does when the store appends after damage another writer left that it cannot make the file again over yet (that rewrite failed, or waits out a failed one's back-off). Until a rewrite gets through, the file is not reloaded over memory; the background writer still appends the rows set meanwhile, and the next rewrite (the background writer's, rewrite(), close()) makes the file again from memory. A change another process made meanwhile is merged into memory first, as above, when the file is still the one the damage was left in (for a file that was removed, any file made there since) and still begins with exactly the bytes it left; after a damage that left the file empty (or removed it), what follows must also begin with this store's header. Otherwise that change is overwritten, with the warning Overwriting external changes. What cannot be told from an append is merged as one: another process's rewrite of the same file in place that begins with exactly the bytes the damage left, and, for a store with no header (or verifyHeader=False), anything written to a file the damage left empty; the keys it sets or deletes then take its values, and the keys it left out keep memory's. An explicit reload() while the file is damaged replaces memory with the damaged file, as asked, and warns.

Upgrading to 5.1 from 5.0

The file formats are unchanged, and a 3.39 host still reads every .tsv-family file 5.1 writes. Most of the changes are in scrub and clear.

  • Scrub and clear of a .tsv write over the file. scrubTabularFile, clearTabularFile, tsvz scrub and tsvz clear (on the command line or through a tsvz serve handler), TSVZClient.clear() and TSVZedLite.clear_file() of a .tsv-family file write the new content over the file and then cut it, as TSVZed's rewrites do, so a reader that takes no lock never meets the file emptied. They take the file's lock, so they wait while another writer holds it. 5.0 emptied the file first, with no lock (TSVZedLite truncated its own descriptor).
  • A scrub keeps another process's rows. A scrub of a .tsv writes only if the file is still what its read saw. Otherwise it reads again, up to three times, and if the file kept changing it writes nothing and warns: tsvz scrub exits 1 (scrub refused; nothing was written), as for a .tsvz (C6), and a handler answers refused. scrubTabularFile still returns the rows it read. 5.0 wrote over a row appended after its read.
  • scrubTabularFile(lastLineOnly=True) is a read. It returns the last row and writes nothing, as for a .tsvz. 5.0 and 3.39 wrote that row back as deletion lines (id\tv\na\t\n3\t\n), and the store was gone.
  • A scrub keeps the file's #_defaults_# lines. The defaults in effect at the end of the read are written after the rows: the last non-empty defaults line, its empty cells filled from the line before it as a reader fills them. An empty defaults line that was read (it turns defaults off) is written before the rows, padded to their width. Every row reads as it did to a reader given the scrub's defaults and strict. Defaults a caller passes still fill the rows' empty cells, as in 5.0, but are not written as a defaults line, and the caller's list is not changed. 5.0 and 3.39 dropped the lines, so rows appended later got no defaults.
  • The header stays on line 1. A scrub given no header (tsvz scrub of a .tsv, scrubTabularFile(path)) and a TSVZed given none, of a file that has a header line, keep that line first, with a TSVZed's defaults line right after it. 5.0 and 3.39 put an empty line in front of it, so a reader given the header read the header as a row. A header-less file keeps the empty first line it begins with, and new files and clears given no header still get one, as in 5.0.
  • Interrupts. A scrub or clear of either dialect keeps a copy of only the bytes it overwrites, to put back if it is interrupted before the file is cut to its new length; once the cut is made the rewrite is done and the new content stays. 5.0 kept a copy of the whole .tsvz part and put it all back. (A scrub still reads the whole store, and a .tsvz clear reads it too, to keep its markers.)
  • A compressed store cleared to nothing is one empty stream. A .tsvz.gz (or .bz2, .xz, .zst) cleared or scrubbed to nothing holds one empty compressed stream, which bzcat, xzcat and Python's bz2 and lzma can read; 5.0 left 0 bytes.
  • A header-checking clear of an empty file writes the header it was given. A clear that checks the header (verifyHeader=True, tsvz clear --x-header H --x-strict) of a 0-byte .tsv, or of a compressed file with no byte or only empty streams (another tool's), takes it for an empty store with that header, as every reader does (L9), and writes H without a "Header mismatch" warning. 5.0 wrote an empty line and warned of a mismatch, so a strict TSVZed given H then refused the file, and raised on a 0-byte .bz2, .xz or .zst.
  • tsvz --help says what clear keeps: a .tsvz its header and markers, a .tsv the --x-header it is given. (With --x-strict too, a .tsv clear keeps the file's own header line.) TSVZed's message for a refused rewrite lists hardMapToFile() among the rewrites a program asks for.
  • Known: a scrub of a .tsv whose rows were all deleted does not compact it when the scrub is given the file's header (scrubTabularFile(path, header=H)) or the file has no header line: it leaves the file as it is, deletion lines included; reads are right, as in 3.39 and 5.0. (tsvz scrub of a headed file reads the header line as a row, so it does compact it.) (limitations).
  • Known: a scrub run with other defaults than the store's program can change how early rows read. In a .tsv with an empty #_defaults_# line and rows with empty cells before any defaults line, the reset line the scrub writes before the rows keeps those cells empty for a program that opens the store with its own defaults; run the scrub with the defaults that program uses (limitations).
  • Running programs keep 5.0 until they are restarted: long-running programs that import TSVZ, and running tsvz serve handlers.

Upgrading to 5.0 from 4.9

  • Writes refuse text they cannot encode. A key, value, header, defaults line or marker the file's encoding cannot hold (UTF-8 for .tsvz; encoding= for a .tsv), such as the lone surrogate os.fsdecode gives for a non-UTF-8 file name, raises TSVZEncodeError (a ValueError) and writes nothing; 4.9 stored ? (its tsvz stored U+FFFD for a non-UTF-8 argument, and its .tsvz file functions raised UnicodeEncodeError). errors='replace' brings ? back. Under a non-UTF-8 encoding=, a key read as U+FFFD cannot be deleted or updated. tsvz exits 1 with the message. See Fault tolerance.
  • A Ctrl-C no longer cuts a .tsv write. Every write of a .tsv-family file runs on the store's background thread; a call waits for it, a Ctrl-C raises in the caller and the write still finishes, and at exit a write in progress is finished (a second Ctrl-C abandons it). In 4.9 a Ctrl-C while TSVZed() opened a compressed store (its rewrite on load) could leave the file with no readable row. A closed TSVZed or TSVZedLite is freed; 4.9 kept every one until exit.
  • Another process's change is taken in, not reloaded over memory. An append to a .tsv-family file is read from where the store left off, so an order set by move_to_end and # keys survive it; any reload (both dialects) changes memory in place, so another thread never finds a live key missing. After a rewrite of the store's own fails part way, memory is kept and another process's appends are merged into it (Fault tolerance).
  • .tsvz stores see another process's append made right after their load, a commit or a clear (4.9 missed it until the next change), keep the rows set while they reload, and raise a strict header mismatch at the first read.
  • .tsv files: an append to an existing empty file writes the header first, and reading one gives an empty store; see L8 to L14 for the rest.
  • tsvz runs every operation through the engine tsvz serve uses, with the same output. A server of a .tsv (or other tab- or NUL-delimited) file is now found by tsvz commands, TSVZClient and tsvz stop; 4.9's clients rejected its pointer file. The 3.39 warning that a file name does not end in .tsv is printed only when a command creates such a file, and a write that cannot be made reports the operating system's error.
  • Running programs keep 4.9. Long-running programs that import TSVZ, and running tsvz serve handlers, keep 4.9 until they are restarted. 5.0's tsvz stop cannot stop a 4.9 handler of a .tsv (or other tab- or NUL-delimited) file: 4.9 wrote the delimiter into the pointer file's x-delimiter as <sep> (a NUL as <NUL>), which 5.0 decodes to the TAB or NUL itself and refuses as a control character. Send that handler SIGTERM instead: its pid is on the pid line of its pointer file (STORE.serve), and it finishes its writes and exits.
  • macOS and other systems that lock with lockf: as in 4.9, a read in another thread of the process can still drop a write's lock (docs/limitations.md).

Breaking changes from 3.39

.tsv, .csv, .nsv, .psv: the format is unchanged

# Change
L1 Appending after an unterminated last line writes \n first; 3.39 merged the two lines.
L2 Setting a row whose values are all empty deletes it in memory too (it already meant delete on disk), with a warning.
L3 TSVZedLite on a compressed file keeps rows in memory; 3.39 read compressed bytes as text. Rows held in memory (also # keys) are returned directly.
L4 New warnings on stderr (invalid encoding, lines dropped by strict); data unchanged.
L5 A damaged compressed file is read up to the damage instead of raising.
L6 mapToFile no longer glues a row it adds at the end of the file to the next one.
L7 TSVZed's in and get find a key as t[key] does: the live key equal to it, else the key right-stripped. 3.39 matched them exactly, so 'x ' in t was false while t['x '] read x, and t.setdefault('x ', …) overwrote x.
L8 Appending (TSVZed, TSVZedLite, appendTabularFile, appendLinesTabularFile) to an existing empty file (no byte, or a compressed file holding only empty streams) writes the store's header first, as creating the file does; 3.39 wrote the rows alone (a read then took the first one for the header), and appendTabularFile with strict refused the file.
L9 Reading such an empty file with a header (and verifyHeader) gives an empty store with that header: readTabularFile, TSVZed and TSVZedLite with strict no longer refuse it with Header mismatch (a TSVZed restarted after a rewrite that left the file empty failed in its constructor), and without strict no longer print a header mismatch.
L10 Writing text the file's encoding cannot hold (a lone surrogate from os.fsdecode, a character the encoding= lacks) raises TSVZEncodeError, a ValueError, and writes nothing; 3.39 and 4.9 wrote ?, which errors='replace' brings back.
L11 pop() and popitem() of a # key, which lives in memory only, write no tombstone line to the file.
L12 A rewrite of a file whose header line has no newline writes the rows on lines of their own; 3.39 wrote the first one onto the header line.
L13 A compressed file is rewritten in members of at most 1 MiB, as appends already were: the bytes differ, the rows read are the same, and 3.39 reads them.
L14 TSVZed opening a compressed file in a codec this Python lacks (zstd before Python 3.14) raises ImportError instead of reading the compressed bytes as text.
L15 scrubTabularFile, clearTabularFile, tsvz scrub, tsvz clear and TSVZedLite.clear_file() write the new content over the file and then cut it, under the file's lock; 3.39 emptied the file first, with no lock, so a reader could meet it empty.
L16 A scrub writes only if the file is still what its read saw: it reads again up to three times, then writes nothing, with a warning (tsvz scrub exits 1, C6); 3.39 wrote over rows appended after its read.
L17 scrubTabularFile(lastLineOnly=True) returns the last row and writes nothing; 3.39 wrote that row back as deletion lines, and the store was gone.
L18 A scrub keeps the file's #_defaults_# lines (an empty one before the rows, the defaults in effect after them), so every row reads as it did; 3.39 dropped them, so rows appended later got no defaults.
L19 A scrub given no header, and a TSVZed given none, keep a file's header line first; 3.39 put an empty line in front of it, and a reader given the header then read the header as a row.

.tsvz, .csvz, .nsvz, .psvz: now tsvz-spec-v1

# Change
S1 .csvz/.nsvz/.psvz use , \0 | (3.39: tab). A conflicting delimiter= or encoding= is overridden, with a warning.
S2 A file written by 3.39 under one of these names reads differently (header line becomes data, key\t\t deletes come back, </sep/> stays literal, an unterminated last line is dropped, single-column files read as empty, empty cells are not defaulted, NULs are not stripped). Rename such a file to .tsv.
S3 t[missing] returns the defaults row instead of raising KeyError (see above).
S4 # keys are stored; #_name_# keys are marker writes.
S5 Automatic rewrites are ignored with a warning; rewrite_on_load effectively defaults to False; move_to_end only reorders memory.
S6 Rows are never trimmed or dropped for their width; strict no longer drops rows; appendLinesTabularFile does not pad.
S7 The header is written as a # comment; a new file without a header is empty.
S8 An unterminated tail is ignored on read and truncated on append.
S9 clear keeps the active markers; scrub keeps the header comment and drops other comments, custom markers and checksums.
S10 Files named x.tsvz.<hex> beside x.tsvz are read as parts of the store.
S11 lastLineOnly reads forward (slower on large files).
S12 TSVZedLite.clear() and clear_file() raise OSError when the clear is refused (a part could not be read, the path names one part of a store, or the store kept changing). Memory is reloaded from the unchanged store first.
S13 Compressed parts are written in members of at most 1 MiB of records (#_member_size_#), Zstandard frames with a checksum; an append never reads or repairs the part.
S14 A zero byte in a value is written <NUL>, and a raw zero byte in a record is read as zero-fill damage (spec §4.9): under the default recover only the bytes after it are read. A value that 4.2 or 4.3 wrote with a raw zero byte therefore reads differently in 4.4. Such values are rare; before upgrading, grep -c -P '\x00' store.tsvz (any .tsvz, .csvz or .psvz part) finds them. Stop 4.2 and 4.3 handlers before upgrading: they read <NUL> as text, as they read <CR>.
S15 A lookup (t[key], in, get, del, pop, setdefault) takes the live key equal to the one given before the right-stripped one, so a key ending in whitespace (written while #_strip_trailing_whites_# was false) can be read and deleted by name (spec §20.2.7). Setting a key still right-strips it.

The tsvz command

3.39 command lines still parse, including abbreviated long options (--delim) and -d=,, except the ones C5 and C9 list.

# Change
C1 read into a pipe or a file prints records instead of the table; --format table gives the table.
C2 Every message goes to stderr: "Created …", "File not found", header mismatches, warnings.
C3 read and scrub of a missing store exit 1 with a message (3.39: exit 0, and read printed "File not found" on stdout).
C4 delete deletes every KEY it is given (3.39: only the first).
C5 append or delete without a KEY, or with an empty KEY, is a usage error with exit 2 (3.39 wrote an empty line).
C6 A clear or scrub that writes nothing (one part of a multi-part store, a store that kept changing, a part that declares a spec version newer than 1, per spec §19.4 and §19.8) exits 1.
C7 -c/--header, --defaults, -s/--strict and -f/--force are undocumented aliases of the --x- options. --x-header and --x-defaults keep non-ASCII text.
C8 Usage errors print tsvz's own message, exit 2; the -h text is new.
C9 Arguments after STORE for read, clear and scrub are a usage error, exit 2 (3.39 ignored them, so clear junk cleared the file).
C10 The table (a terminal, or --format table) of get, keys, pop, popitem, setdefault, and of read on a .tsvz-family store, shows the rows only: no row is drawn as a header, and no row is cut to the first row's or the terminal's width. read of a .tsv-family file keeps 3.39's table, whose first row is the file's header line.
C11 The table shows control characters, bidi controls and line separators as escapes (\r, \n, \t, \xNN, \uNNNN), so no value can move the cursor, reorder the line or restyle the terminal. It sizes columns in terminal columns, so CJK text (two columns a character) lines up. The table is for reading: a backslash in a value is shown as is, so use records for exact values.
C12 While stripping is on, get, has, pop, delete and setdefault take the live key equal to a KEY ending in a space or tab before the stripped one (spec §20.2.7), so tsvz keys s | tsvz delete s - deletes every key. delete of such a KEY reads the store first, and exits 1 without writing when the store cannot be read whole.

Spec deviations and interpretations

None of these fails a conformance case: conformance/reference-baseline.json, which lists the cases this implementation does not pass, is empty (see Conformance testing).

  • §17.5: a numbered part opened directly is read alone, with a warning.
  • §14.5: the defaults-on-missing read applies to t[key] only.
  • §18.6: locking is one exclusive whole-file lock per write plus an in-process lock; readers do not lock. On Linux it is an open file description lock, which still excludes 3.39's lockf; elsewhere (macOS and other systems, or a Linux file system that refuses those locks) it is lockf, which closing any descriptor of the file in the process drops: there a read in another thread of the same process, such as a handler's or a TSVZed's, can drop a write's lock while it is held. A known limitation, deferred: see docs/limitations.md.
  • §19.4: a scrub whose rows would read differently under the final markers writes them with stripping and fill-empty off, then restores the final markers after the rows.
  • §20.7: -q also silences informational messages ("Created …"); only errors remain.
  • §20.2: scrub of a multi-part store, and clear of one part of one, are refused with exit 1; read, get and parts of a numbered part read that part alone, with a warning.
  • §20.2.4: on .tsv-family files get prints nothing for a missing key, verify checks nothing, and parts lists the file.
  • §20.3: a bulk input line with an empty key is skipped, with a warning.
  • §20.6: a write whose store cannot be created, and a read, get or verify that cannot read every part, or whose parts kept changing through three reads, exit 1 with an error that -q keeps.
  • §21: a served .tsv file with a header line shows that line as a row, as tsvz read does (TSVZed hides it when given the header).
  • §21.8: the server notices changes with stat(). It re-reads the part list while the store's directory changed less than 2 s ago, and reloads a part whose size stayed the same but whose inode, modification time or change time changed. The change time catches a rewrite whose modification time was set back (cp -p, rsync --inplace -a); a rewrite in place that keeps a part's size within one clock tick is not seen until the part changes again.
  • §21.9: tsvz commands and TSVZClient ask the server to answer writes once they are written (--x-written), so a write the server cannot make fails as it would on the files. While writes fail, every answer carries a warning.
  • §21.3: tsvz serve needs Unix-domain sockets. Where Python has none (Windows), it exits 1, and tsvz commands and TSVZClient work on the files.
  • §20.7: on .tsv-family files a -d longer than one character is used, as in 3.39, with a warning; a -d that does not decode is a usage error.

Website

The tsvz.org site lives in tsvz-org/tsvz.org. It renders tsvz-spec-v1.md from a checkout of this repository next to its own, and its tests also check the spec: every § reference names a real section, and the spec uses only markdown the site renders. Run them after editing the spec (see Tests); CI runs them on every push here, and the site publishes main's spec each morning.

Conformance testing

tsvzconform.py tests how closely an implementation of tsvz-spec-v1, in any language, follows the spec. Its cases are JSON files in conformance/cases/, each naming the § clauses it tests, and it drives an implementation only through the spec's command line (§20) and handler socket (§21).

python3 tsvzconform.py --impl ./tsvz --feature crc32,sha256,handler
python3 tsvzconform.py --impl ./tsvz --class reader --only 13

Each failure is printed with its input, what was expected, what came back and a command line that reruns it alone; the summary gives a verdict for each conformance class (reader, writer, cli, handler). conformance/README.md explains the options and the features to claim, and how to load the cases into another language's tests.

Benchmarking implementations

tsvzbench.py compares implementations of tsvz-spec-v1, in any language, side by side on one machine. It drives each one only through the spec's command line (§20) and, when it has one, its handler socket (§21), so any conformant tsvz tool can be measured as it is.

python3 tsvzbench.py --impl ref='python3 TSVZ.py' --impl new='../tsvz-rs/target/release/tsvz' \
                     --suite quick --work-dir /mnt/fast-disk/tsvzbench
  • --impl NAME=COMMAND, repeatable: the first is the baseline, and every other implementation gets a × ratio against it (below 1 is faster). A relative COMMAND runs from the directory you start tsvzbench in.
  • --suite smoke|quick|standard|large: smoke checks a setup in seconds, quick takes about a minute, standard (the default, up to 1M rows) about five, and large (up to 10M rows) twenty or more and ~5 GB of memory for the harness itself.
  • --only cold,bulk,perop,maint picks families: one-shot replays, set - and delete - batches, single operations (CLI and handler), and scrub/clear.
  • --work-dir DIR keeps the generated fixtures between runs. Put it on the disk you mean to measure: not a tmpfs, and not a FUSE file system such as mergerfs (the harness warns about those). The default is a tsvzbench-* directory here.
  • --json PATH also writes every raw sample.

The harness writes its own input stores, so every implementation reads the same bytes, and checks every result against its own replay model: ✓ right, ✗ wrong output or files, ! N an unexpected exit status, ⏱ timed out, refused an allowed refusal. It exits 1 when any cell failed. Each command runs under a small launcher that measures it with wait4; a peak RSS shown as ≤8.0 MiB is the launcher's own size, so the true peak is no higher. Compare an implementation with itself to see the noise: a few percent per cell, but the socket rows, whose latencies are tens of microseconds, can move 10–20% between runs, because a single run can land in a slower mode as a whole.

Tests

python3 -m pytest TSVZ_test.py -q                         # everything, incl. 3.39 differential tests
python3 -m pytest ../tsvz.org/tsvz_site_test.py -q        # the spec as tsvz.org renders it (needs the tsvz.org checkout next to this one)
python3 -m pytest tsvzbench_test.py -q                    # the benchmark harness
python3 -m pytest tsvzconform_test.py -q                  # the conformance runner and cases, against the reference
python3 benchTSVZ.py /tmp/b.tsv -n 100000 --compare-old    # benchmark (not a test)

TSVZ_old.py is the frozen 3.39 module the differential tests compare against; it is not installed. CI (.github/workflows/test.yml) runs the three test files on Python 3.6, 3.9, 3.12 and 3.14. Accepted limitations are listed in docs/limitations.md.

License

GPL-3.0-or-later © Yufei Pan (pan@zopyr.us)

Metadata

Release files for TSVZ 5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for TSVZ 5.1
File Size Uploaded Provenance Actions
tsvz-5.1.tar.gz 166.4 kB Without provenance Details for tsvz-5.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for TSVZ 5.1
File Interpreter ABI Platform Actions
tsvz-5.1-py3-none-any.whl Python 3 none any Details for tsvz-5.1-py3-none-any.whl

Total release size: 305.6 kB

Release files / tsvz-5.1.tar.gz

Download URL tsvz-5.1.tar.gz
Size 166.4 kB
Tags Source
SHA-256 checksum
How to use checksums
43d2b03dd90f12035c92141aca521109bbe2ede8b7ff5cd2003fd62f6ca44536
BLAKE2b-256 checksum
How to use checksums
0f73c7ecf5a0e4f2e932692bf79281edaffec8d841237ea8d2a34162af79aba9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / tsvz-5.1-py3-none-any.whl

Download URL tsvz-5.1-py3-none-any.whl
Size 139.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
10e590f6c6261d2c350daa0f329653a03700c18a0afeef60ef4e4d1412f396c0
BLAKE2b-256 checksum
How to use checksums
630f6e2961d4d4424c502c875f6d0c5916ba757ae45670468524f80c38b89283
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for TSVZ 5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page