https://github.com/tmck-code/asv-python
Reader & Writer for "ASCII-Separated Value" file format
https://github.com/tmck-code/asv-python
Last synced: 2 months ago
JSON representation
Reader & Writer for "ASCII-Separated Value" file format
- Host: GitHub
- URL: https://github.com/tmck-code/asv-python
- Owner: tmck-code
- License: bsd-3-clause
- Created: 2021-08-17T12:47:05.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-17T02:01:34.000Z (about 3 years ago)
- Last Synced: 2025-02-05T20:59:52.258Z (4 months ago)
- Language: Python
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# asv-python
> *Reader & Writer for "ASCII-Separated Value" file format*
The CSV format has one main advantage over other plain-text serialisations: **the size** that it produces.
JSON/XML have advantages around typing, however in many cases this is not actually very useful. e.g. any single json field is not actually guaranteed to be the same type between successive records
This advantage is entirely wasted due to the lax specification around fields containing newlines, and other characters that need to be escaped. This results in a smorgasbord of different formats that any CSV parser must implement.
---
## ASCII Separated Values
> See https://en.wikipedia.org/wiki/Delimiter#ASCII_delimited_text
The ASCII format, since the beginning of time, has defined **characters that are reserved for unit (cell) and record (row) separation**
- `30 == "record separator"`, signals the end of a record or row
- `31 == "unit separator"`, Between fields of a record, or members of a row.
Using these mitigates every problem with value escaping that are encountered with the current format.
- When writing: No need to escape anything, or quote cells, and newlines are permitted
- When reading: Just detect the 2 characters, and split on them
---
## Example Usage
```python
from asv import asv
data = [
["id", "name", "value", "other"],
["123", "Tom", "xxx", ""],
["124", "Laura", "yyy", "some note here"],
]
with asv.ASVWriter("data.asv") as writer:
for row in data:
writer.write_row(row)
open('test/data.asv').read()
# 'id\x1fname\x1fvalue\x1fother\x1e\n123\x1fTom\x1fxxx\x1f\x1e\n124\x1fLaura\x1fyyy\x1fsome note here\x1e\n'
with asv.ASVReader('test/data.asv') as reader:
for row in data:
print(row)
# ['id', 'name', 'value', 'other']
# ['123', 'Tom', 'xxx', '']
# ['124', 'Laura', 'yyy', 'some note here']
```