Class Capsule

mypyc/ir/deps.py:6–42

Defines a C extension capsule that a primitive may require.

class Capsule:
    """Defines a C extension capsule that a primitive may require."""

    def __init__(self, name: str) -> None:
        # Module fullname, e.g. 'librt.base64'
        self.name: Final = name

    def __repr__(self) -> str:
        return f"Capsule(name={self.name!r})"

    def __eq__(self, other: object) -> bool:
        return isinstance(other, Capsule) and self.name == other.name

    def __hash__(self) -> int:
        return hash(("Capsule", self.name))

    def internal_dep(self) -> SourceDep:
        """Internal source dependency of the capsule that should only be included in the C extensions
        that depend on the capsule, eg. by importing a type or function from the capsule.
        """
        module = self.name.split(".")[-1]
        return SourceDep(f"{module}/librt_{module}_api.c", include_dirs=[module])

    def external_dep(self) -> HeaderDep:
        """External header dependency of the capsule that may be included in external headers of C
        extensions that depend on the capsule.

        The external headers of the C extensions are included by other C extensions that don't
        necessarily import the capsule. However, they may need type definitions from the capsule
        for types that are used in the exports table of the included C extensions.

        Only the external header should be included in this case because if the other C extension
        doesn't import the capsule, it also doesn't include the definition for its API table and
        including the internal header would result in undefined symbols.
        """
        module = self.name.split(".")[-1]
        return HeaderDep(f"{module}/librt_{module}.h", include_dirs=[module], internal=False)


class SourceDep: