Project description

pyecoregen is a code generator, producing Python classes from Ecore models. It can be used at the
command line as well as a module. In the latter case the passed model is expected to be an instance
of the pyecore metamodel.

After using pyecoregen, you have a Python package representing the classes from the Ecore model. The
generated classes are instances of the pyecore metaclasses. Please see pyecore for documentation how to work with them.

If you need to generate code from an in-memory representation of a pyecore model, you instantiate
the EcoreGenerator class and call the generate method. Assuming you have loaded above model and
hold it’s root package in library_pkg, you would generate with:

The end user can control some of the features how the metamodel code is generated. This can be done
at the command line as well as via programmatic invocation. A command line parameter --my-param
is then turning into a keyword argument my_param.

--auto-register-package (Default: False)

If enabled, the generated packages are automatically added to pyecore’s global namespace
registry, which makes them available during XMI deserialization.

--user-module (Default: None)

If specified, the given string is interpreted as a dotted Python module path. E.g.
--user-module my.custom_mod will make the generated code import mixin classes from a module
my.custom_mod. A generated class with name <name> then derives from a mixin
<name>Mixin, which is expected to be part of the user module. If this option is used, the
generator also produces a skeleton file which contains all required mixin classes and methods.
Usually you copy parts of this template to your own module, which is then checked into version
control all your other code.

--with-dependencies (Default: False)

If enabled, the generator also generates code from all metamodels that are dependencies of the
input metamodel. A metamodel dependency is typically a reference from the input
metamodel to another .ecore file. Please note that this option introduces slower code
generation as all metamodels must be scanned in order to determine dependencies.