Python wrapper for XML output generator for Open Fortran Parser
Project description
Implementation has 2 parts: the XML generator written in Java, and Python wrapper for the generator.
The implementation is tested on Linux, OS X and Windows.
In this file, first the Java implementation is described and then the Python wrapper.
Java XML generator for OFP
This is an extension of Open Fortran Parser (OFP), which outputs abstract syntaxt tree (AST)
of parsed Fortran file in XML format - to a file or to System.out
.
dependencies
Java 1.7 or later
Open Fortran Parser 0.8.4-4
https://github.com/mbdevpl/open-fortran-parser/releases
This is a patched version of OFP. The list of changes is available at the above link.
ANTRL 3.3 (dependency of Open Fortran Parser)
Apache Commons CLI 1.4 (or later)
https://commons.apache.org/proper/commons-cli/download_cli.cgi
how to build
Get dependencies, either manually, or using the provided script:
pip3 install -U -r requirements.txt
python3 -m open_fortran_parser --dev-deps
export CLASSPATH="${CLASSPATH}:$(pwd)/lib/*"
Build:
ant
export CLASSPATH="${CLASSPATH}:$(pwd)/dist/*"
This will create a .jar file in dist directory, and add it to the Java classpath.
how to run
java fortran.ofp.FrontEnd --class fortran.ofp.XMLPrinter \
--output output.xml --verbosity 0~100 input.f
where:
The
--verbosity
flag controls verbosity of the parse tree. Defaluts to100
when omitted.Maximum,
100
, means that all details picked up by Open Fortran Parser will be preserved.Minimum,
0
, means that tree will contain only what is needed to reconstruct the program without changing it’s meaning.
The
--output
flag controls where the XML should be written. Defaults to standard output when omitted.
and remaining command-line options are exactly as defined in OFP 0.8.4.
To parse some_fortran_file.f
and save XML output in tree.xml
with minimum verbosity:
java fortran.ofp.FrontEnd --class fortran.ofp.XMLPrinter \
--output tree.xml --verbosity 0 some_fortran_file.f
And to dump XML with maximum verbosity to console:
java fortran.ofp.FrontEnd --class fortran.ofp.XMLPrinter \
--verbosity 100 some_fortran_file.f
AST specification
Root node is <ofp>
, it has one subnode <file>
.
Inside the <file>
, there might be one or many of the following nodes:
<program>
<subroutine>
<module>
<interface>
…
Each of which has <header>
and <body>
.
Additionally, <module>
has <members>
.
The contents of the header depend on the type of the node. For example, in case of subroutines, it contains list of parameters.
In the body, a special node <specification>
, followed by a collection of statements can be found.
The <specification>
contains a collection of following nodes:
<declaraion>
<use>
…
And, each of the statements listed after the specification, can be either compound or simple.
Compound statements, e.g.:
<if>
<loop>
<select>
…
each have <header>
and <body>
.
In the header of the <loop>
, at least one <index-variable>
is present.
It has <lower-bound>
, <upper-bound>
and <step>
.
In the header of <if>
, an expression is present.
In the body of <select>
there multiple <case>
nodes.
These are also compound (i.e. each of them has <header>
and <body>
),
however they exist only within the body of select statement.
Expression might be a single node like:
<name>
<literal>
…
More complex expressions are built from the <operation>
nodes, each of which contains
a collection of <operand>
and <operator>
nodes. Each operand constains an expression.
All simple statements are using <statement>
node, which wraps around nodes like:
<assignment>
<pointer-assignment>
<call>
<open>
<close>
<write>
<format>
<print>
<allocate>
<deallocate>
<return>
<stop>
<continue>
<cycle>
…
In addition to the above, nodes <comment>
and <directive>
exist to carry comments
and preprocessor directives, respectively. These nodes might be in principle inserted before,
after or within any of other nodes, however, in practice they are either surrounding
the top-level nodes (such as program or subroutine) or are placed in-between non-compound
declarations and/or statements within them.
Remaining details of AST are not decided yet. For the time being, to see implementation details, please take a look into src/fortran/ofp/XMLPrinter.java.
Unhandled corner cases
in certain corner cases, the parse tree might deviate from the above description.
This might be due to two main reasons:
Some feature is not yet implemented in this XML output generator
The events provided by OFP are not sufficient to generate a correct tree.
In case 1, all contributions to this project are very welcome. The implementation of any one of the missing features might not be very troublesome. The main reason why many of those features are not implemented yet is because the Fortran codes the current contributors work with do not use them.
In case 2, there is a need to dynamically reorder/modify/delete nodes, or otherwise manipulate existing parse tree while adding new nodes. In such case contributions are also very welcome, but implementation might be much more challenging in such cases.
Python wrapper for the generator
Using the wrapper should not require any special knowledge about the generator itself, other than knowing the abstract syntax tree (AST) specification.
dependencies
Java XML generator for OFP and all of its dependencies.
Python version 3.5 or later.
Python libraries as specified in requirements.txt.
Building and running tests additionally requires packages listed in test_requirements.txt.
how to build
pip3 install -U -r test_requirements.txt
python3 setup.py sdist --formats=gztar,zip
python3 setup.py bdist_wheel
how to install
You can simply install from PyPI:
pip3 install open-fortran-parser
Or using any of below commands, when installing from source:
pip3 install .
pip3 install dist/<filename>.whl
pip3 install dist/<filename>.tar.gz
pip3 install dist/<filename>.zip
how to run
The wrapper can be used as a script, or as a library.
When running any installed version, even if installed from source, dependencies are automatically installed together with the wrapper.
Before running from source (without installation), however, please follow “how to build” section for Java implementation above. You can make sure that dependencies are configured correctly by running:
python3 -m open_fortran_parser --deps
If the depenencies changed since you first ran the wrapper from the source tree, you can cleanup outdated dependencies by executing:
python3 -m open_fortran_parser --cleanup-deps
as script
$ python3 -m open_fortran_parser -h
usage: open_fortran_parser [-h] [--version] [-v VERBOSITY]
[--get-dependencies]
[input] [output]
Python wrapper around XML generator for Open Fortran Parser
positional arguments:
input path to Fortran source code file (default: None)
output writable path for where to store resulting XML,
defaults to stdout if no path provided (default: None)
optional arguments:
-h, --help show this help message and exit
--version show program\'s version number and exit
-v VERBOSITY, --verbosity VERBOSITY
level of verbosity, from 0 to 100 (default: 100)
--get-dependencies, --deps
download dependencies and exit (default: False)
Copyright 2017-2018 by the contributors, Apache License 2.0,
https://github.com/mbdevpl/open-fortran-parser-xml
as library
from open_fortran_parser import parse
xml = parse('my_legacy_code.f', verbosity=0)
More examples available in examples.ipynb.
testing
Run basic tests:
python3 -m unittest -v
TEST_LONG=1 python3 -m unittest -v # this might take a long time...
code coverage
Getting code coverage results for Java requires JaCoCo agent, and JaCoCo CLI.
Set up code coverage for Java:
wget "https://github.com/mbdevpl/open-fortran-parser-xml/releases/download/v0.2.0/org.jacoco.agent-0.8.1-runtime.jar" -O "lib/org.jacoco.agent-0.8.1-runtime.jar"
wget "https://github.com/mbdevpl/open-fortran-parser-xml/releases/download/v0.2.0/org.jacoco.cli-0.8.1-nodeps.jar" -O "lib/org.jacoco.cli-0.8.1-nodeps.jar"
Then, run all test and gather code coverage:
TEST_LONG=1 TEST_COVERAGE=1 python3 -m coverage run --branch --source . -m unittest -v
This will take a long while.
Then, generate results for Python code:
python3 -m coverage report --show-missing
python3 -m coverage html
Finally, generate results for Java code:
java -jar "lib/org.jacoco.cli-0.8.1-nodeps.jar" report "jacoco.exec" --classfiles "bin/" --sourcefiles "src/" --xml jacoco.xml
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
Built Distribution
Hashes for open-fortran-parser-0.5.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e1c955ff41c859a6e7912d814c08d373faecd9fb58a162e6884c151bc55971b |
|
MD5 | 049e6bbac1331a37094ca37529cf6118 |
|
BLAKE2b-256 | b3cd0cfb6f4bba4c5265dd386893271d2635a69a5f145feafd0d01adabafa0fd |
Hashes for open_fortran_parser-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca699282b7dbf6df59cbb63225a915f27c082ef8c246d02e60bb81270dff1557 |
|
MD5 | 9c1d9e58b8e9cb13138532310ed8efa4 |
|
BLAKE2b-256 | 6f3ba3b7331bdf730a638d244c40d29bba7f4c296c0d9290dc6cad8cc6e9a5be |