classes

Provide explicit class-type references and class-definition nodes that host compilers can use before higher-level surface syntax exists in Arx.

Classes:

• BaseFieldAccess –
• BaseMethodCall –
• ClassConstruct –
• ClassDefStmt –
• ClassType –
• MethodCall –
• StaticFieldAccess –
• StaticMethodCall –

BaseFieldAccess

BaseFieldAccess(
    receiver: AST, base_class_name: str, field_name: str
)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    receiver: astx.AST,
    base_class_name: str,
    field_name: str,
) -> None:
    """
    title: Initialize one base-qualified field access expression.
    parameters:
      receiver:
        type: astx.AST
      base_class_name:
        type: str
      field_name:
        type: str
    """
    super().__init__()
    self.receiver = receiver
    self.base_class_name = base_class_name
    self.field_name = field_name
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a base-qualified field access.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"BASE-FIELD-ACCESS[{self.base_class_name}.{self.field_name}]"
    value = {
        "receiver": self.receiver.get_struct(simplified),
    }
    return self._prepare_struct(
        key,
        cast(astx.base.ReprStruct, value),
        simplified,
    )

BaseMethodCall

BaseMethodCall(
    receiver: AST,
    base_class_name: str,
    method_name: str,
    args: Iterable[DataType],
)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    receiver: astx.AST,
    base_class_name: str,
    method_name: str,
    args: Iterable[astx.DataType],
) -> None:
    """
    title: Initialize one base-qualified method call expression.
    parameters:
      receiver:
        type: astx.AST
      base_class_name:
        type: str
      method_name:
        type: str
      args:
        type: Iterable[astx.DataType]
    """
    super().__init__()
    self.receiver = receiver
    self.base_class_name = base_class_name
    self.method_name = method_name
    self.args = tuple(args)
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a base-qualified method call.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"BASE-METHOD-CALL[{self.base_class_name}.{self.method_name}]"
    arg_nodes = astx.ASTNodes[astx.DataType]("args")
    for arg in self.args:
        arg_nodes.append(arg)
    value = {
        "receiver": self.receiver.get_struct(simplified),
        "args": arg_nodes.get_struct(simplified),
    }
    return self._prepare_struct(
        key,
        cast(astx.base.ReprStruct, value),
        simplified,
    )

ClassConstruct

ClassConstruct(class_name: str)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    class_name: str,
) -> None:
    """
    title: Initialize one default class construction expression.
    parameters:
      class_name:
        type: str
    """
    super().__init__()
    self.class_name = class_name
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for class construction.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"CLASS-CONSTRUCT[{self.class_name}]"
    return self._prepare_struct(key, self.class_name, simplified)

ClassDefStmt

ClassDefStmt(
    name: str,
    *,
    bases: Iterable[ClassType] | ASTNodes[ClassType] = (),
    attributes: Iterable[VariableDeclaration]
    | ASTNodes[VariableDeclaration] = (),
    decorators: Iterable[Expr] | ASTNodes[Expr] = (),
    methods: Iterable[FunctionDef]
    | ASTNodes[FunctionDef] = (),
    visibility: VisibilityKind = public,
    loc: SourceLocation = NO_SOURCE_LOCATION,
    parent: ASTNodes[AST] | None = None,
)

Bases: StructDeclStmt

Represent one top-level class declaration with explicit base-class references and inherited struct-like member containers. attributes: bases: type: astx.ASTNodes[ClassType] kind: type: astx.ASTKind

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    name: str,
    *,
    bases: Iterable[ClassType] | astx.ASTNodes[ClassType] = (),
    attributes: (
        Iterable[astx.VariableDeclaration]
        | astx.ASTNodes[astx.VariableDeclaration]
    ) = (),
    decorators: Iterable[astx.Expr] | astx.ASTNodes[astx.Expr] = (),
    methods: Iterable[astx.FunctionDef]
    | astx.ASTNodes[astx.FunctionDef] = (),
    visibility: astx.VisibilityKind = astx.VisibilityKind.public,
    loc: astx.SourceLocation = astx.base.NO_SOURCE_LOCATION,
    parent: astx.ASTNodes[astx.AST] | None = None,
) -> None:
    """
    title: Initialize one class definition statement.
    parameters:
      name:
        type: str
      bases:
        type: Iterable[ClassType] | astx.ASTNodes[ClassType]
      attributes:
        type: >-
          Iterable[astx.VariableDeclaration] |
          astx.ASTNodes[astx.VariableDeclaration]
      decorators:
        type: Iterable[astx.Expr] | astx.ASTNodes[astx.Expr]
      methods:
        type: Iterable[astx.FunctionDef] | astx.ASTNodes[astx.FunctionDef]
      visibility:
        type: astx.VisibilityKind
      loc:
        type: astx.SourceLocation
      parent:
        type: astx.ASTNodes[astx.AST] | None
    """
    super().__init__(
        name=name,
        attributes=attributes,
        decorators=decorators,
        methods=methods,
        visibility=visibility,
        loc=loc,
        parent=parent,
    )
    if isinstance(bases, astx.ASTNodes):
        self.bases = bases
    else:
        self.bases = astx.ASTNodes[ClassType]()
        for base in bases:
            self.bases.append(base)
    self.kind = astx.ASTKind.StructDefStmtKind

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a class definition.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    vis = dict(zip(("public", "private", "protected"), ("+", "-", "#")))
    key = f"CLASS-DEF[{vis[self.visibility.name]}{self.name}]"

    bases_dict: astx.base.ReprStruct = {}
    if self.bases:
        bases_dict = {"bases": self.bases.get_struct(simplified)}

    decorators_dict: astx.base.ReprStruct = {}
    if self.decorators:
        decorators_dict = {
            "decorators": self.decorators.get_struct(simplified)
        }

    attrs_dict: astx.base.ReprStruct = {}
    if self.attributes:
        attrs_dict = {"attributes": self.attributes.get_struct(simplified)}

    methods_dict: astx.base.ReprStruct = {}
    if self.methods:
        methods_dict = {"methods": self.methods.get_struct(simplified)}

    value = {
        **cast(dict[str, astx.base.ReprStruct], bases_dict),
        **cast(dict[str, astx.base.ReprStruct], decorators_dict),
        **cast(dict[str, astx.base.ReprStruct], attrs_dict),
        **cast(dict[str, astx.base.ReprStruct], methods_dict),
    }
    return self._prepare_struct(
        key,
        cast(astx.base.ReprStruct, value),
        simplified,
    )

ClassType

ClassType(
    name: str,
    *,
    resolved_name: str | None = None,
    module_key: str | None = None,
    qualified_name: str | None = None,
    ancestor_qualified_names: tuple[str, ...] = (),
)

Bases: AnyType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    name: str,
    *,
    resolved_name: str | None = None,
    module_key: str | None = None,
    qualified_name: str | None = None,
    ancestor_qualified_names: tuple[str, ...] = (),
) -> None:
    """
    title: Initialize one named class type reference.
    parameters:
      name:
        type: str
      resolved_name:
        type: str | None
      module_key:
        type: str | None
      qualified_name:
        type: str | None
      ancestor_qualified_names:
        type: tuple[str, Ellipsis]
    """
    super().__init__()
    self.name = name
    self.resolved_name = resolved_name
    self.module_key = module_key
    self.qualified_name = qualified_name
    self.ancestor_qualified_names = ancestor_qualified_names

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a class type reference.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"CLASS-TYPE[{self.name}]"
    value = self.qualified_name or self.name
    return self._prepare_struct(key, value, simplified)

MethodCall

MethodCall(
    receiver: AST,
    method_name: str,
    args: Iterable[DataType],
)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    receiver: astx.AST,
    method_name: str,
    args: Iterable[astx.DataType],
) -> None:
    """
    title: Initialize one instance method call expression.
    parameters:
      receiver:
        type: astx.AST
      method_name:
        type: str
      args:
        type: Iterable[astx.DataType]
    """
    super().__init__()
    self.receiver = receiver
    self.method_name = method_name
    self.args = tuple(args)
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for an instance method call.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"METHOD-CALL[{self.method_name}]"
    arg_nodes = astx.ASTNodes[astx.DataType]("args")
    for arg in self.args:
        arg_nodes.append(arg)
    value = {
        "receiver": self.receiver.get_struct(simplified),
        "args": arg_nodes.get_struct(simplified),
    }
    return self._prepare_struct(
        key,
        cast(astx.base.ReprStruct, value),
        simplified,
    )

StaticFieldAccess

StaticFieldAccess(class_name: str, field_name: str)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    class_name: str,
    field_name: str,
) -> None:
    """
    title: Initialize one static field access expression.
    parameters:
      class_name:
        type: str
      field_name:
        type: str
    """
    super().__init__()
    self.class_name = class_name
    self.field_name = field_name
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a static field access.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"STATIC-FIELD-ACCESS[{self.class_name}.{self.field_name}]"
    return self._prepare_struct(
        key,
        f"{self.class_name}.{self.field_name}",
        simplified,
    )

StaticMethodCall

StaticMethodCall(
    class_name: str,
    method_name: str,
    args: Iterable[DataType],
)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/classes.py

def __init__(
    self,
    class_name: str,
    method_name: str,
    args: Iterable[astx.DataType],
) -> None:
    """
    title: Initialize one static method call expression.
    parameters:
      class_name:
        type: str
      method_name:
        type: str
      args:
        type: Iterable[astx.DataType]
    """
    super().__init__()
    self.class_name = class_name
    self.method_name = method_name
    self.args = tuple(args)
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/classes.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a static method call.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    key = f"STATIC-METHOD-CALL[{self.class_name}.{self.method_name}]"
    arg_nodes = astx.ASTNodes[astx.DataType]("args")
    for arg in self.args:
        arg_nodes.append(arg)
    value = {
        "args": arg_nodes.get_struct(simplified),
    }
    return self._prepare_struct(
        key,
        cast(astx.base.ReprStruct, value),
        simplified,
    )