Inheritance diagram for psyclone.psyir.symbols.symbol.Symbol:

[legend]

Classes
class	Visibility

Public Member Functions
def	__init__ (self, name, visibility=DEFAULT_VISIBILITY, interface=None)

def	copy (self)

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	__str__ (self)

def	is_array (self)

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

Public Attributes
	interface

	visibility

Static Public Attributes
	DEFAULT_VISIBILITY = Visibility.PUBLIC

Detailed Description

Generic Symbol item for the Symbol Table and PSyIR References.
It has an immutable name label because it must always match with the
key in the SymbolTable. If the symbol is private then it is only visible
to those nodes that are descendants of the Node to which its containing
Symbol Table belongs.

:param str name: name of the symbol.
:param visibility: the visibility of the symbol.
:type visibility: :py:class:`psyclone.psyir.symbols.Symbol.Visibility`
:param interface: optional object describing the interface to this \
    symbol (i.e. whether it is passed as a routine argument or \
    accessed in some other way). Defaults to \
    :py:class:`psyclone.psyir.symbols.AutomaticInterface`
:type interface: Optional[ \
    :py:class:`psyclone.psyir.symbols.symbol.SymbolInterface`]

:raises TypeError: if the name is not a str.

Definition at line 62 of file symbol.py.

Member Function Documentation

◆ copy()

def psyclone.psyir.symbols.symbol.Symbol.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 in psyclone.psyir.symbols.typed_symbol.TypedSymbol, psyclone.psyir.symbols.generic_interface_symbol.GenericInterfaceSymbol, psyclone.psyir.symbols.datasymbol.DataSymbol, psyclone.psyir.symbols.data_type_symbol.DataTypeSymbol, and psyclone.psyir.symbols.containersymbol.ContainerSymbol.

Definition at line 137 of file symbol.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`
  
         '''
         # The constructors for all Symbol-based classes have 'name' as the
         # first positional argument.
         return type(self)(self.name, visibility=self.visibility,
                           interface=self.interface.copy())
  

Here is the call graph for this function:

◆ copy_properties()

def psyclone.psyir.symbols.symbol.Symbol.copy_properties	(	self,
		symbol_in
	)

Replace all properties in this object with the properties from
symbol_in, apart from the name (which is immutable) and visibility.

:param symbol_in: the symbol from which the properties are copied.
:type symbol_in: :py:class:`psyclone.psyir.symbols.Symbol`

:raises TypeError: if the argument is not the expected type.

Reimplemented in psyclone.psyir.symbols.typed_symbol.TypedSymbol, psyclone.psyir.symbols.datasymbol.DataSymbol, and psyclone.psyir.symbols.data_type_symbol.DataTypeSymbol.

Definition at line 152 of file symbol.py.

     def copy_properties(self, symbol_in):
         '''Replace all properties in this object with the properties from
         symbol_in, apart from the name (which is immutable) and visibility.
  
         :param symbol_in: the symbol from which the properties are copied.
         :type symbol_in: :py:class:`psyclone.psyir.symbols.Symbol`
  
         :raises TypeError: if the argument is not the expected type.
  
         '''
         if not isinstance(symbol_in, Symbol):
             raise TypeError(f"Argument should be of type 'Symbol' but "
                             f"found '{type(symbol_in).__name__}'.")
         self._interface = symbol_in.interface
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ find_symbol_table()

def psyclone.psyir.symbols.symbol.Symbol.find_symbol_table	(	self,
		node
	)

Searches back up the PSyIR tree for the SymbolTable that contains
this Symbol.

:param node: the PSyIR node from which to search.
:type node: :py:class:`psyclone.psyir.nodes.Node`

:returns: the SymbolTable containing this Symbol or None.
:rtype: :py:class:`psyclone.psyir.symbols.SymbolTable` or NoneType

:raises TypeError: if the supplied `node` argument is not a PSyIR Node.

Definition at line 384 of file symbol.py.

     def find_symbol_table(self, node):
         '''
         Searches back up the PSyIR tree for the SymbolTable that contains
         this Symbol.
  
         :param node: the PSyIR node from which to search.
         :type node: :py:class:`psyclone.psyir.nodes.Node`
  
         :returns: the SymbolTable containing this Symbol or None.
         :rtype: :py:class:`psyclone.psyir.symbols.SymbolTable` or NoneType
  
         :raises TypeError: if the supplied `node` argument is not a PSyIR Node.
  
         '''
         # This import has to be local to this method to avoid circular
         # dependencies.
         # pylint: disable=import-outside-toplevel
         from psyclone.psyir.nodes import Node
         if not isinstance(node, Node):
             raise TypeError(
                 f"find_symbol_table: expected to be passed an instance of "
                 f"psyir.nodes.Node but got '{type(node).__name__}'")
  
         try:
             current = node.scope.symbol_table
             while current:
                 if self.name in current:
                     return current
                 if current.node.parent:
                     current = current.node.parent.scope.symbol_table
                 else:
                     # We can't go any further up the hierarchy and we haven't
                     # found a SymbolTable that contains this symbol.
                     return None
         except SymbolError:
             # Failed to find any enclosing symbol table
             return None
  

Here is the call graph for this function:

◆ get_external_symbol()

def psyclone.psyir.symbols.symbol.Symbol.get_external_symbol ( self )

Looks-up and returns the Symbol referred to by this Symbol's
Import Interface.

:raises SymbolError: if the module pointed to by the symbol interface \
                     does not contain the symbol (or the symbol is \
                     not public).
:raises NotImplementedError: if this symbol does not have an \
                             ImportInterface.

Definition at line 197 of file symbol.py.

     def get_external_symbol(self):
         '''
         Looks-up and returns the Symbol referred to by this Symbol's
         Import Interface.
  
         :raises SymbolError: if the module pointed to by the symbol interface \
                              does not contain the symbol (or the symbol is \
                              not public).
         :raises NotImplementedError: if this symbol does not have an \
                                      ImportInterface.
         '''
         if not self.is_import:
             raise NotImplementedError(
                 f"Error trying to resolve symbol '{self.name}' properties, "
                 f"the lazy evaluation of '{self.interface}' interfaces is "
                 f"not supported.")
  
         module = self.interface.container_symbol
         try:
             return module.container.symbol_table.lookup(
                 self.name, visibility=self.Visibility.PUBLIC)
         except KeyError as kerr:
             raise SymbolError(
                 f"Error trying to resolve the properties of symbol "
                 f"'{self.name}'. The interface points to module "
                 f"'{module.name}' but could not find the definition of "
                 f"'{self.name}' in that module.") from kerr
         except SymbolError as err:
             raise SymbolError(
               f"Error trying to resolve the properties of symbol "
               f"'{self.name}' in module '{module.name}': {err.value}") from err
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interface() [1/2]

def psyclone.psyir.symbols.symbol.Symbol.interface ( self )

:returns: the an object describing the interface to this Symbol.
:rtype: Sub-class of \
    :py:class:`psyclone.psyir.symbols.symbol.SymbolInterface`

Definition at line 286 of file symbol.py.

     def interface(self):
         '''
         :returns: the an object describing the interface to this Symbol.
         :rtype: Sub-class of \
             :py:class:`psyclone.psyir.symbols.symbol.SymbolInterface`
         '''
         return self._interface
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ interface() [2/2]

def psyclone.psyir.symbols.symbol.Symbol.interface	(	self,
		value
	)

Setter for the Interface associated with this Symbol.

:param value: an Interface object describing how the Symbol is \
              accessed.
:type value: Sub-class of \
    :py:class:`psyclone.psyir.symbols.symbol.SymbolInterface`

:raises TypeError: if the supplied `value` is of the wrong type.

Definition at line 295 of file symbol.py.

     def interface(self, value):
         '''
         Setter for the Interface associated with this Symbol.
  
         :param value: an Interface object describing how the Symbol is \
                       accessed.
         :type value: Sub-class of \
             :py:class:`psyclone.psyir.symbols.symbol.SymbolInterface`
  
         :raises TypeError: if the supplied `value` is of the wrong type.
         '''
         if not isinstance(value, SymbolInterface):
             raise TypeError(f"The interface to a Symbol must be a "
                             f"SymbolInterface but got "
                             f"'{type(value).__name__}'")
         self._interface = value
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ is_argument()

def psyclone.psyir.symbols.symbol.Symbol.is_argument ( self )

:returns: whether the Symbol has an ArgumentInterface.
:rtype: bool

Definition at line 340 of file symbol.py.

     def is_argument(self):
         '''
         :returns: whether the Symbol has an ArgumentInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, ArgumentInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ is_array()

def psyclone.psyir.symbols.symbol.Symbol.is_array ( self )

:returns: True if this symbol is an array and False if it is not or
    there is not enough symbol information to determine it.
:rtype: bool

Reimplemented in psyclone.psyir.symbols.typed_symbol.TypedSymbol.

Definition at line 426 of file symbol.py.

     def is_array(self):
         '''
         :returns: True if this symbol is an array and False if it is not or
             there is not enough symbol information to determine it.
         :rtype: bool
  
         '''
         return False
  

Here is the caller graph for this function:

◆ is_array_access()

def psyclone.psyir.symbols.symbol.Symbol.is_array_access	(	self,
		index_variable = `None`,
		access_info = `None`
	)

This method detects if a variable is used as an array or not.
If available, it will use the access information, i.e. how the
variable is used (e.g. if it has indices somewhere, like `a(i)%b`).
This can be incorrect in case of implicit loops (e.g. `a=b+1`,
where `a` and `b` are arrays) where the variable usage information
will not have information about indices. In this case this function
will fallback to querying the symbol itself.

This can cause significant slowdown if this symbol is imported
from a module, since then these modules need to be parsed.
# TODO #1213: Parsing modules is not yet supported.

If a `loop_variable` is specified, a variable access will only be
considered an array access if the specified variable is used in
at least one of the indices. For example:
>>> do i=1, n
>>>     a(j) = 2

the access to `a` is not considered an array if `loop_variable` is
set to `i`. If `loop_variable` is specified, `access_information`
must be specified.

:param str index_variable: optional loop variable that is used to \
    to determine if an access is an array access using this variable.
:param access_info: variable access information, optional.
:type access_info: \
    :py:class:`psyclone.core.SingleVariableAccessInfo`

:returns: if the variable is an array.
:rtype bool:

:raises InternalError: if a loop_variable is specified, but no \
    access information is given.

Definition at line 435 of file symbol.py.

     def is_array_access(self, index_variable=None, access_info=None):
         '''This method detects if a variable is used as an array or not.
         If available, it will use the access information, i.e. how the
         variable is used (e.g. if it has indices somewhere, like `a(i)%b`).
         This can be incorrect in case of implicit loops (e.g. `a=b+1`,
         where `a` and `b` are arrays) where the variable usage information
         will not have information about indices. In this case this function
         will fallback to querying the symbol itself.
  
         This can cause significant slowdown if this symbol is imported
         from a module, since then these modules need to be parsed.
         # TODO #1213: Parsing modules is not yet supported.
  
         If a `loop_variable` is specified, a variable access will only be
         considered an array access if the specified variable is used in
         at least one of the indices. For example:
         >>> do i=1, n
         >>>     a(j) = 2
  
         the access to `a` is not considered an array if `loop_variable` is
         set to `i`. If `loop_variable` is specified, `access_information`
         must be specified.
  
         :param str index_variable: optional loop variable that is used to \
             to determine if an access is an array access using this variable.
         :param access_info: variable access information, optional.
         :type access_info: \
             :py:class:`psyclone.core.SingleVariableAccessInfo`
  
         :returns: if the variable is an array.
         :rtype bool:
  
         :raises InternalError: if a loop_variable is specified, but no \
             access information is given.
  
         '''
         # TODO #1270: this function might either be better off elsewhere,
         # or even do not implement one function that uses both access
         # information and symbol table - if required, the user can
         # query both in two simple statements anyway.
         if index_variable and not access_info:
             raise InternalError(f"In Symbol.is_array_access: index variable "
                                 f"'{index_variable}' specified, but no access "
                                 f"information given.")
  
         # TODO #1244: If as a result of 1244 we have more reliable
         # information in the symbol table, the implementation here might
         # be changed.
  
         # Prioritise access information, since this can take the index
         # variable into account, and avoids potentially parsing other
         # modules to find type information.
         if access_info:
             # Access Info might not have information if a variable is used
             # as array (e.g. in case of an array expression). In this case
             # we still need to check the type information in the symbol table.
             is_array = access_info.is_array(index_variable=index_variable)
  
             # Access information might indicate that a variable is not an
             # array if it is used in array expressions only. In order to
             # verify, we need to check the symbol type information. But
             # if an index variable is specified, an array used in an array
             # expression without the index variable is not considered to
             # be an array access, since it is independent of the loop
             # variable. In this case also return the value from `is_array`.
             if is_array or index_variable is not None:
                 return is_array
  
         # Either we don't have access information, or the access information
         # does not indicate an array. In the latter case we still need to
         # test the symbol table, since the variable might be used in array
         # expressions only. Note that we cannot check for index variable usage
         # in this case.
         # TODO #1213: check for wildcard imports
         return self.is_array

References psyclone.core.component_indices.ComponentIndices.is_array(), psyclone.core.single_variable_access_info.AccessInfo.is_array(), psyclone.psyir.nodes.array_mixin.ArrayMixin.is_array(), psyclone.psyir.nodes.member.Member.is_array(), psyclone.psyir.nodes.reference.Reference.is_array(), psyclone.psyir.symbols.symbol.Symbol.is_array(), psyclone.psyir.symbols.typed_symbol.TypedSymbol.is_array(), and psyclone.core.single_variable_access_info.SingleVariableAccessInfo.is_array().

Here is the call graph for this function:

◆ is_automatic()

def psyclone.psyir.symbols.symbol.Symbol.is_automatic ( self )

:returns: whether the Symbol has an AutomaticInterface.
:rtype: bool

Definition at line 313 of file symbol.py.

     def is_automatic(self):
         '''
         :returns: whether the Symbol has an AutomaticInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, AutomaticInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

◆ is_commonblock()

def psyclone.psyir.symbols.symbol.Symbol.is_commonblock ( self )

:returns: whether the Symbol has a CommonBlockInterface.
:rtype: bool

Definition at line 349 of file symbol.py.

     def is_commonblock(self):
         '''
         :returns: whether the Symbol has a CommonBlockInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, CommonBlockInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

◆ is_import()

def psyclone.psyir.symbols.symbol.Symbol.is_import ( self )

:returns: whether the Symbol has an ImportInterface.
:rtype: bool

Definition at line 331 of file symbol.py.

     def is_import(self):
         '''
         :returns: whether the Symbol has an ImportInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, ImportInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ is_modulevar()

def psyclone.psyir.symbols.symbol.Symbol.is_modulevar ( self )

:returns: whether the Symbol has a DefaultModuleInterface.
:rtype: bool

Definition at line 322 of file symbol.py.

     def is_modulevar(self):
         '''
         :returns: whether the Symbol has a DefaultModuleInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, DefaultModuleInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

◆ is_static()

def psyclone.psyir.symbols.symbol.Symbol.is_static ( self )

:returns: whether the Symbol has a StaticInterface.
:rtype: bool

Definition at line 358 of file symbol.py.

     def is_static(self):
         '''
         :returns: whether the Symbol has a StaticInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, StaticInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

◆ is_unknown_interface()

def psyclone.psyir.symbols.symbol.Symbol.is_unknown_interface ( self )

:returns: whether the Symbol has an UnknownInterface.
:rtype: bool

Definition at line 376 of file symbol.py.

     def is_unknown_interface(self):
         '''
         :returns: whether the Symbol has an UnknownInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, UnknownInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

◆ is_unresolved()

def psyclone.psyir.symbols.symbol.Symbol.is_unresolved ( self )

:returns: whether the Symbol has an UnresolvedInterface.
:rtype: bool

Definition at line 367 of file symbol.py.

     def is_unresolved(self):
         '''
         :returns: whether the Symbol has an UnresolvedInterface.
         :rtype: bool
  
         '''
         return isinstance(self._interface, UnresolvedInterface)
  

References psyclone.psyir.symbols.symbol.Symbol._interface.

Here is the caller graph for this function:

◆ name()

def psyclone.psyir.symbols.symbol.Symbol.name ( self )

:returns: name of the Symbol.
:rtype: str

Definition at line 255 of file symbol.py.

     def name(self):
         '''
         :returns: name of the Symbol.
         :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_type()

def psyclone.psyir.symbols.symbol.Symbol.resolve_type ( self )

Update the properties of this Symbol by using the definition imported
from the external Container. If this symbol does not have an
ImportInterface then there is no lookup needed and we just return this
symbol.

:returns: a symbol object with the class and type determined by
          examining the Container from which it is imported.
:rtype: subclass of :py:class:`psyclone.psyir.symbols.Symbol`

Reimplemented in psyclone.psyir.symbols.typed_symbol.TypedSymbol.

Definition at line 229 of file symbol.py.

     def resolve_type(self):
         '''
         Update the properties of this Symbol by using the definition imported
         from the external Container. If this symbol does not have an
         ImportInterface then there is no lookup needed and we just return this
         symbol.
  
         :returns: a symbol object with the class and type determined by
                   examining the Container from which it is imported.
         :rtype: subclass of :py:class:`psyclone.psyir.symbols.Symbol`
  
         '''
         if self.is_import:
             extern_symbol = self.get_external_symbol()
             init_value = None
             if extern_symbol.initial_value:
                 init_value = extern_symbol.initial_value.copy()
             # Specialise the existing Symbol in-place so that all References
             # to it remain valid.
             self.specialise(type(extern_symbol),
                             datatype=extern_symbol.datatype,
                             is_constant=extern_symbol.is_constant,
                             initial_value=init_value)
         return self
  

References psyclone.psyir.symbols.symbol.Symbol.get_external_symbol(), psyclone.psyir.symbols.symbol.Symbol.is_import(), and psyclone.psyir.symbols.symbol.Symbol.specialise().

Here is the call graph for this function:

◆ specialise()

def psyclone.psyir.symbols.symbol.Symbol.specialise	(		self,
			subclass,
		**	kwargs
	)

Specialise this symbol so that it becomes an instance of the class
provided in the subclass argument. This allows this instance
to become a subclass without any references to it becoming
invalid.

:param subclass: the class that this symbol will become.
:type subclass: type of sub-class of \
    :py:class:`psyclone.psyir.symbols.Symbol`

:raises TypeError: if subclass is not a sub-class of Symbol.

Definition at line 167 of file symbol.py.

     def specialise(self, subclass, **kwargs):
         '''Specialise this symbol so that it becomes an instance of the class
         provided in the subclass argument. This allows this instance
         to become a subclass without any references to it becoming
         invalid.
  
         :param subclass: the class that this symbol will become.
         :type subclass: type of sub-class of \
             :py:class:`psyclone.psyir.symbols.Symbol`
  
         :raises TypeError: if subclass is not a sub-class of Symbol.
  
         '''
         try:
             is_subclass = issubclass(subclass, self.__class__)
         except TypeError as info:
             raise TypeError(
                 f"The specialise method in '{self.name}' expects the "
                 f"subclass argument to be a class.") from info
         # pylint: disable = unidiomatic-typecheck
         if not is_subclass or type(self) is subclass:
             raise TypeError(
                 f"The specialise method in '{self.name}', an instance of "
                 f"'{type(self).__name__}', expects the subclass argument to "
                 f"be a subclass of '{type(self).__name__}', but found "
                 f"'{subclass.__name__}'.")
         self.__class__ = subclass
         self._process_arguments(**kwargs)
  

References psyclone.psyir.symbols.symbol.Symbol.__class__, psyclone.psyir.symbols.containersymbol.ContainerSymbol._process_arguments(), psyclone.psyir.symbols.datasymbol.DataSymbol._process_arguments(), psyclone.psyir.symbols.routinesymbol.RoutineSymbol._process_arguments(), psyclone.psyir.symbols.typed_symbol.TypedSymbol._process_arguments(), and psyclone.psyir.symbols.symbol.Symbol._process_arguments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ visibility() [1/2]

def psyclone.psyir.symbols.symbol.Symbol.visibility ( self )

:returns: the visibility of this Symbol.
:rtype: :py:class:`psyclone.psyir.symbol.Symbol.Visibility`

Definition at line 263 of file symbol.py.

     def visibility(self):
         '''
         :returns: the visibility of this Symbol.
         :rtype: :py:class:`psyclone.psyir.symbol.Symbol.Visibility`
         '''
         return self._visibility
  

References psyclone.psyir.symbols.symbol.Symbol._visibility.

Here is the caller graph for this function:

◆ visibility() [2/2]

def psyclone.psyir.symbols.symbol.Symbol.visibility	(	self,
		value
	)

Setter for the visibility attribute.

:raises TypeError: if the supplied value is not an instance of \
                   Symbol.Visibility.

Definition at line 271 of file symbol.py.

     def visibility(self, value):
         '''
         Setter for the visibility attribute.
  
         :raises TypeError: if the supplied value is not an instance of \
                            Symbol.Visibility.
         '''
         if not isinstance(value, Symbol.Visibility):
             raise TypeError(
                 f"{type(self).__name__} 'visibility' attribute should be of "
                 f"type psyir.symbols.Symbol.Visibility but got "
                 f"'{type(value).__name__}'.")
         self._visibility = value
  

References psyclone.psyir.symbols.symbol.Symbol._visibility.

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/symbol.py

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ copy()

◆ copy_properties()

◆ find_symbol_table()

◆ get_external_symbol()

◆ interface() [1/2]

◆ interface() [2/2]

◆ is_argument()

◆ is_array()

◆ is_array_access()

◆ is_automatic()

◆ is_commonblock()

◆ is_import()

◆ is_modulevar()

◆ is_static()

◆ is_unknown_interface()

◆ is_unresolved()

◆ name()

◆ resolve_type()

◆ specialise()

◆ visibility() [1/2]

◆ visibility() [2/2]