Robust & lightning fast MSD parser (StepMania file format)
Project description
msdparser
A robust & lightning fast MSD parser for Python. MSD is the underlying file format for the SM and SSC simfile formats used by StepMania, as well as a few older formats like DWI.
Full documentation can be found on Read the Docs.
Features
- Speed-optimized lexer & low-overhead parser
- Support for escape sequences by default
- Strict & lenient parse modes
Installation
msdparser
is available on PyPI:
pip install msdparser
Quickstart
parse_msd
takes a named file or string argument and yields MSDParameter
instances:
>>> msd_data = """
... #VERSION:0.83;
... #TITLE:Springtime;
... #SUBTITLE:;
... #ARTIST:Kommisar;
... """
>>> from msdparser import parse_msd
>>> for param in parse_msd(string=msd_data):
... print(
... "key=" + repr(param.key),
... "value=" + repr(param.value),
... )
...
key='VERSION' value='0.83'
key='TITLE' value='Springtime'
key='SUBTITLE' value=''
key='ARTIST' value='Kommisar'
MSDParameter
instances stringify back to MSD.
They can be created from a sequence of strings,
typically the key and value:
>>> from msdparser import MSDParameter
>>> pairs = [('TITLE', 'Springtime'), ('ARTIST', 'Kommisar')]
>>> for key, value in pairs:
... print(str(MSDParameter([key, value])))
...
#TITLE:Springtime;
#ARTIST:Kommisar;
Prefer to use MSDParameter
over interpolating the key/value pairs
between #:;
characters yourself.
The str()
implementation inserts escape sequences where required,
preventing generation of invalid MSD.
Developing
msdparser uses Pipenv for dependency management. Activate the environment:
pipenv shell
To run the unit tests:
py -m unittest
To build the documentation:
docs/make html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for msdparser-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbef8c89b2dc16183ba714354b093fff11a43469971c42972284c5046826002d |
|
MD5 | f9c3f15edc5782da723a60ee342b20ad |
|
BLAKE2b-256 | 4a784df3deda184b573055ac6ba4a7a8fa4084844d4f98b42550f3673550baff |