psyclone.parse.module_info.ModuleInfo Class Reference

Public Member Functions
def	__init__ (self, name, filename)
def	name (self)
def	filename (self)
def	get_source_code (self)
def	get_parse_tree (self)
def	contains_routine (self, routine_name)
def	get_used_modules (self)
def	get_used_symbols_from_modules (self)
def	get_psyir (self)
def	resolve_routine (self, routine_name)

Detailed Description

This class stores mostly cached information about modules: it stores
the original filename, if requested it will read the file and then caches
the plain text file, and if required it will parse the file, and then
cache the fparser AST.

:param str name: the module name.
:param str filename: the name of the source file that stores this module \
    (including path).

Definition at line 73 of file module_info.py.

Member Function Documentation

contains_routine()

def psyclone.parse.module_info.ModuleInfo.contains_routine	(		self,
			routine_name
	)

:returns: whether the specified routine name is part of this
    module or not. It will also return False if the file could
    not be parsed.
:rtype: bool

Definition at line 218 of file module_info.py.

    def contains_routine(self, routine_name):
        ''':returns: whether the specified routine name is part of this
            module or not. It will also return False if the file could
            not be parsed.
        :rtype: bool
 
        '''
        # TODO #2422 and TODO #2478: Once we parse everything to PSyIR (esp.
        # generic interfaces), this routine can just be replaced with
        # get_psyir().get_routine_psyir(routine_name)
        if self._routine_names is None:
            # This will trigger adding routine information
            try:
                self.get_parse_tree()
            except FortranSyntaxError:
                return False
 
        return routine_name.lower() in self._routine_names
 

References psyclone.parse.module_info.ModuleInfo._routine_names, psyclone.parse.module_info.ModuleInfo._used_modules, psyclone.parse.module_info.ModuleInfo._used_symbols_from_module, and psyclone.parse.module_info.ModuleInfo.get_parse_tree().

Here is the call graph for this function:

filename()

def psyclone.parse.module_info.ModuleInfo.filename

(

self

)

:returns: the filename that contains the source code for this \
    module.
:rtype: str

Definition at line 133 of file module_info.py.

    def filename(self):
        ''':returns: the filename that contains the source code for this \
            module.
        :rtype: str
 
        '''
        return self._filename
 

References psyclone.parse.module_info.ModuleInfo._filename.

get_parse_tree()

def psyclone.parse.module_info.ModuleInfo.get_parse_tree

(

self

)

Returns the fparser AST for this module. The first time, the file
will be parsed by fparser using the Fortran 2008 standard. The AST is
then cached for any future uses.

:returns: the fparser AST for this module.
:rtype: :py:class:`fparser.two.Fortran2003.Program`

Definition at line 164 of file module_info.py.

    def get_parse_tree(self):
        '''Returns the fparser AST for this module. The first time, the file
        will be parsed by fparser using the Fortran 2008 standard. The AST is
        then cached for any future uses.
 
        :returns: the fparser AST for this module.
        :rtype: :py:class:`fparser.two.Fortran2003.Program`
 
        '''
        if self._parse_tree is None:
            # Set routine_names to be an empty set (it was None before).
            # This way we avoid that any other function might trigger to
            # parse this file again (in case of parsing errors).
            self._routine_names = set()
 
            reader = FortranStringReader(self.get_source_code())
            parser = ParserFactory().create(std="f2008")
            self._parse_tree = parser(reader)
 
            # First collect information about all subroutines/functions.
            # Store information about generic interface to be handled later
            # (so we only walk the tree once):
            # TODO #2478: once generic interfaces are supported, use PSyIR
            # instead of fparser here.
            all_generic_interfaces = []
            for routine in walk(self._parse_tree, (Function_Subprogram,
                                                   Subroutine_Subprogram,
                                                   Interface_Block)):
                if isinstance(routine, Interface_Block):
                    all_generic_interfaces.append(routine)
                else:
                    routine_name = str(routine.content[0].items[1])
                    self._routine_names.add(routine_name)
 
            # Then handle all generic interfaces and add them to
            # _generic_interfaces:
            for interface in all_generic_interfaces:
                # TODO #2422 This code does not support all potential
                # interface statements. After #2422 we can use PSyIR here.
                # Get the name of the interface from the Interface_Stmt:
                name = str(walk(interface, Interface_Stmt)[0].items[0]).lower()
                self._routine_names.add(name)
 
                # Collect all specific functions for this generic interface
                routine_names = []
                for proc_stmt in walk(interface, Procedure_Stmt):
                    # Convert the items to strings:
                    routine_names.extend([str(i) for i in
                                          proc_stmt.items[0].items])
                self._generic_interfaces[name] = routine_names
 
        return self._parse_tree
 

References psyclone.parse.module_info.ModuleInfo._generic_interfaces, psyclone.parse.module_info.ModuleInfo._parse_tree, psyclone.parse.module_info.ModuleInfo._routine_names, and psyclone.parse.module_info.ModuleInfo.get_source_code().

Here is the call graph for this function:

Here is the caller graph for this function:

get_psyir()

def psyclone.parse.module_info.ModuleInfo.get_psyir

(

self

)

Returns the PSyIR representation of this module. This is based
on the fparser tree (see get_parse_tree), and the information is
cached. If the PSyIR must be modified, it needs to be copied,
otherwise the modified tree will be returned from the cache in the
future.
If the conversion to PSyIR fails, a dummy FileContainer with an
empty Container (module) is returned, which avoids additional error
handling in many other subroutines.
#TODO 2120: This should be revisited when improving on the error
handling.

:param routine_name: optional the name of a routine.
:type routine_name: Optional[str]

:returns: PSyIR representing this module.
:rtype: list[:py:class:`psyclone.psyir.nodes.Node`]

Definition at line 312 of file module_info.py.

    def get_psyir(self):
        '''Returns the PSyIR representation of this module. This is based
        on the fparser tree (see get_parse_tree), and the information is
        cached. If the PSyIR must be modified, it needs to be copied,
        otherwise the modified tree will be returned from the cache in the
        future.
        If the conversion to PSyIR fails, a dummy FileContainer with an
        empty Container (module) is returned, which avoids additional error
        handling in many other subroutines.
        #TODO 2120: This should be revisited when improving on the error
        handling.
 
        :param routine_name: optional the name of a routine.
        :type routine_name: Optional[str]
 
        :returns: PSyIR representing this module.
        :rtype: list[:py:class:`psyclone.psyir.nodes.Node`]
 
        '''
        if self._psyir is None:
            try:
                self._psyir = \
                    self._processor.generate_psyir(self.get_parse_tree())
            except (KeyError, SymbolError, InternalError,
                    FortranSyntaxError) as err:
                print(f"Error trying to parse '{self.filename}': '{err}'")
                # TODO #11: Add proper logging
                # TODO #2120: Handle error better. Long term we should not
                # just ignore errors.
                # Create a dummy FileContainer with a dummy module. This avoids
                # additional error handling in other subroutines, since they
                # will all return 'no information', whatever you ask for
                self._psyir = FileContainer(os.path.basename(self._filename))
                module = Container("invalid-module")
                self._psyir.children.append(module)
 
        # TODO #2462: needs to be fixed to properly support multiple modules
        # in one file
        # Return the actual module Container (not the FileContainer)
        return self._psyir.children[0]
 

References psyclone.parse.module_info.ModuleInfo._filename, psyclone.parse.module_info.ModuleInfo._processor, psyclone.psyir.frontend.fortran.FortranReader._processor, psyclone.parse.module_info.ModuleInfo._psyir, and psyclone.parse.module_info.ModuleInfo.get_parse_tree().

Here is the call graph for this function:

Here is the caller graph for this function:

get_source_code()

def psyclone.parse.module_info.ModuleInfo.get_source_code

(

self

)

Returns the source code for the module. The first time, it
will be read from the file, but the data is then cached.

:returns: the source code.
:rtype: str

:raises ModuleInfoError: when the file cannot be read.

Definition at line 142 of file module_info.py.

    def get_source_code(self):
        '''Returns the source code for the module. The first time, it
        will be read from the file, but the data is then cached.
 
        :returns: the source code.
        :rtype: str
 
        :raises ModuleInfoError: when the file cannot be read.
 
        '''
        if self._source_code is None:
            try:
                with open(self._filename, "r", encoding='utf-8') as file_in:
                    self._source_code = file_in.read()
            except FileNotFoundError as err:
                raise ModuleInfoError(
                    f"Could not find file '{self._filename}' when trying to "
                    f"read source code for module '{self._name}'") from err
 
        return self._source_code
 

References psyclone.parse.module_info.ModuleInfo._filename, and psyclone.parse.module_info.ModuleInfo._source_code.

Here is the caller graph for this function:

get_used_modules()

def psyclone.parse.module_info.ModuleInfo.get_used_modules

(

self

)

This function returns a set of all modules `used` in this
module. Fortran `intrinsic` modules will be ignored. The information
is based on the fparser parse tree of the module (since fparser can
handle more files than PSyir, like LFRic's `constants_mod` which has
pre-processor directives).

:returns: a set with all imported module names.
:rtype: set[str]

Definition at line 278 of file module_info.py.

    def get_used_modules(self):
        '''This function returns a set of all modules `used` in this
        module. Fortran `intrinsic` modules will be ignored. The information
        is based on the fparser parse tree of the module (since fparser can
        handle more files than PSyir, like LFRic's `constants_mod` which has
        pre-processor directives).
 
        :returns: a set with all imported module names.
        :rtype: set[str]
 
        '''
        if self._used_modules is None:
            self._extract_import_information()
 
        return self._used_modules
 

References psyclone.parse.module_info.ModuleInfo._extract_import_information(), and psyclone.parse.module_info.ModuleInfo._used_modules.

Here is the call graph for this function:

get_used_symbols_from_modules()

def psyclone.parse.module_info.ModuleInfo.get_used_symbols_from_modules

(

self

)

This function returns information about which modules are used by
this module, and also which symbols are imported. The return value is
a dictionary with the used module name as key, and a set of all
imported symbol names as value.

:returns: a dictionary that gives for each module name the set \
    of symbols imported from it.
:rtype: dict[str, set[str]]

Definition at line 295 of file module_info.py.

    def get_used_symbols_from_modules(self):
        '''This function returns information about which modules are used by
        this module, and also which symbols are imported. The return value is
        a dictionary with the used module name as key, and a set of all
        imported symbol names as value.
 
        :returns: a dictionary that gives for each module name the set \
            of symbols imported from it.
        :rtype: dict[str, set[str]]
 
        '''
        if self._used_symbols_from_module is None:
            self._extract_import_information()
 
        return self._used_symbols_from_module
 

References psyclone.parse.module_info.ModuleInfo._extract_import_information(), and psyclone.parse.module_info.ModuleInfo._used_symbols_from_module.

Here is the call graph for this function:

name()

def psyclone.parse.module_info.ModuleInfo.name

(

self

)

:returns: the name of this module.
:rtype: str

Definition at line 124 of file module_info.py.

    def name(self):
        ''':returns: the name of this module.
        :rtype: str
 
        '''
        return self._name
 

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

resolve_routine()

def psyclone.parse.module_info.ModuleInfo.resolve_routine	(		self,
			routine_name
	)

This function returns a list of function names that might be
actually called when the routine `name` is called. In most cases
this is exactly name, but in case of a generic subroutine the
name might change. For now (since we cannot resolve generic
interfaces yet), we return the list of all possible functions that
might be called.

:param str routine_name: the name of the routine to resolve

:returns: list of routine name(s) that could be called.
:rtype: list[str]

Definition at line 354 of file module_info.py.

    def resolve_routine(self, routine_name):
        '''This function returns a list of function names that might be
        actually called when the routine `name` is called. In most cases
        this is exactly name, but in case of a generic subroutine the
        name might change. For now (since we cannot resolve generic
        interfaces yet), we return the list of all possible functions that
        might be called.
 
        :param str routine_name: the name of the routine to resolve
 
        :returns: list of routine name(s) that could be called.
        :rtype: list[str]
 
        '''
        # TODO #2422: once #2422 is done, this can be moved into the PSyIR
        if self._psyir is None:
            self.get_psyir()
        routine_name = routine_name.lower()
        if routine_name not in self._generic_interfaces:
            return [routine_name]
 
        # If a generic interface name is queried, return a copy
        # of all possible routine names that might be called:
        return self._generic_interfaces[routine_name][:]

References psyclone.parse.module_info.ModuleInfo._generic_interfaces, psyclone.parse.module_info.ModuleInfo._psyir, and psyclone.parse.module_info.ModuleInfo.get_psyir().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/parse/module_info.py