Inheritance diagram for psyclone.psyir.symbols.containersymbol.ContainerSymbol:

Collaboration diagram for psyclone.psyir.symbols.containersymbol.ContainerSymbol:

Public Member Functions
def	__init__ (self, name, wildcard_import=False, **kwargs)

def	copy (self)

def	container (self)

def	__str__ (self)

def	wildcard_import (self)

def	wildcard_import (self, value)

Public Member Functions inherited from psyclone.psyir.symbols.symbol.Symbol
def	__init__ (self, name, visibility=DEFAULT_VISIBILITY, interface=None)

def	copy_properties (self, symbol_in)

def	specialise (self, subclass, **kwargs)

def	get_external_symbol (self)

def	resolve_type (self)

def	name (self)

def	visibility (self)

def	visibility (self, value)

def	interface (self)

def	interface (self, value)

def	is_automatic (self)

def	is_modulevar (self)

def	is_import (self)

def	is_argument (self)

def	is_commonblock (self)

def	is_static (self)

def	is_unresolved (self)

def	is_unknown_interface (self)

def	find_symbol_table (self, node)

def	is_array (self)

def	is_array_access (self, index_variable=None, access_info=None)

Public Attributes
	wildcard_import

Public Attributes inherited from psyclone.psyir.symbols.symbol.Symbol
	interface

	visibility

Additional Inherited Members
Static Public Attributes inherited from psyclone.psyir.symbols.symbol.Symbol
	DEFAULT_VISIBILITY = Visibility.PUBLIC

Detailed Description

 Symbol that represents a reference to a Container. The reference
is lazy evaluated, this means that the Symbol will be created without
parsing and importing the referenced container, but this can be imported
when needed.

:param str name: name of the symbol.
:param bool wildcard_import: if all public Symbols of the Container are \
    imported into the current scope. Defaults to False.
:param kwargs: additional keyword arguments provided by \
    :py:class:`psyclone.psyir.symbols.Symbol`.
:type kwargs: unwrapped dict.

Definition at line 47 of file containersymbol.py.

Member Function Documentation

◆ container()

def psyclone.psyir.symbols.containersymbol.ContainerSymbol.container ( self )

 Returns the referenced container. If it is not available, use
the interface to import the container

:returns: referenced container.
:rtype: :py:class:`psyclone.psyir.nodes.Container`

Definition at line 121 of file containersymbol.py.

     def container(self):
         ''' Returns the referenced container. If it is not available, use
         the interface to import the container
  
         :returns: referenced container.
         :rtype: :py:class:`psyclone.psyir.nodes.Container`
         '''
         if not self._reference:
             self._reference = self._interface.import_container(self._name)
         return self._reference
  

References psyclone.psyir.symbols.symbol.Symbol._interface, 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, psyclone.psyir.symbols.symbol.Symbol._name, and psyclone.psyir.symbols.containersymbol.ContainerSymbol._reference.

Here is the caller graph for this function:

◆ copy()

def psyclone.psyir.symbols.containersymbol.ContainerSymbol.copy ( self )

Create and return a copy of this object. Any references to the
original will not be affected so the copy will not be referred
to by any other object.

:returns: A symbol object with the same properties as this \
          symbol object.
:rtype: :py:class:`psyclone.psyir.symbols.Symbol`

Reimplemented from psyclone.psyir.symbols.symbol.Symbol.

Definition at line 105 of file containersymbol.py.

     def copy(self):
         '''Create and return a copy of this object. Any references to the
         original will not be affected so the copy will not be referred
         to by any other object.
  
         :returns: A symbol object with the same properties as this \
                   symbol object.
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
  
         '''
         # Use the generic Symbol copy and add the wildcard import value
         new_symbol = super(ContainerSymbol, self).copy()
         new_symbol.wildcard_import = self.wildcard_import
         return new_symbol
  

References psyclone.psyir.symbols.containersymbol.ContainerSymbol.wildcard_import.

◆ wildcard_import() [1/2]

def psyclone.psyir.symbols.containersymbol.ContainerSymbol.wildcard_import ( self )

:returns: whether or not there is a wildcard import of all public \
          symbols from this Container.
:rtype: bool

Definition at line 141 of file containersymbol.py.

     def wildcard_import(self):
         '''
         :returns: whether or not there is a wildcard import of all public \
                   symbols from this Container.
         :rtype: bool
  
         '''
         return self._has_wildcard_import
  

References psyclone.psyir.symbols.containersymbol.ContainerSymbol._has_wildcard_import.

Here is the caller graph for this function:

◆ wildcard_import() [2/2]

def psyclone.psyir.symbols.containersymbol.ContainerSymbol.wildcard_import	(	self,
		value
	)

Set whether or not there is a wildcard import of all public symbols
from this Container symbol.

:param bool value: whether there is or is not a wildcard import.

:raises TypeError: if the supplied `value` is not a bool.

Definition at line 151 of file containersymbol.py.

     def wildcard_import(self, value):
         '''
         Set whether or not there is a wildcard import of all public symbols
         from this Container symbol.
  
         :param bool value: whether there is or is not a wildcard import.
  
         :raises TypeError: if the supplied `value` is not a bool.
  
         '''
         if not isinstance(value, bool):
             raise TypeError(f"wildcard_import must be a bool but got: "
                             f"'{type(value).__name__}'")
         self._has_wildcard_import = value
  
  

References psyclone.psyir.symbols.containersymbol.ContainerSymbol._has_wildcard_import.

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/psyir/symbols/containersymbol.py

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ container()

◆ copy()

◆ wildcard_import() [1/2]

◆ wildcard_import() [2/2]