psyclone.psyGen.TransInfo Class Reference

Public Member Functions
def	__init__ (self, module=None, base_class=None)
def	list (self)
def	num_trans (self)
def	get_trans_num (self, number)
def	get_trans_name (self, name)

Detailed Description

This class provides information about, and access, to the available
transformations in this implementation of PSyclone. New transformations
will be picked up automatically as long as they subclass the abstract
Transformation class.

For example:

>>> from psyclone.psyGen import TransInfo
>>> t = TransInfo()
>>> print(t.list)
There is 1 transformation available:
  1: SwapTrans, A test transformation
>>> # accessing a transformation by index
>>> trans = t.get_trans_num(1)
>>> # accessing a transformation by name
>>> trans = t.get_trans_name("SwapTrans")

Definition at line 2633 of file psyGen.py.

Constructor & Destructor Documentation

__init__()

def psyclone.psyGen.TransInfo.__init__	(		self,
			module = None,
			base_class = None
	)

 if module and/or baseclass are provided then use these else use
    the default module "Transformations" and the default base_class
    "Transformation"

Definition at line 2654 of file psyGen.py.

    def __init__(self, module=None, base_class=None):
        ''' if module and/or baseclass are provided then use these else use
            the default module "Transformations" and the default base_class
            "Transformation"'''
 
        if False:
            self._0_to_n = DummyTransformation()  # only here for pyreverse!
 
        # TODO #620: This need to be improved to support the new
        # layout, where transformations are in different directories and files.
        # Leaving local imports so they will be removed once TransInfo is
        # replaced.
        # pylint: disable=import-outside-toplevel
        from psyclone import transformations
        if module is None:
            # default to the transformation module
            module = transformations
        if base_class is None:
            base_class = Transformation
        # find our transformations
        self._classes = self._find_subclasses(module, base_class)
 
        # create our transformations
        self._objects = []
        self._obj_map = {}
        for my_class in self._classes:
            my_object = my_class()
            self._objects.append(my_object)
            self._obj_map[my_object.name] = my_object
        # TODO #620:
        # Transformations that are in psyir and other subdirectories
        # are not found by TransInfo, so we add some that are used in
        # tests and examples explicitly. I'm leaving this import here
        # so it is obvious it can be removed.
        from psyclone.psyir.transformations import LoopFuseTrans
        my_object = LoopFuseTrans()
        # Only add the loop-fuse statement if base_class and module
        # match for the loop fusion transformation.
        if isinstance(my_object, base_class) and module == transformations:
            self._objects.append(LoopFuseTrans())
            self._obj_map["LoopFuseTrans"] = self._objects[-1]
 

References psyclone.domain.lfric.lfric_invokes.LFRicInvokes._0_to_n, psyclone.dynamo0p3.DynKernelArguments._0_to_n, psyclone.gocean1p0.GOInvokes._0_to_n, psyclone.gocean1p0.GOKernelArguments._0_to_n, psyclone.psyGen.TransInfo._0_to_n, psyclone.psyGen.TransInfo._classes, psyclone.psyGen.TransInfo._find_subclasses(), psyclone.psyGen.TransInfo._obj_map, and psyclone.psyGen.TransInfo._objects.

Here is the call graph for this function:

Member Function Documentation

get_trans_name()

def psyclone.psyGen.TransInfo.get_trans_name	(		self,
			name
	)

 return the transformation with this name (use list() first to see
    available transformations) 

Definition at line 2724 of file psyGen.py.

    def get_trans_name(self, name):
        ''' return the transformation with this name (use list() first to see
            available transformations) '''
        try:
            return self._obj_map[name]
        except KeyError:
            raise GenerationError(f"Invalid transformation name: got {name} "
                                  f"but expected one of "
                                  f"{self._obj_map.keys()}")
 

References psyclone.psyGen.TransInfo._obj_map.

get_trans_num()

def psyclone.psyGen.TransInfo.get_trans_num	(		self,
			number
	)

 return the transformation with this number (use list() first to
    see available transformations) 

Definition at line 2717 of file psyGen.py.

    def get_trans_num(self, number):
        ''' return the transformation with this number (use list() first to
            see available transformations) '''
        if number < 1 or number > len(self._objects):
            raise GenerationError("Invalid transformation number supplied")
        return self._objects[number-1]
 

References psyclone.psyGen.TransInfo._objects.

list()

def psyclone.psyGen.TransInfo.list

(

self

)

 return a string with a human readable list of the available
    transformations 

Definition at line 2697 of file psyGen.py.

    def list(self):
        ''' return a string with a human readable list of the available
            transformations '''
        import os
        if len(self._objects) == 1:
            result = "There is 1 transformation available:"
        else:
            result = (f"There are {len(self._objects)} transformations "
                      f"available:")
        result += os.linesep
        for idx, my_object in enumerate(self._objects):
            result += "  " + str(idx+1) + ": " + my_object.name + ": " + \
                      str(my_object) + os.linesep
        return result
 

References psyclone.psyGen.TransInfo._objects.

num_trans()

def psyclone.psyGen.TransInfo.num_trans

(

self

)

 return the number of transformations available 

Definition at line 2713 of file psyGen.py.

    def num_trans(self):
        ''' return the number of transformations available '''
        return len(self._objects)
 

References psyclone.psyGen.TransInfo._objects.

---

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

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