fparser.common.base_classes

Base classes for all Fortran statement types

Module Contents

Classes

AttributeHolder	Defines a object with predefined attributes. Only those attributes
Variable	Variable instance has attributes:
ProgramBlock
Statement	Statement instance has attributes:
BeginStatement
EndStatement	END [<blocktype> [<name>]]

class fparser.common.base_classes.AttributeHolder(**kws)

Defines a object with predefined attributes. Only those attributes are allowed that are specified as keyword arguments of a constructor. When an argument is callable then the corresponding attribute will be read-only and set by the value the callable object returns.

__getattr__(name)

__setattr__(name, value)

Implement setattr(self, name, value).

isempty()

__repr__()

Return repr(self).

torepr(depth=-1, tab='')

todict()

class fparser.common.base_classes.Variable(parent, name)

Variable instance has attributes:

name
typedecl
dimension
attributes
intent
parent - Statement instances defining the variable

known_intent_specs = ['IN', 'OUT', 'INOUT', 'CACHE', 'HIDE', 'COPY', 'OVERWRITE', 'CALLBACK', 'AUX', 'C', 'INPLACE', 'OUT=']

known_attributes = ['PUBLIC', 'PRIVATE', 'ALLOCATABLE', 'ASYNCHRONOUS', 'EXTERNAL', 'INTRINSIC', 'OPTIONAL',...

__repr__()

Return repr(self).

get_typedecl()

add_parent(parent)

set_type(typedecl)

set_init(expr)

set_dimension(dims)

set_bounds(bounds)

set_length(length)

set_intent(intent)

is_intent_in()

is_intent_inout()

is_intent_hide()

is_intent_inplace()

is_intent_out()

is_intent_c()

is_intent_cache()

is_intent_copy()

is_intent_overwrite()

is_intent_callback()

is_intent_aux()

is_private()

is_public()

is_allocatable()

is_external()

is_intrinsic()

is_parameter()

is_optional()

is_required()

is_pointer()

is_array()

is_scalar()

update(*attrs)

__str__()

Return str(self).

get_array_spec()

is_deferred_shape_array()

is_assumed_size_array()

is_assumed_shape_array()

is_explicit_shape_array()

is_allocatable_array()

is_array_pointer()

analyze()

error(message)

warning(message)

info(message)

class fparser.common.base_classes.ProgramBlock

class fparser.common.base_classes.Statement(parent, item)

Statement instance has attributes:

parent  - Parent BeginStatement or FortranParser instance
item    - Line instance containing the statement line
isvalid - boolean, when False, the Statement instance will be ignored

modes = ['free', 'fix', 'f77', 'pyf']

_repr_attr_names = []

__repr__()

Return repr(self).

torepr(depth=-1, incrtab='')

get_indent_tab(deindent=False, isfix=None)

__str__()

Return str(self).

asfix()

format_message(kind, message)

error(message)

warning(message)

info(message)

analyze()

get_variable(name)

Return Variable instance of variable name.

get_type(name)

Return type declaration using implicit rules for name.

get_type_decl(kind)

get_provides()

Returns dictonary containing statements that block provides or None when N/A.

class fparser.common.base_classes.BeginStatement(parent, item=None)

Bases: Statement

[ construct_name : ] <blocktype> [ <name> ]

BeginStatement instances have additional attributes:

name
blocktype

Block instance has attributes:

content - list of Line or Statement instances
name    - name of the block, unnamed blocks are named
          with the line label
construct_name - name of a construct
parent  - Block or FortranParser instance
item    - Line instance containing the block start statement
get_item, put_item - methods to retrive/submit Line instances
          from/to Fortran reader.
isvalid - boolean, when False, the Block instance will be ignored.

stmt_cls, end_stmt_cls

_repr_attr_names

tostr()

tofortran(isfix=None)

torepr(depth=-1, incrtab='')

process_item()

Process the line

fill(end_flag=False)

Fills blocks content until the end of block statement.

process_subitem(item)

Check if item is blocks start statement, if it is, read the block.

Return True to stop adding items to given block.

handle_unknown_item_and_raise(item)

Called when process_subitem does not find a start or end of block. It adds the item (which is an instance of Line) to the content, but then raises an AnalyzeError. An instance of Line in content typically results in other errors later (e.g. because Line has no analyze method).

analyze()

class fparser.common.base_classes.EndStatement(parent, item)

Bases: Statement

END [<blocktype> [<name>]]

EndStatement instances have additional attributes:

name
blocktype

_repr_attr_names

process_item()

analyze()

get_indent_tab(deindent=False, isfix=None)

tofortran(isfix=None)

Returns a valid Fortran string for this END statement. It guarantees that there is no white space after the ‘END’ in case of an unnamed statement.

Parameters:

isfix (bool) – True if the code is in fixed format.

Returns:

the (named or unnamed) valid Fortran END statement as a string.

Return type:

str