From d0c8ac4d7b38a4288acafe0e2688de13d0b69ffc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Simon?= <loic.pano@gmail.com>
Date: Thu, 27 Feb 2025 14:07:22 +0100
Subject: [PATCH] Add stubs for `dirhash` package (#13437)

---
 pyrightconfig.stricter.json        |  1 +
 stubs/dirhash/METADATA.toml        |  2 +
 stubs/dirhash/dirhash/__init__.pyi | 93 ++++++++++++++++++++++++++++++
 stubs/dirhash/dirhash/cli.pyi      |  5 ++
 4 files changed, 101 insertions(+)
 create mode 100644 stubs/dirhash/METADATA.toml
 create mode 100644 stubs/dirhash/dirhash/__init__.pyi
 create mode 100644 stubs/dirhash/dirhash/cli.pyi

diff --git a/pyrightconfig.stricter.json b/pyrightconfig.stricter.json
index 30aa8ff80..c68a490f7 100644
--- a/pyrightconfig.stricter.json
+++ b/pyrightconfig.stricter.json
@@ -39,6 +39,7 @@
         "stubs/corus",
         "stubs/dateparser",
         "stubs/defusedxml",
+        "stubs/dirhash",
         "stubs/docker",
         "stubs/docutils",
         "stubs/Flask-SocketIO",
diff --git a/stubs/dirhash/METADATA.toml b/stubs/dirhash/METADATA.toml
new file mode 100644
index 000000000..a39d6c7bc
--- /dev/null
+++ b/stubs/dirhash/METADATA.toml
@@ -0,0 +1,2 @@
+version = "0.5.*"
+upstream_repository = "https://github.com/andhus/dirhash-python"
diff --git a/stubs/dirhash/dirhash/__init__.pyi b/stubs/dirhash/dirhash/__init__.pyi
new file mode 100644
index 000000000..5a24f69dc
--- /dev/null
+++ b/stubs/dirhash/dirhash/__init__.pyi
@@ -0,0 +1,93 @@
+from _typeshed import Incomplete
+from collections.abc import Generator, Iterable
+from os import PathLike
+from typing import TypeVar
+from typing_extensions import TypeAlias
+
+_DirNode: TypeAlias = Incomplete  # scantree.DirNode
+_RecursionPath: TypeAlias = Incomplete  # scantree.RecursionPath
+_RP = TypeVar("_RP", bound=_RecursionPath)
+
+__all__ = [
+    "__version__",
+    "algorithms_guaranteed",
+    "algorithms_available",
+    "dirhash",
+    "dirhash_impl",
+    "included_paths",
+    "Filter",
+    "get_match_patterns",
+    "Protocol",
+]
+
+__version__: str
+algorithms_guaranteed: set[str]
+algorithms_available: set[str]
+
+def dirhash(
+    directory: str | PathLike[str],
+    algorithm: str,
+    match: Iterable[str] = ("*",),
+    ignore: Iterable[str] | None = None,
+    linked_dirs: bool = True,
+    linked_files: bool = True,
+    empty_dirs: bool = False,
+    entry_properties: Iterable[str] = ("name", "data"),
+    allow_cyclic_links: bool = False,
+    chunk_size: int = 1048576,
+    jobs: int = 1,
+) -> str: ...
+def dirhash_impl(
+    directory: str | PathLike[str],
+    algorithm: str,
+    filter_: Filter | None = None,
+    protocol: Protocol | None = None,
+    chunk_size: int = 1048576,
+    jobs: int = 1,
+) -> str: ...
+def included_paths(
+    directory: str | PathLike[str],
+    match: Iterable[str] = ("*",),
+    ignore: Iterable[str] | None = None,
+    linked_dirs: bool = True,
+    linked_files: bool = True,
+    empty_dirs: bool = False,
+    allow_cyclic_links: bool = False,
+) -> list[str]: ...
+
+class Filter:
+    linked_dirs: bool
+    linked_files: bool
+    empty_dirs: bool
+
+    def __init__(
+        self,
+        match_patterns: Iterable[str] | None = None,
+        linked_dirs: bool = True,
+        linked_files: bool = True,
+        empty_dirs: bool = False,
+    ) -> None: ...
+    @property
+    def match_patterns(self) -> tuple[str, ...]: ...
+    def include(self, recursion_path: _RecursionPath) -> bool: ...
+    def match_file(self, filepath: str | PathLike[str]) -> bool: ...
+    def __call__(self, paths: Iterable[_RP]) -> Generator[_RP, None, None]: ...
+
+def get_match_patterns(
+    match: Iterable[str] | None = None,
+    ignore: Iterable[str] | None = None,
+    ignore_extensions: Iterable[str] | None = None,
+    ignore_hidden: bool = False,
+) -> list[str]: ...
+
+class Protocol:
+    class EntryProperties:
+        NAME: str
+        DATA: str
+        IS_LINK: str
+        options: set[str]
+
+    entry_properties: Iterable[str]
+    allow_cyclic_links: bool
+    def __init__(self, entry_properties: Iterable[str] = ("name", "data"), allow_cyclic_links: bool = False) -> None: ...
+    def get_descriptor(self, dir_node: _DirNode) -> str: ...
diff --git a/stubs/dirhash/dirhash/cli.pyi b/stubs/dirhash/dirhash/cli.pyi
new file mode 100644
index 000000000..b8229142d
--- /dev/null
+++ b/stubs/dirhash/dirhash/cli.pyi
@@ -0,0 +1,5 @@
+from collections.abc import Sequence
+from typing import Any
+
+def main() -> None: ...
+def get_kwargs(args: Sequence[str]) -> dict[str, Any]: ...  # value depends on the key