Skip to main content

Executable Class Model Parser

Parses an .xcm executable class model file into an abstract syntax tree for downstream Blueprint modules

Parses an *.xcm file (Executable Class Model) to yield an abstract syntax tree using python named tuples

Why you need this

You need to process an *.xcm file in preparation for populating a database or some other purpose

Installation

Create or use a python 3.11+ environment. Then

% pip install xcm-parser

At this point you can invoke the parser via the command line or from your python script.

From your python script

You need this import statement at a minimum:

from xcm_parser.class_model_parser import ClassModelParser

You can then specify a path as shown:

result = ClassModelParser.parse_file(file_input=path_to_file, debug=False)

In either case, result will be a Subsystem_a named tuple holding the parsed class model elements (subsystem, domain, classes, rels, and metadata). You may find the header of the class_model_visitor.py file helpful in interpreting these results.

From the command line

This is not the intended usage scenario, but may be helpful for testing or exploration. Since the parser may generate some diagnostic info you may want to create a fresh working directory and cd into it first. From there...

% xcm elevator.xcm

The .xcm extension is not necessary, but the file must contain xcm text. See this repository's wiki for more about the xcm language. The grammar is defined in the class_model.peg file. (if the link breaks after I do some update to the code, just browse through the code looking for the class_model.peg file, and let me know so I can fix it)

You can also specify a debug option like this:

% xcm elevator.xcm -D

This will create a diagnostics folder in your current working directory and deposit a couple of PDFs defining the parse of both the class model grammar: class_model.pdf and your supplied text: class_parse_tree.pdf.

You should also see a file named xcm_parser.log in your current working directory

Download files

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

Source Distribution

xcm_parser-0.3.8.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xcm_parser-0.3.8-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file xcm_parser-0.3.8.tar.gz.

File metadata

  • Download URL: xcm_parser-0.3.8.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for xcm_parser-0.3.8.tar.gz
Algorithm Hash digest
SHA256 2fef0e5d8106be11be11c8b18d2fcf83bc5508f3bcd83f4b12dcab7c05f217be
MD5 7f77fc2e78ae0850b8388ca21b8197c4
BLAKE2b-256 41f9bbcc4c60aaada62efff0c0f51515bdbbc7eb3ed817ecda018984cdf5b305

See more details on using hashes here.

File details

Details for the file xcm_parser-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: xcm_parser-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for xcm_parser-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a84915374b0b88b703cea465c1fbba7b6ac438a436164a371e800bf0fd69d685
MD5 ed5eddec3b5939b3c34459214b3e47af
BLAKE2b-256 ef4b73419b744765864164da848320059f5d91abeb09750af943a35982572c2d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.8 This release

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page