Skip to main content

"dbus signature parser"

Project description

A parser for a dbus signature.

Introduction

This module contains a parser for dbus signatures constructed using the pyparsing library (http://pyparsing.wikispaces.com/).

The grammar follows the informal specifications at https://dbus.freedesktop.org/doc/dbus-specification.html. This grammar is a very simple one, parsable by an LL(1) parser.

The grammar has undergone significant testing using the Hypothesis testing library (http://hypothesis.works/).

Usage and Implementation Hints

Usage of the library to verify that a string is a signature is fairly straightforward:

>>> from dbus_signature_pyparsing import Parser
>>> parser = Parser()
>>> parser.PARSER.parseString("a(qy)", parseAll=True)

If parseString() does not raise a pyparsing exception, the argument string is a valid signature.

Note that the empty string is a valid signature. Thus, it is important to require that the parser parse the entire string by setting the parseAll parameter to True. If parseAll is False, which is the default, the parser can always parse the empty string, and every string will be parsed and verified to be a valid signature.

The Parser object exposes all its sub-parsers as instance attributes. The PARSER attribute is the top-level parser, suitable for parsing general signatures. The COMPLETE attribute parses what is defined in the informal specification as a “single complete type”. The CODE attribute is equivalent to the specification’s “type code”.

The parser is easily used either by delegation or by inheritance. Each sub-parser attribute is a ParserElement; consequently each sub-parser supports the addParseAction() method. To customize the basic parser to return a particular value as a result of having parsed a signature invoke the addParseAction() method on each appropriate sub-parser with an appropriately chosen method. The modified parser should then return the desired value when the parseString() method is invoked on a valid signature string. For further assistance, consult pyparsing’s extensive documentation at http://pyparsing.wikispaces.com/ and https://pythonhosted.org/pyparsing/.

Packaging

Downstream packagers, if incorporating testing into their packaging, are encouraged to use only the tests in the test_deterministic.py module, to avoid testing failures that may arise due to the non-deterministic behavior of Hypothesis tests.

Project details


Download files

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

Source Distribution

dbus-signature-pyparsing-0.4.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file dbus-signature-pyparsing-0.4.1.tar.gz.

File metadata

File hashes

Hashes for dbus-signature-pyparsing-0.4.1.tar.gz
Algorithm Hash digest
SHA256 52d52d4577d5704dc6c32ff83ae5e9618a6d2aa2446144c35cbeccc2a654de7c
MD5 e1c57026373d2de9b57c871697f5ab55
BLAKE2b-256 c3360b3b99b6c5fb7c6e1ea2f1ee40d49db199805ab3e9431ae6710f9e01470d

See more details on using hashes here.

File details

Details for the file dbus_signature_pyparsing-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for dbus_signature_pyparsing-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d2c7464ad55d918aa5c802988eb3e3bae9710aad127dca4dd53c3832108d2922
MD5 d903ca09817107d65cef397a85e1fde4
BLAKE2b-256 055eb06d6dc70c537a2d38b64b2e742c939e2fd0d4239b5ad10ed63fad2ad8b5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page