Modeling: User's Guide

Previous: 3.1.1 Generating the python Up: 3.1.1 Generating the python Next: 3.1.1.2 Separating the generated

---

 
3.1.1.1 The minimum

The first option you have is to generate the whole python package AuthorBooks and its modules Writer.py and Book.py.

For that purpose, you'll use the script mdl_generate_python_code.py (note that the same functionalities are also offered in the ZModeler).

On the command-line, type:

mdl_generate_python_code.py model_AuthorBooks.xml

We'll see in the next paragraph that there exists two different way of generating the code. That one is the simplest and uses the default option of the script mdl_generate_python_code.py: -C or --compact-generation-scheme^3.1.

The script creates the python package AuthorBooks in the current directory, in which you'll find the following files:

AuthorBooks/
|--   Book.py
|--   Writer.py
|--   __init__.py
|-- * model_AuthorBooks.py
|-- * model_AuthorBooks.xml
`--   setup.py

Note: the files marked with a star (*) are the only one that are overwritten by the script, if they already exist.

• __init__.py, which takes care to load the model within the default ModelSet,

• a copy of the model in the corresponding xml file which is used, and a python file containing a copy of the xml model as well; the reason for which the model is copied into a python file is that it makes it easy to distribute and install it along w/ the other modules using the standard distutils.

  Also note: even if you generate the python module from a pymodel, you'll only get those two xml-models in the generated package. This might change in the future, in the meantime, feel free to replace them with your pymodel, the code generated in __init__.py loading the model is capable of finding either a pymodel or an xml-model (see Model.searchModel()

• Writer and Book: they contain the classes Book and Writer, ready to be used

• setup.py: a distutils script that you can use to install the package, to distribute it, etc. (see Distributing Python Modules and Installing Python Modules for details about the Python Distribution Utilities).

This bunch of files gives a minimalist view of what is needed to bind python code to a model and to the framework -this subject is fully discussed in the dedicated section 3.2. You can use it:

• to quickly test a model, but in this case, you'll probably prefer to dynamically build the package and modules (see section 3.1.2, below),

• or to start coding your classes from that point. Now if you want to use the generated code as a basis for your own development, we strongly advise you to consider using the other generation scheme exposed in the next paragraph.

Footnotes

...compact-generation-scheme^3.1

Please refer to mdl_generate_python_code.py --help for a comprehensive view on the script's usage and options

---

Modeling: User's Guide

Previous: 3.1.1 Generating the python Up: 3.1.1 Generating the python Next: 3.1.1.2 Separating the generated

---

Release 0.9, documentation updated on March 4, 2006.

Comments are welcome: Sebastien Bigaret / Modeling Home Page
Hosted by: