nested

Nested

Bases: PhysicsObject

A nested physics object

Source code in hml/physics_objects/nested.py

class Nested(PhysicsObject):
    """A nested physics object"""

    def __init__(
        self,
        main: PhysicsObject | str,
        sub: PhysicsObject | str,
    ) -> None:
        self._main = self._init_object(main)
        self._sub = self._init_object(sub)

    def _init_object(self, object_: PhysicsObject | str) -> PhysicsObject:
        if isinstance(object_, PhysicsObject):
            return object_

        elif is_single(object_):
            return Single.from_name(object_)

        else:
            return Collective.from_name(object_)

    @classmethod
    def from_name(cls, name: str) -> Nested:
        if "." in name:
            main, sub = name.split(".")
            return cls(main, sub)

        raise ValueError(f"Invalid name '{name}' for a nested physics object")

    @property
    def main(self) -> PhysicsObject:
        return self._main

    @property
    def sub(self) -> PhysicsObject:
        return self._sub

    @property
    def branch(self) -> str:
        return f"{self.main.branch}.{self.sub.branch}"

    @property
    def slices(self) -> list[slice]:
        return [*self.main.slices, *self.sub.slices]

    @property
    def name(self) -> str:
        return f"{self.main.name}.{self.sub.name}"

    @property
    def config(self) -> dict:
        return {"main": self.main.name, "sub": self.sub.name}

is_nested

is_nested(object_)

Check if an object is a nested physics object

Source code in hml/physics_objects/nested.py

def is_nested(object_: PhysicsObject | str) -> bool:
    """Check if an object is a nested physics object"""
    if isinstance(object_, PhysicsObject):
        return isinstance(object_, Nested)

    return bool(re.match(r"^[a-zA-Z]+\d*:?\d*\.[a-zA-Z]+\d*:?\d*$", object_))