acme.helpers.interpreter.Types.SSymbol

class documentation

class SSymbol(object):

Constructors: SSymbol.symbolFromValue(value), SSymbol(typ, parent)

View In Hierarchy

The basic class to store and handle symbols, lists, and values in the Interpreter.

Class Method	`symbolFromValue`	Create a new `SSymbol` object from a value.
Method	`__contains__`	Check whether an object is contained within the value.
Method	`__eq__`	Check whether two `SSymbol` objects are equal.
Method	`__getitem__`	Return an element or a slice from a list, or a character from a string.
Method	`__gt__`	Check whether the value is greater than another value.
Method	`__init__`	Initialization of a `SSymbol` object or one of its sub-classes.
Method	`__len__`	Return the length of the value.
Method	`__lt__`	Check whether the value is less than another value.
Method	`__repr__`	Nicely printable version of `value`.
Method	`__str__`	Nicely printable version of `value`.
Method	`printHierarchy`	Print the hierarchy in reverse order (parent first) with reversed indentation.
Method	`raw`	The Python "raw" value.
Method	`toString`	Return a string representation of the value.
Class Variable	`__slots__`	Slots of class attributes.
Instance Variable	`length`	The length of the symbol. Could be the length of a string, number of items in a list etc.
Instance Variable	`parent`	Parent `SSymbol` object.
Instance Variable	`type`	`SType` to indicate the type.
Instance Variable	`value`	The actual stored value. This is either one of the the basic data typs, of a `SSymbol`, list of `SSymbol`, dictionary, etc.

@classmethod

Create a new SSymbol object from a value.

Parameters
value:`bool \| str \| int \| float \| list \| dict`	A value that is then automatically assigned to one of the basic, quoted types.

Returns
`SSymbol`	A new `SSymbol` sub-class object.

def __contains__(self, obj: Any) -> bool: ¶

Check whether an object is contained within the value.

This works for characters and strings, and elements and lists.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is contained, False otherwise.

def __eq__(self, other: Any) -> bool: ¶

Check whether two SSymbol objects are equal.

Parameters
other:`Any`	The other object to compare.

Returns
`bool`	True if the two objects are equal, False otherwise.

def __getitem__(self, key: int | slice) -> Any: ¶

Return an element or a slice from a list, or a character from a string.

Parameters
key:`int \| slice`	Either an number or a slice.

Returns
`Any`	A single element or a sice of elements if `value` is a list, or a single or multiple characters if `value` is a string.

def __gt__(self, other: Any) -> bool: ¶

Check whether the value is greater than another value.

Parameters
other:`Any`	The other object to compare.

Returns
`bool`	True if the value is greater, False otherwise.

def __init__(self, typ: SType | None = None, parent: SSymbol | None = None): ¶

overridden in acme.helpers.interpreter.Types.SBooleanSymbol, acme.helpers.interpreter.Types.SJsonSymbol, acme.helpers.interpreter.Types.SLambdaSymbol, acme.helpers.interpreter.Types.SListCharSymbol, acme.helpers.interpreter.Types.SListQuoteSymbol, acme.helpers.interpreter.Types.SListSymbol, acme.helpers.interpreter.Types.SNilSymbol, acme.helpers.interpreter.Types.SNumberSymbol, acme.helpers.interpreter.Types.SStringSymbol, acme.helpers.interpreter.Types.SSymbolQuoteSymbol, acme.helpers.interpreter.Types.SSymbolSymbol, acme.helpers.interpreter.Types.STSymbol

Initialization of a SSymbol object or one of its sub-classes.

Only one of the arguments must be passed to the function. If no argument is given, then the symbol becomes a NIL object.

Parameters
typ:`SType \| None`	Type of the symbol.
parent:`SSymbol \| None`	Parent `SSymbol` object.

def __len__(self) -> int: ¶

Return the length of the value.

Returns
`int`	Length of the value.

def __lt__(self, other: Any) -> bool: ¶

Check whether the value is less than another value.

Parameters
other:`Any`	The other object to compare.

Returns
`bool`	True if the value is less, False otherwise.

def __repr__(self) -> str: ¶

Nicely printable version of value.

Returns
`str`	String representation.

def __str__(self) -> str: ¶

Nicely printable version of value.

Returns
`str`	String representation.

def printHierarchy(self, depth: int = 0, max_depth: int = None) -> str: ¶

Print the hierarchy in reverse order (parent first) with reversed indentation.

Parameters
depth:`int`	Current depth level.
max_depth:`int`	Maximum depth level.

Returns
`str`	Parent hierarchy as a string.

def raw(self) -> Any: ¶

The Python "raw" value.

Returns
`Any`	The raw value. For types that could not be converted directly the stringified version is returned.

def toString(self, quoteStrings: bool = False, pythonList: bool = False) -> str: ¶

overridden in acme.helpers.interpreter.Types.SBooleanSymbol, acme.helpers.interpreter.Types.SJsonSymbol, acme.helpers.interpreter.Types.SLambdaSymbol, acme.helpers.interpreter.Types.SListQuoteSymbol, acme.helpers.interpreter.Types.SListSymbol, acme.helpers.interpreter.Types.SNilSymbol, acme.helpers.interpreter.Types.SStringSymbol, acme.helpers.interpreter.Types.SSymbolQuoteSymbol, acme.helpers.interpreter.Types.STSymbol

Return a string representation of the value.

Parameters
quoteStrings:`bool`	Quote strings.
pythonList:`bool`	Return a Python list representation.

Returns
`str`	A string representation of the value.

__slots__: tuple[str, ...] = ¶

Slots of class attributes.

length: int = ¶

The length of the symbol. Could be the length of a string, number of items in a list etc.

parent: SSymbol | None = ¶

Parent SSymbol object.

type: SType = ¶

overridden in acme.helpers.interpreter.Types.SListCharSymbol

SType to indicate the type.

The actual stored value. This is either one of the the basic data typs, of a SSymbol, list of SSymbol, dictionary, etc.