Source code for guppylang.std.lang

"""Provides Python objects for builtin language keywords."""

from collections.abc import Generator
from typing import Any, Protocol, TypeVar

from guppylang_internals.error import GuppyComptimeError

T = TypeVar("T")

_MODIFIER_COMPTIME_ERROR = (
    "The `{modifier}` modifier is not supported in comptime functions"
)


class _Comptime:
    """Dummy class to support `@comptime` annotations and `comptime(...)` expressions"""

    def __call__(self, v: T) -> T:
        return v

    def __rmatmul__(self, other: Any) -> Any:
        # This method is to make the Python interpreter happy with @comptime at runtime
        return other


#: Function to tag compile-time evaluated Python expressions in a Guppy context.
#:
#: This function acts like the identity when execute in a Python context.
comptime = _Comptime()


#: Alias for `comptime` expressions
py = comptime


class _Owned:
    """Dummy class to support `@owned` annotations."""

    def __rmatmul__(self, other: Any) -> Any:
        return other


owned = _Owned()



[docs]
class Copy(Protocol):
    """Bound to mark generic type parameters as being implicitly copyable."""




[docs]
class Drop(Protocol):
    """Bound to mark generic type parameters as being implicitly droppable."""




[docs]
def control(*args: Any, **kwargs: Any) -> Generator[None]:
    """Dummy function to support `with control(...):` blocks in Guppy code."""
    raise GuppyComptimeError(_MODIFIER_COMPTIME_ERROR.format(modifier="control"))




[docs]
def dagger(*args: Any, **kwargs: Any) -> Generator[None]:
    """Dummy function to support `with dagger(...):` blocks in Guppy code."""
    raise GuppyComptimeError(_MODIFIER_COMPTIME_ERROR.format(modifier="dagger"))




[docs]
def power(*args: Any, **kwargs: Any) -> Generator[None]:
    """Dummy function to support `with power(...):` blocks in Guppy code."""
    raise GuppyComptimeError(_MODIFIER_COMPTIME_ERROR.format(modifier="power"))