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
2 changes: 2 additions & 0 deletions stubs/pyphen/METADATA.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
version = "0.17.2"
upstream-repository = "https://github.com/Kozea/Pyphen"
40 changes: 40 additions & 0 deletions stubs/pyphen/pyphen/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
from collections.abc import Generator
from pathlib import Path
from typing import Any
from typing_extensions import Self

__all__ = ("LANGUAGES", "Pyphen", "language_fallback")
LANGUAGES: dict[str, Path]

def language_fallback(language: str) -> str: ...

class AlternativeParser:
change: str
index: int
cut: int

def __init__(self, pattern: str, alternative: str) -> None: ...
def __call__(self, value: str) -> int: ...
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
def __call__(self, value: str) -> int: ...
def __call__(self, value: str | int) -> int: ...

Or even SupportsInt.


class DataInt(int):
def __new__(cls, value: int, data: Any = ..., reference: DataInt | None = ...) -> Self: ...
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Missing the data attribute (which can be at least DataInt or None, possibly more types).


class HyphDict:
patterns: dict[str, tuple[int, tuple[int, ...]]]
cache: dict[str, list[DataInt]]
maxlen: int

def __init__(self, path: Path) -> None: ...
def positions(self, word: str) -> list[DataInt]: ...

class Pyphen:
hd: HyphDict

def __init__(
self, filename: str | Path | None = ..., lang: str | None = ..., left: int = 2, right: int = 2, cache: bool = True
) -> None: ...
def positions(self, word: str) -> list[DataInt]: ...
def iterate(self, word: str) -> Generator[tuple[str, str]]: ...
def wrap(self, word: str, width: int, hyphen: str = "-") -> tuple[str, str] | None: ...
def inserted(self, word: str, hyphen: str = "-") -> str: ...
__call__ = iterate