API reference

fortdepend.fort_depend module

class fortdepend.fort_depend.FortranProject(name=None, exclude_files=None, files=None, ignore_modules=None, macros=None, cpp_includes=None, use_preprocessor=True, verbose=False)

Bases: object

Read a set of Fortran source files and produce a set of FortranFile, FortranModule and the dependencies between them

Example

This is the main class for interacting with a Fortran project. The minimal “useful” thing is:

>>> import fortdepend
>>> my_project = fortdepend.FortranProject()
>>> my_project.write_depends()

This will read all the .f90 and .F90 files in the current directory and write the dependencies to “makefile.dep”

Parameters:

• name (str) – Name of the project (default: name of current directory)

• exclude_files (list of str) – List of files to exclude

• files (list of str) – List of files to include (default: all in current directory)

• ignore_modules (list of str) – List of module names to ignore_mod (default: iso_c_binding and iso_fortran_env)

• macros (dict, list or str) – Preprocessor macro definitions

• cpp_includes (list of str) – List of directories to add to preprocessor search path

• use_preprocessor (bool) – Use the preprocessor (default: True)

• verbose (bool) – Print more messages (default: False)

get_all_used_files(module_name)

Get the complete set of files that a module requires, either directly or indirectly

Parameters:

module_name (str) – A module name

Returns:

list of filenames (str)

get_all_used_modules(module_name)

Get the complete set of modules that module_name requires, either directly or indirectly

Parameters:

module_name (str) – A module name

Returns:

list of module names (str)

get_depends_by_file(verbose=False)

Return the set of which files each file directly depends on

Parameters:

verbose – Print progress messages

Returns:

dict of FortranFile and a list of FortranFile

get_depends_by_module(verbose=False)

Return the set of which modules each module directly depends on

Parameters:

verbose – Print progress messages

Returns:

dict of FortranModule and a list of FortranModule

get_modules()

Return a dict of all the modules found in the project

Works by iterating over the list of FortranFile and merging their dicts of FortranModule

Returns:

dict of module name (str) and FortranModule objects

get_source(extensions=None)

Return a list of filenames ending with any of extensions

Parameters:

extensions – List of file extensions (defaults to [“.f90”, “.F90”])

make_graph(filename=None, format='svg', view=True)

Draw a graph of the project using graphviz

Parameters:

• filename (str) – Name of the output file

• format (str) – Image format (default: ‘svg’)

• view (bool) – Immediately display the graph [True]

remove_ignored_modules(ignore_modules=None)

Remove the modules in iterable ignore_modules from all dependencies

Parameters:

ignore_modules (iterable of str) – module names to ignore (default: iso_c_binding and iso_fortran_env)

write_depends(filename='makefile.dep', overwrite=False, build='', skip_programs=False)

Write the dependencies to file

Parameters:

• filename (str) – Name of the output file

• overwrite (bool) – Overwrite existing dependency file [False]

• build (str) – Directory to prepend to filenames

• skip_programs (bool) – Don’t write dependencies for programs

fortdepend.graph module

class fortdepend.graph.Graph(tree, filename=None, format='svg', view=True)

Bases: object

Draw a graph of the project using graphviz

Parameters:

• filename (str) – Name of the output file

• format (str) – Image format

• view (bool) – Immediately display the graph [True]

draw()

Render the graph to an image

fortdepend.preprocessor module

class fortdepend.preprocessor.FortranPreprocessor

Bases: Preprocessor

parse_to_string(text, source)

fortdepend.smartopen module

fortdepend.smartopen.smart_open(filename, mode='Ur', *args, **kwargs)

Open stdin or stdout using a contextmanager

From: http://stackoverflow.com/a/29824059/2043465

Parameters:

• filename (str) – name of file to open. Can be ‘-’ for stdin/stdout

• mode (str) – usual mode string for open()

fortdepend.units module

class fortdepend.units.FortranFile(filename=None, macros=None, readfile=True, cpp_includes=None, use_preprocessor=True)

Bases: object

The modules and dependencies of a Fortran source file

Parameters:

• filename (str) – Source file

• macros (iterable) – Dict of preprocessor macros to be expanded

• readfile (bool) – Read and process the file [True]

• cpp_includes (list of str) – List of directories to add to preprocessor search path

• use_preprocessor (bool) – Preprocess the source file [True]

get_modules(contents, macros=None)

Return all the modules or programs that are in the file

Parameters:

contents (str) – Contents of the source file

get_uses()

Return a sorted list of the modules this file USEs

class fortdepend.units.FortranModule(unit_type, name, source_file=None, text=None, macros=None)

Bases: object

A Fortran Module or Program

Parameters:

• unit_type (str) – ‘module’ or ‘program’

• name (str) – Name of the module/program

• source_file (str) – Name of the file containing the module/program

• text (tuple) – Tuple containing source_file contents, and start and end lines of the module

• macros (dict) – Any defined macros

get_uses(contents, macros=None)

Return which modules are used in the file after expanding macros

Parameters:

• contents (str) – Contents of the source file

• macros (dict) – Dict of preprocessor macros to be expanded