psyclone.parse.kernel.BuiltInKernelTypeFactory Class Reference

Inheritance diagram for psyclone.parse.kernel.BuiltInKernelTypeFactory:

Collaboration diagram for psyclone.parse.kernel.BuiltInKernelTypeFactory:

Public Member Functions
def	create (self, builtin_names, builtin_defs_file, name=None)
Public Member Functions inherited from psyclone.parse.kernel.KernelTypeFactory
def	__init__ (self, api="")
def	create (self, parse_tree, name=None)

Detailed Description

Create API-specific information about the builtin metadata. The API
is set when the factory is created. Subclasses KernelTypeFactory
and makes use of its init method.

Definition at line 255 of file kernel.py.

Member Function Documentation

create()

def psyclone.parse.kernel.BuiltInKernelTypeFactory.create	(		self,
			builtin_names,
			builtin_defs_file,
			name = None
	)

Create API-specific information about the builtin metadata. This
method finds and parses the metadata then makes use of the
KernelTypeFactory parent class to return the api-specific
information about the builtin.

:param builtin_names: a list of valid builtin names
:type builtin_names: list of str
:param str builtin_defs_file: the file containing builtin \
metadata
:param name: the name of the builtin. Defaults to None if \
one is not provided.
:type name: str or NoneType

:raises ParseError: if the supplied name is not one of the \
builtin names
:raises ParseError: if the supplied name is recognised as a \
builtin but the associated file containing the required \
metadata can not be found.
:raises ParseError: if the metadata for the supplied builtin \
can not be parsed.

Definition at line 262 of file kernel.py.

    def create(self, builtin_names, builtin_defs_file, name=None):
        '''Create API-specific information about the builtin metadata. This
        method finds and parses the metadata then makes use of the
        KernelTypeFactory parent class to return the api-specific
        information about the builtin.
 
        :param builtin_names: a list of valid builtin names
        :type builtin_names: list of str
        :param str builtin_defs_file: the file containing builtin \
        metadata
        :param name: the name of the builtin. Defaults to None if \
        one is not provided.
        :type name: str or NoneType
 
        :raises ParseError: if the supplied name is not one of the \
        builtin names
        :raises ParseError: if the supplied name is recognised as a \
        builtin but the associated file containing the required \
        metadata can not be found.
        :raises ParseError: if the metadata for the supplied builtin \
        can not be parsed.
 
        '''
        if name not in builtin_names:
            raise ParseError(
                f"BuiltInKernelTypeFactory:create unrecognised built-in name. "
                f"Got '{name}' but expected one of {builtin_names}")
        # The meta-data for these lives in a Fortran module file
        # passed in to this method.
        fname = os.path.join(
            os.path.dirname(os.path.abspath(__file__)),
            builtin_defs_file)
        if not os.path.isfile(fname):
            raise ParseError(
                f"BuiltInKernelTypeFactory:create Kernel '{name}' is a "
                f"recognised Built-in but cannot find file '{fname}' "
                f"containing the meta-data describing the Built-in operations "
                f"for API '{self._type}'")
        # Attempt to parse the meta-data
        try:
            parsefortran.FortranParser.cache.clear()
            fparser.logging.disable(fparser.logging.CRITICAL)
            parse_tree = fpapi.parse(fname)
        except Exception as err:
            raise ParseError(
                f"BuiltInKernelTypeFactory:create: Failed to parse the meta-"
                f"data for PSyclone built-ins in file '{fname}'.") from err
 
        # Now we have the parse tree, call our parent class to create \
        # the object
        return KernelTypeFactory.create(self, parse_tree, name)
# pylint: enable=too-few-public-methods
 
 

Here is the caller 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/kernel.py