modules

Classes:

• NamespaceKind –
• NamespaceType –

NamespaceKind

Bases: str, Enum

Distinguish the semantic origin of one namespace-valued binding while keeping the user-facing expression model uniform.

NamespaceType

NamespaceType(
    namespace_key: str,
    *,
    namespace_kind: NamespaceKind = MODULE,
    display_name: str | None = None,
)

Bases: AnyType

Represent one imported namespace value during semantic analysis and lowering without modeling it as a user-defined runtime aggregate. attributes: namespace_key: type: str namespace_kind: type: NamespaceKind display_name: type: str | None

Methods:

• get_struct –
• to_json –
• to_yaml –

Attributes:

• module_key (str) –

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

def __init__(
    self,
    namespace_key: str,
    *,
    namespace_kind: NamespaceKind = NamespaceKind.MODULE,
    display_name: str | None = None,
) -> None:
    """
    title: Initialize one namespace type.
    parameters:
      namespace_key:
        type: str
      namespace_kind:
        type: NamespaceKind
      display_name:
        type: str | None
    """
    super().__init__()
    self.namespace_key = namespace_key
    self.namespace_kind = namespace_kind
    self.display_name = display_name

module_key property

module_key: str

get_struct

get_struct(simplified: bool = False) -> ReprStruct

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

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for a namespace type.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    visible_name = self.display_name or self.namespace_key
    key = f"NAMESPACE[{self.namespace_kind.value}:{visible_name}]"
    return self._prepare_struct(key, visible_name, 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)
    )