Skip to main content

The shitty ".qs" file (de-)serializer

Project description

qsck

Python library for serializing and deserializing a wonky format referred to as ".qs" files. For full format specification, please read through tests.test_serialize and tests.test_deserialize test suites and extrapolate.

Quick Start

Use Python ≥ 3.6 only. To install it, simply:

pip3 install qsck

Serializing Data

Via Python:

python3 -c "import qsck; print(qsck.serialize('LOG', '1553302923', [
    ('first_key', 'some value'),
    ('2nd_key', [('attr1', 'foo'), ('attr2', 'bar')]),
    ('3rd_key', {'subKey1': '-3', 'subKey2': None}),
    ('4th_key', None)
]))"

Out comes a ".qs" record, like so:

LOG,1553302923,first_key=some value,2nd_key={attr1=foo, attr2=bar},3rd_key={"subKey1":"-3","subKey2":null},4th_key=(null)

The library also supports serializing data by passing in a JSON file via the command-line tool qs-format, one record per line:

qs-format my-records.json > my-records.qs

Deserializing Data

Via Python:

python3 -c "import pprint, qsck; pprint.pprint(qsck.deserialize(
    'LOG,1553302923,first_key=some value,2nd_key={attr1=foo, \
    attr2=bar},3rd_key={\"subKey1\":\"-3\",\"subKey2\":null},4th_key=(null)'))"

Out comes a friendly Python collection:

('LOG',
 '1553302923',
 [('first_key', 'some value'),
  ('2nd_key', [('attr1', 'foo'), ('attr2', 'bar')]),
  ('3rd_key', {'subKey1': '-3', 'subKey2': None}),
  ('4th_key', None)])

The library-provided qs-parse command-line tool supports deserializing a whole ".qs" log file, emitting one JSON record per input line to stdout:

qs-parse my-records.qs > my-records.json 

Contributing

Really? Very welcome. Do the usual fork-and-submit-PR thingy.

Running the tests:

python setup.py test

Distributing:

pip3 install --upgrade twine wheel setuptools
python setup.py sdist bdist_wheel
twine upload dist/*

Changelog

0.3 - Better Deserialization

  • Adds support for funky "nested-nested lists" in .qs records
  • Squashing complex comma (,) values

0.2 – Deserialize Added

Adds support for de-serializing ".qs" records.

0.1 – Initial Release

Supports serializing ".qs" records.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qsck, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size qsck-0.3-py3-none-any.whl (8.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size qsck-0.3.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page