Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions pyrightconfig.stricter.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
"stubs/pexpect",
"stubs/pika",
"stubs/pony",
"stubs/portage/portage/package/ebuild/config.pyi",
"stubs/portage/portage/package/ebuild/doebuild.pyi",
"stubs/portage/portage/versions.pyi",
"stubs/protobuf",
"stubs/psutil/psutil/__init__.pyi",
"stubs/psycopg2",
Expand Down
6 changes: 6 additions & 0 deletions stubs/portage/@tests/stubtest_allowlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
portage.dbapi.dbapi.aux_get
portage.dbapi.dbapi.match
portage.dbapi.porttree.portagetree.__init__
portage.dbapi.porttree.portdbapi.__init__
portage.dbapi.porttree.portdbapi.xmatch
portage.package.ebuild.doebuild.doebuild
6 changes: 6 additions & 0 deletions stubs/portage/METADATA.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version = "3.0.*"
upstream_repository = "https://github.com/gentoo/portage"
partial_stub = true

[tool.stubtest]
ignore_missing_stub = true
19 changes: 19 additions & 0 deletions stubs/portage/portage/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from _typeshed import Incomplete
from collections.abc import Mapping
from typing import TypedDict, type_check_only

from .dbapi.porttree import portagetree
from .package.ebuild.config import config

@type_check_only
class _DBRootDict(TypedDict):
bintree: Incomplete
porttree: portagetree
vartree: Incomplete
virtuals: dict[str, Incomplete]

db: Mapping[str, _DBRootDict]
root: str
settings: config
Copy link
Collaborator

Choose a reason for hiding this comment

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

Since there are other public members that are not part of this stub file, we need to add the following:

def __getattr__(name: str): ...  # incomplete module

The partial_stub marker in METADATA.toml only tells type checkers that whole modules are missing, not that modules that do exist might be incomplete. That's what the __getattr__ does.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

With this line added as is, how do I get past the stricter Pyright check? I saw that no other stubs with this added a return type.

Copy link
Collaborator

Choose a reason for hiding this comment

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


def __getattr__(name: str) -> Incomplete: ... # incomplete module
35 changes: 35 additions & 0 deletions stubs/portage/portage/dbapi/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
from _typeshed import Incomplete
from typing import Literal

class dbapi:
def aux_get(
self,
mycpv: str,
mylist: list[
Literal[
"DEFINED_PHASES",
"DEPEND",
"EAPI",
"HDEPEND",
"HOMEPAGE",
"INHERITED",
"IUSE",
"KEYWORDS",
"LICENSE",
"PDEPEND",
"PROPERTIES",
"PROVIDE",
"RDEPEND",
"REQUIRED_USE",
"repository",
"RESTRICT",
"SRC_URI",
"SLOT",
]
],
mytree: str | None = None,
myrepo: str | None = None,
) -> list[str]: ...
def match(self, mydep: str, use_cache: Literal[0, 1] = 1) -> list[str] | str: ...

def __getattr__(name: str) -> Incomplete: ... # incomplete module
32 changes: 32 additions & 0 deletions stubs/portage/portage/dbapi/porttree.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
from _typeshed import Incomplete
from collections.abc import Sequence
from typing import Literal

from portage.dbapi import dbapi

class portdbapi(dbapi):
def getFetchMap(
self, mypkg: str, useflags: Sequence[str] | None = None, mytree: str | None = None
) -> dict[str, tuple[str, ...]]: ...
def xmatch(
self,
level: Literal[
"bestmatch-visible",
"match-all-cpv-only",
"match-all",
"match-visible",
"minimum-all",
"minimum-visible",
"minimum-all-ignore-profile",
],
origdep: str,
) -> list[str] | str: ...
def findname(self, mycpv: str, mytree: str | None = None, myrepo: str | None = None) -> str: ...
def findname2(
self, mycpv: str, mytree: str | None = None, myrepo: str | None = None
) -> tuple[None, Literal[0]] | tuple[str, str] | tuple[str, None]: ...

class portagetree:
dbapi: portdbapi

def __getattr__(name: str) -> Incomplete: ... # incomplete module
Empty file.
Empty file.
37 changes: 37 additions & 0 deletions stubs/portage/portage/package/ebuild/config.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
from collections.abc import Mapping
from typing import Literal, TypeVar

class config:
def __init__(
self,
clone: config | None = None,
mycpv: str | None = None,
config_profile_path: str | None = None,
config_incrementals: dict[str, str] | None = None,
config_root: str | None = None,
target_root: str | None = None,
sysroot: str | None = None,
eprefix: str | None = None,
local_config: bool = True,
env: dict[str, str] | None = None,
_unmatched_removal: bool = False,
repositories: list[str] | None = None,
) -> None: ...
def __getitem__(self, key: str) -> str: ...
def __setitem__(self, key: str, value: str) -> None: ...
def __delitem__(self, key: str) -> None: ...
def __iter__(self) -> str: ...
def get(self, k: str, x=...): ...

_K = TypeVar("_K")
_V = TypeVar("_V")

def best_from_dict(
key: _K,
top_dict: Mapping[_K, _V],
key_order,
EmptyOnError: Literal[0, 1] = 1,
FullCopy: Literal[0, 1] = 1,
AllowEmpty: Literal[0, 1] = 1,
) -> Literal[""] | dict[_K, _V]: ...
def autouse(myvartree, use_cache: Literal[0, 1] = 1, mysettings: config | None = None) -> Literal[""]: ...
57 changes: 57 additions & 0 deletions stubs/portage/portage/package/ebuild/doebuild.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
from _typeshed import Incomplete
from typing import Literal

from portage.dbapi.porttree import portdbapi

from .config import config

def doebuild(
myebuild: str,
mydo: Literal[
"clean",
"cleanrm",
"compile",
"config",
"configure",
"depend",
"digest",
"fetch",
"fetchall",
"help",
"info",
"install",
"instprep",
"manifest",
"merge",
"nofetch",
"package",
"postinst",
"postrm",
"preinst",
"prepare",
"prerm",
"pretend",
"qmerge",
"rpm",
"setup",
"test",
"unmerge",
"unpack",
],
settings: config | None = None,
debug: Literal[0, 1] = 0,
listonly: Literal[0, 1] = 0,
fetchonly: Literal[0, 1] = 0,
cleanup: Literal[0, 1] = 0,
use_cache: Literal[0, 1] = 1,
fetchall: Literal[0, 1] = 0,
tree: Literal["vartree", "porttree", "bintree"] | None = None,
mydbapi: portdbapi | None = None,
vartree=None,
prev_mtimes: dict[str, Incomplete] | None = None,
fd_pipes: dict[str, str] | None = None,
returnproc: int | bool = False,
) -> Literal[0, 1] | bool | list[int]: # Missing portage.process.MultiprocessingProcess
...

def __getattr__(name: str) -> Incomplete: ... # incomplete module
48 changes: 48 additions & 0 deletions stubs/portage/portage/versions.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
from _typeshed import Incomplete
from typing import Literal
from typing_extensions import Self

from .package.ebuild.config import config

def vercmp(ver1: str, ver2: str, silent: Literal[0, 1] = 1) -> int | None: ...

class _pkg_str(str):
@property
def stable(self) -> bool: ...
def __new__(
cls,
cpv: str,
metadata: dict[str, Incomplete] | None = None,
settings: config | None = None,
eapi: str | None = None,
repo: str | None = None,
slot: str | None = None,
build_time: int | None = None,
build_id: str | None = None,
file_size: int | None = None,
mtime: int | None = None,
db=...,
repoconfig=...,
) -> Self: ...
def __init__(
self,
cpv: str,
metadata: dict[str, Incomplete] | None = None,
settings: config | None = None,
eapi: str | None = None,
repo: str | None = None,
slot: str | None = None,
build_time: int | None = None,
build_id: str | None = None,
file_size: int | None = None,
mtime: int | None = None,
db=...,
repoconfig=...,
) -> None: ...
@staticmethod
def _long(var, default: int) -> int: ...

def catpkgsplit(
mydata: str | _pkg_str, silent: Literal[0, 1] = 1, eapi: str | None = None
) -> tuple[str | None, str, str, str] | None: ...
def __getattr__(name: str) -> Incomplete: ... # incomplete module
Loading