Modelica builder enables parsing and modification of Modelica files
Project description
Note: this project is still in flux and the name/methods/namespaces may change
The Modelica Builder project aims to make in-place modifcations to Modelica language files easier. The principal use case is to load, modify using higher level abstracted methods, and then save the resulting file. The user has access to the entire Abstract Syntax Tree of the entire Modelica grammar.
The Modelica Builder project does not:
Compile nor check for syntax validity
Install
pip install modelica-builder
Usage
ModBuild provides specific methods for reading and modifying files.
from modelica_builder.model import Model
# parse the model file
source_file = 'DCMotor.mo'
model = Model(source_file)
# do read and modify the model
# refer to modelica_builder.model.Model class methods to see what's available
name = model.get_name()
model.set_name('New' + name)
model.add_connect('some.component.port_a', 'another.component.port_b')
model.insert_component('MyComponentType', 'myInst',
modifications={'arg1': '1234'}, string_comment='my comment',
annotations=['my annotation'], insert_index=0)
# save the result
model.save_as('NewDCMotor.mo')
You can also define your own classes for editing the file
from modelica_builder.edit import Edit
from modelica_builder.selector import Selector
from modelica_builder.transformation import SimpleTransformation
class MySelector(Selector):
# implement class for selecting AST nodes
# define the edit to make to the node's text and combine it with the selector
edit = Edit.make_replace('FOOBAR')
selector = MySelector()
transformation = SimpleTransformation(selector, edit)
model = Model('my_modelica_file.mo')
# add your custom transformation
model.add(transformation)
model.save_as('result.mo')
Transformations specify what nodes to change and how to change them. This is done by combining Selectors and Edits. Selectors specify how to select nodes in the AST, and edits are modifications (insert, replace, delete) to the text of selected nodes.
A Transformer is a collection of Transformations, which can then be applied to a file.
See the tests for more examples and information.
Development
# install after cloning repo
pip install -r requirements.txt
If you change the source grammar file you need to regenerate the parser and lexer.
With docker installed, run these commands from this the repo’s root directory
# build Antlr container
docker build -t antlr4:latest -f antlr/Dockerfile .
# run parser generator for python
docker run -v "$(pwd)/modelica_builder/modelica_parser":/var/antlrResult \
antlr4:latest \
-Dlanguage=Python3 /var/antlrResult/modelica.g4
# commit results along with grammar file
If not using Docker, Install antlr4 following these instructions
# in modelica_building/modelica_parser
antlr4 -Dlanguage=Python3 modelica.g4
# commit results along with grammar file
Managed Tasks
Updating Licenses
To apply the copyright/license to all the files, run the following managed task. To update, then update the script, and then rerun the managed task.
./setup.py update_licenses
Testing
To run the tests, simply run the following:
py.test
Known Issues
The transformations occur on strings which are immutable. Need to investigate using byte arrays. This does not cause errors, but can be slow when parsing really large modelica files.
Release Instructions
Bump version to <NEW_VERSION> in setup.cfg (use semantic versioning as much as possible).
Run autopep8 to nicely format the code (or run pre-commit –all-files).
Create a PR against develop into main.
Run git tag <NEW_VERSION>. (Note that python setup.py –version pulls from the latest tag`.)
After main branch passes, then merge and checkout the main branch. Build the distribution using the following code:
# Remove old dist packages
rm -rf dist/*
python setup.py sdist
Verify that the files in the dist/* folder have the correct version (no dirty, no sha)
pip install twine
twine check dist/*
Run the following to release
twine upload dist/*
Push the tag to GitHub after everything is published to PyPi, then go to GitHub and add in the CHANGELOG.rst notes into the tagged release and officially release.
git push origin <NEW_VERSION>
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
Hashes for modelica-builder-0.2.3rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4331d52ee13b8d2497a2208641ff3fc49b669d6f2bccfccb4bb45fab0247b928 |
|
MD5 | f6f520d7a0e98c6512e9f1569688af32 |
|
BLAKE2b-256 | 77c1d85ee39a6d56c652d3186f2a999bb46e93a9babc2a6422d7eee6ac619581 |