Skip to content

Lupa stubs: #14359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Lupa stubs: #14359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ee576f
Lupa stubs:
jmarianer Jul 1, 2025
98fac21
oof
jmarianer Jul 2, 2025
a7a85ba
oops
jmarianer Jul 2, 2025
d2365fc
missed file
jmarianer Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions stubs/lupa/@tests/stubtest_allowlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# These are type aliases and not real objects
lupa.lua51.LuaKey
lupa.lua51.LuaObject
lupa.lua52.LuaKey
lupa.lua52.LuaObject
lupa.lua53.LuaKey
lupa.lua53.LuaObject
lupa.lua54.LuaKey
lupa.lua54.LuaObject
22 changes: 12 additions & 10 deletions stubs/lupa/lupa/lua51.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from _typeshed import MaybeNone
from collections.abc import Callable, Iterator
from collections.abc import Callable, Iterable
from typing import Any, Final, Generic, TypeVar, type_check_only
from typing_extensions import TypeAlias

__all__ = [
"LUA_VERSION",
Expand Down Expand Up @@ -34,15 +35,17 @@ unpacks_lua_table_method: Callable[[Callable[..., Any]], Callable[..., Any]]

# inner classes

@type_check_only
class _LuaIter:
def __iter__(self) -> Iterator[object]: ...

@type_check_only
class _LuaTable:
def keys(self) -> _LuaIter: ...
def values(self) -> _LuaIter: ...
def items(self) -> _LuaIter: ...
def keys(self) -> Iterable[LuaKey]: ...
def values(self) -> Iterable[LuaObject]: ...
def items(self) -> Iterable[tuple[LuaKey, LuaObject]]: ...
def __getitem__(self, key: LuaKey) -> LuaObject: ...
def __setitem__(self, key: LuaKey, value: LuaObject) -> None: ...
def __delitem__(self, key: LuaKey) -> None: ...

LuaKey: TypeAlias = str | int
LuaObject: TypeAlias = _LuaTable | int | str | float | bool | None
Comment on lines +47 to +48
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand, these are not available at runtime, so we need to preface them with an underscore.

You could also consider adding a lupa._types modules where you define these type-check only items and just import them, but that's just an option.


@type_check_only
class _LuaNoGC: ...
Expand Down Expand Up @@ -70,8 +73,7 @@ class LuaRuntime:
lua_implementation: Final[str]
lua_version: Final[tuple[int, int]]

# @classmethod
# def __cinit__(cls, unpack_return_tuples: bool) -> None: ...
def __init__(self, /, unpack_returned_tuples: bool, *args: Any) -> None: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please note that we need a comment for each Any, explaining which types are allowed and/or how it's used.

# def add_pending_unref(self, ref: int) -> None: ...
# def clean_up_pending_unrefs(self) -> int: ...
def get_max_memory(self, total: bool = False) -> int | MaybeNone: ...
Expand Down
22 changes: 12 additions & 10 deletions stubs/lupa/lupa/lua52.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from _typeshed import MaybeNone
from collections.abc import Callable, Iterator
from collections.abc import Callable, Iterable
from typing import Any, Final, Generic, TypeVar, type_check_only
from typing_extensions import TypeAlias

__all__ = [
"LUA_VERSION",
Expand Down Expand Up @@ -34,15 +35,17 @@ unpacks_lua_table_method: Callable[[Callable[..., Any]], Callable[..., Any]]

# inner classes

@type_check_only
class _LuaIter:
def __iter__(self) -> Iterator[object]: ...

@type_check_only
class _LuaTable:
def keys(self) -> _LuaIter: ...
def values(self) -> _LuaIter: ...
def items(self) -> _LuaIter: ...
def keys(self) -> Iterable[LuaKey]: ...
def values(self) -> Iterable[LuaObject]: ...
def items(self) -> Iterable[tuple[LuaKey, LuaObject]]: ...
def __getitem__(self, key: LuaKey) -> LuaObject: ...
def __setitem__(self, key: LuaKey, value: LuaObject) -> None: ...
def __delitem__(self, key: LuaKey) -> None: ...

LuaKey: TypeAlias = str | int
LuaObject: TypeAlias = _LuaTable | int | str | float | bool | None

@type_check_only
class _LuaNoGC: ...
Expand Down Expand Up @@ -70,8 +73,7 @@ class LuaRuntime:
lua_implementation: Final[str]
lua_version: Final[tuple[int, int]]

# @classmethod
# def __cinit__(cls, unpack_return_tuples: bool) -> None: ...
def __init__(self, /, unpack_returned_tuples: bool, *args: Any) -> None: ...
# def add_pending_unref(self, ref: int) -> None: ...
# def clean_up_pending_unrefs(self) -> int: ...
def get_max_memory(self, total: bool = False) -> int | MaybeNone: ...
Expand Down
22 changes: 12 additions & 10 deletions stubs/lupa/lupa/lua53.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from _typeshed import MaybeNone
from collections.abc import Callable, Iterator
from collections.abc import Callable, Iterable
from typing import Any, Final, Generic, TypeVar, type_check_only
from typing_extensions import TypeAlias

__all__ = [
"LUA_VERSION",
Expand Down Expand Up @@ -34,15 +35,17 @@ unpacks_lua_table_method: Callable[[Callable[..., Any]], Callable[..., Any]]

# inner classes

@type_check_only
class _LuaIter:
def __iter__(self) -> Iterator[object]: ...

@type_check_only
class _LuaTable:
def keys(self) -> _LuaIter: ...
def values(self) -> _LuaIter: ...
def items(self) -> _LuaIter: ...
def keys(self) -> Iterable[LuaKey]: ...
def values(self) -> Iterable[LuaObject]: ...
def items(self) -> Iterable[tuple[LuaKey, LuaObject]]: ...
def __getitem__(self, key: LuaKey) -> LuaObject: ...
def __setitem__(self, key: LuaKey, value: LuaObject) -> None: ...
def __delitem__(self, key: LuaKey) -> None: ...

LuaKey: TypeAlias = str | int
LuaObject: TypeAlias = _LuaTable | int | str | float | bool | None

@type_check_only
class _LuaNoGC: ...
Expand Down Expand Up @@ -70,8 +73,7 @@ class LuaRuntime:
lua_implementation: Final[str]
lua_version: Final[tuple[int, int]]

# @classmethod
# def __cinit__(cls, unpack_return_tuples: bool) -> None: ...
def __init__(self, /, unpack_returned_tuples: bool, *args: Any) -> None: ...
# def add_pending_unref(self, ref: int) -> None: ...
# def clean_up_pending_unrefs(self) -> int: ...
def get_max_memory(self, total: bool = False) -> int | MaybeNone: ...
Expand Down
22 changes: 12 additions & 10 deletions stubs/lupa/lupa/lua54.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from _typeshed import MaybeNone
from collections.abc import Callable, Iterator
from collections.abc import Callable, Iterable
from typing import Any, Final, Generic, TypeVar, type_check_only
from typing_extensions import TypeAlias

__all__ = [
"LUA_VERSION",
Expand Down Expand Up @@ -34,15 +35,17 @@ unpacks_lua_table_method: Callable[[Callable[..., Any]], Callable[..., Any]]

# inner classes

@type_check_only
class _LuaIter:
def __iter__(self) -> Iterator[object]: ...

@type_check_only
class _LuaTable:
def keys(self) -> _LuaIter: ...
def values(self) -> _LuaIter: ...
def items(self) -> _LuaIter: ...
def keys(self) -> Iterable[LuaKey]: ...
def values(self) -> Iterable[LuaObject]: ...
def items(self) -> Iterable[tuple[LuaKey, LuaObject]]: ...
def __getitem__(self, key: LuaKey) -> LuaObject: ...
def __setitem__(self, key: LuaKey, value: LuaObject) -> None: ...
def __delitem__(self, key: LuaKey) -> None: ...

LuaKey: TypeAlias = str | int
LuaObject: TypeAlias = _LuaTable | int | str | float | bool | None

@type_check_only
class _LuaNoGC: ...
Expand Down Expand Up @@ -70,8 +73,7 @@ class LuaRuntime:
lua_implementation: Final[str]
lua_version: Final[tuple[int, int]]

# @classmethod
# def __cinit__(cls, unpack_return_tuples: bool) -> None: ...
def __init__(self, /, unpack_returned_tuples: bool, *args: Any) -> None: ...
# def add_pending_unref(self, ref: int) -> None: ...
# def clean_up_pending_unrefs(self) -> int: ...
def get_max_memory(self, total: bool = False) -> int | MaybeNone: ...
Expand Down