context_manager

Classes:

• WithItem –
• WithStmt –

WithItem

WithItem(
    context_expr: Expr,
    instance_name: Optional[Identifier] = None,
)

Methods:

• get_struct –

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

def __init__(
    self, context_expr: Expr, instance_name: Optional[Identifier] = None
) -> None:
    """
    title: Initialize a WithItem instance.
    parameters:
      context_expr:
        type: Expr
      instance_name:
        type: Optional[Identifier]
    """
    self.context_expr = context_expr
    self.instance_name = instance_name

get_struct

get_struct(
    simplified: bool = False,
) -> dict[str, DataTypesStruct]

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

def get_struct(
    self, simplified: bool = False
) -> dict[str, DataTypesStruct]:
    """
    title: Get structural representation of the WithItem.
    parameters:
      simplified:
        type: bool
    returns:
      type: dict[str, DataTypesStruct]
    """
    key = (
        "CONTEXT"
        if not self.instance_name
        else f"CONTEXT[{self.context_expr!s}]"
    )
    value = cast(DataTypesStruct, self.context_expr.get_struct(simplified))
    return self._prepare_struct(key, value, simplified)

WithStmt

WithStmt(
    items: list[WithItem],
    body: Block,
    loc: SourceLocation = NO_SOURCE_LOCATION,
    parent: Optional[ASTNodes] = None,
)

Bases: StatementType

Methods:

• get_struct –
• to_json –
• to_yaml –

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

def __init__(
    self,
    items: list[WithItem],
    body: Block,
    loc: SourceLocation = NO_SOURCE_LOCATION,
    parent: Optional[ASTNodes] = None,
) -> None:
    """
    title: Initialize WithStmt instance.
    parameters:
      items:
        type: list[WithItem]
      body:
        type: Block
      loc:
        type: SourceLocation
      parent:
        type: Optional[ASTNodes]
    """
    super().__init__(loc=loc, parent=parent)
    self.items = items
    self.body = body
    self.kind = ASTKind.WithStmtKind

get_struct

get_struct(simplified: bool = False) -> ReprStruct

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

def get_struct(self, simplified: bool = False) -> ReprStruct:
    """
    title: Get structural representation of the WithStmt.
    parameters:
      simplified:
        type: bool
    returns:
      type: ReprStruct
    """
    items_structs: list[dict[str, DataTypesStruct]] = [
        item.get_struct(simplified) for item in self.items
    ]

    return cast(
        ReprStruct,
        {
            "WITH-STMT": {
                "items": items_structs,
                "body": self.body.get_struct(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)
    )