system

Classes:

• AssertStmt –
• Cast –
• PrintExpr –

AssertStmt

AssertStmt(
    condition: Expr,
    message: Expr | None = None,
    loc: SourceLocation = NO_SOURCE_LOCATION,
    parent: ASTNodes[AST] | None = None,
)

Bases: StatementType

Represent one fatal assertion statement with an optional failure message. attributes: condition: type: astx.Expr message: type: astx.Expr | None loc: type: astx.SourceLocation

Methods:

• get_struct –
• to_json –
• to_yaml –

Source code in packages/irx/src/irx/astx/system.py

def __init__(
    self,
    condition: astx.Expr,
    message: astx.Expr | None = None,
    loc: astx.SourceLocation = astx.base.NO_SOURCE_LOCATION,
    parent: astx.ASTNodes[astx.AST] | None = None,
) -> None:
    """
    title: Initialize AssertStmt.
    parameters:
      condition:
        type: astx.Expr
      message:
        type: astx.Expr | None
      loc:
        type: astx.SourceLocation
      parent:
        type: astx.ASTNodes[astx.AST] | None
    """
    super().__init__(loc=loc, parent=parent)
    self.loc: astx.SourceLocation = loc
    self.condition: astx.Expr = condition
    self.message: astx.Expr | None = message

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in packages/irx/src/irx/astx/system.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the AST structure of the assertion statement.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"ASSERT[{id(self)}]" if simplified else "ASSERT"
    value: astx.base.DictDataTypesStruct = {
        "condition": self.condition.get_struct(simplified),
    }
    if self.message is not None:
        value["message"] = self.message.get_struct(simplified)
    return self._prepare_struct(key, value, simplified)

to_json

to_json(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_json(self, simplified: bool = False) -> str:
    """
    title: Return an json string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return json.dumps(self.get_struct(simplified=simplified), indent=2)

to_yaml

to_yaml(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_yaml(self, simplified: bool = False) -> str:
    """
    title: Return an yaml string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return str(
        yaml.dump(self.get_struct(simplified=simplified), sort_keys=False)
    )

Cast

Cast(value: DataType, target_type: Any)

Bases: DataType

Methods:

• get_struct –
• to_json –
• to_yaml –

Source code in packages/irx/src/irx/astx/system.py

def __init__(self, value: astx.DataType, target_type: Any) -> None:
    """
    title: Initialize Cast.
    parameters:
      value:
        type: astx.DataType
      target_type:
        type: Any
    """
    super().__init__()
    self.value = value
    self.target_type = target_type

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in packages/irx/src/irx/astx/system.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation of the cast expression.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"Cast[{self.target_type}]"
    value = self.value.get_struct(simplified)
    return self._prepare_struct(key, value, simplified)

to_json

to_json(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_json(self, simplified: bool = False) -> str:
    """
    title: Return an json string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return json.dumps(self.get_struct(simplified=simplified), indent=2)

to_yaml

to_yaml(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_yaml(self, simplified: bool = False) -> str:
    """
    title: Return an yaml string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return str(
        yaml.dump(self.get_struct(simplified=simplified), sort_keys=False)
    )

PrintExpr

PrintExpr(message: Expr)

Bases: Expr

It would be nice to support more arguments similar to the ones supported by Python (*args, sep=' ', end='', file=None, flush=False).

Methods:

• get_struct –
• to_json –
• to_yaml –

Source code in packages/irx/src/irx/astx/system.py

def __init__(self, message: astx.Expr) -> None:
    """
    title: Initialize the PrintExpr.
    parameters:
      message:
        type: astx.Expr
    """
    super().__init__()
    self.message = message
    self._name = f"print_msg_{next(PrintExpr._counter)}"

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in packages/irx/src/irx/astx/system.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the AST structure of the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"FunctionCall[{self}]"
    value = self.message.get_struct(simplified)
    return self._prepare_struct(key, value, simplified)

to_json

to_json(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_json(self, simplified: bool = False) -> str:
    """
    title: Return an json string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return json.dumps(self.get_struct(simplified=simplified), indent=2)

to_yaml

to_yaml(simplified: bool = False) -> str

Source code in packages/astx/src/astx/base.py

def to_yaml(self, simplified: bool = False) -> str:
    """
    title: Return an yaml string that represents the object.
    parameters:
      simplified:
        type: bool
    returns:
      type: str
    """
    return str(
        yaml.dump(self.get_struct(simplified=simplified), sort_keys=False)
    )