pykeepass-stubs 0.1.0__tar.gz

pykeepass_stubs-0.1.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.3
+Name: pykeepass-stubs
+Version: 0.1.0
+Summary: Type stubs for pykeepass
+Author: Kaj Kowalski
+Author-email: Kaj Kowalski <info@kajkowalski.nl>
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Stubs Only
+Requires-Dist: pykeepass>=4.1.1.post1,<4.2
+Requires-Dist: types-lxml>=2026.2.16
+Requires-Python: >=3.11
+Project-URL: Issues, https://github.com/kjanat/kp2bw/issues
+Project-URL: Repository, https://github.com/kjanat/kp2bw/tree/master/packages/pykeepass-stubs
+Description-Content-Type: text/markdown
+
+# pykeepass-stubs
+
+Type stubs for [pykeepass].
+
+This is a stub-only distribution that improves type-checking for projects using `pykeepass`.
+
+- Target package: `pykeepass`
+- Distribution name: `pykeepass-stubs`
+- Status: partial stubs ([PEP 561])
+
+## Versioning policy
+
+- `pykeepass-stubs` uses its own version stream (not lockstep with `pykeepass`).
+- Compatibility is declared via package requirements.
+- Current supported runtime range: `pykeepass>=4.1.1.post1,<4.2`.
+
+[PEP 561]: https://peps.python.org/pep-0561/ "PEP 561 – Distributing and Packaging Type Information"
+[pykeepass]: https://github.com/libkeepass/pykeepass "GitHub Repository"

pykeepass_stubs-0.1.0/README.md

@@ -0,0 +1,18 @@
+# pykeepass-stubs
+
+Type stubs for [pykeepass].
+
+This is a stub-only distribution that improves type-checking for projects using `pykeepass`.
+
+- Target package: `pykeepass`
+- Distribution name: `pykeepass-stubs`
+- Status: partial stubs ([PEP 561])
+
+## Versioning policy
+
+- `pykeepass-stubs` uses its own version stream (not lockstep with `pykeepass`).
+- Compatibility is declared via package requirements.
+- Current supported runtime range: `pykeepass>=4.1.1.post1,<4.2`.
+
+[PEP 561]: https://peps.python.org/pep-0561/ "PEP 561 – Distributing and Packaging Type Information"
+[pykeepass]: https://github.com/libkeepass/pykeepass "GitHub Repository"

pykeepass_stubs-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name            = "pykeepass-stubs"
+version         = "0.1.0"
+description     = "Type stubs for pykeepass"
+readme          = "README.md"
+requires-python = ">=3.11"
+classifiers     = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Typing :: Stubs Only",
+]
+dependencies    = [
+  "pykeepass>=4.1.1.post1,<4.2",
+  "types-lxml>=2026.2.16",
+]
+
+[[project.authors]]
+name  = "Kaj Kowalski"
+email = "info@kajkowalski.nl"
+
+[project.urls]
+Issues     = "https://github.com/kjanat/kp2bw/issues"
+Repository = "https://github.com/kjanat/kp2bw/tree/master/packages/pykeepass-stubs"
+
+[build-system]
+requires      = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.pyright]
+venvPath         = "../../"
+venv             = ".venv"
+typeCheckingMode = "strict"
+pythonVersion    = "3.11"
+
+[tool.ruff]
+preview        = true
+target-version = "py311"
+
+[tool.ruff.lint]
+ignore = ["PYI029"]

pykeepass_stubs-0.1.0/src/pykeepass-stubs/__init__.pyi

@@ -0,0 +1,16 @@
+from pykeepass.attachment import Attachment
+from pykeepass.entry import Entry
+from pykeepass.group import Group
+from pykeepass.icons import icons
+from pykeepass.pykeepass import PyKeePass, create_database
+
+__version__: str
+__all__ = [
+    "Attachment",
+    "Entry",
+    "Group",
+    "PyKeePass",
+    "__version__",
+    "create_database",
+    "icons",
+]

pykeepass_stubs-0.1.0/src/pykeepass-stubs/attachment.pyi

@@ -0,0 +1,32 @@
+from lxml.etree import Element
+from pykeepass.entry import Entry
+from pykeepass.pykeepass import PyKeePass
+
+class Attachment:
+    _element: Element
+    _kp: PyKeePass | None
+
+    def __init__(
+        self,
+        element: Element | None = ...,
+        kp: PyKeePass | None = ...,
+        id: int | None = ...,
+        filename: str | None = ...,
+    ) -> None: ...
+    @property
+    def id(self) -> int: ...
+    @id.setter
+    def id(self, id: int) -> None: ...
+    @property
+    def filename(self) -> str | None: ...
+    @filename.setter
+    def filename(self, filename: str) -> None: ...
+    @property
+    def entry(self) -> Entry: ...
+    @property
+    def binary(self) -> bytes: ...
+
+    data: bytes
+
+    def delete(self) -> None: ...
+    def __repr__(self) -> str: ...

pykeepass_stubs-0.1.0/src/pykeepass-stubs/baseelement.pyi

@@ -0,0 +1,86 @@
+import uuid as _uuid
+from datetime import datetime
+from typing import Any, Literal, overload
+
+from lxml.etree import Element
+from pykeepass.group import Group
+from pykeepass.pykeepass import PyKeePass
+
+class BaseElement:
+    _element: Element
+    _kp: PyKeePass | None
+
+    def __init__(
+        self,
+        element: Element,
+        kp: PyKeePass | None = ...,
+        icon: str | None = ...,
+        expires: bool = ...,
+        expiry_time: datetime | None = ...,
+    ) -> None: ...
+    @overload
+    def _xpath(
+        self,
+        xpath: str,
+        *,
+        first: Literal[True],
+        cast: bool = ...,
+        **kwargs: Any,
+    ) -> Element | None: ...
+    @overload
+    def _xpath(
+        self,
+        xpath: str,
+        *,
+        first: Literal[False] = ...,
+        cast: bool = ...,
+        **kwargs: Any,
+    ) -> list[Element]: ...
+    def _xpath(self, xpath: str, **kwargs: Any) -> list[Element] | Element | None: ...
+    def _get_subelement_text(self, tag: str) -> str | None: ...
+    def _set_subelement_text(self, tag: str, value: str) -> None: ...
+    @property
+    def group(self) -> Group | None: ...
+    @property
+    def parentgroup(self) -> Group | None: ...
+    def dump_xml(self, pretty_print: bool = ...) -> bytes: ...
+    @property
+    def uuid(self) -> _uuid.UUID: ...
+    @uuid.setter
+    def uuid(self, uuid: _uuid.UUID) -> None: ...
+    @property
+    def icon(self) -> str | None: ...
+    @icon.setter
+    def icon(self, value: str | None) -> None: ...
+    @property
+    def _path(self) -> str: ...
+    def _get_times_property(self, prop: str) -> datetime | None: ...
+    def _set_times_property(self, prop: str, value: datetime) -> None: ...
+    @property
+    def expires(self) -> bool: ...
+    @expires.setter
+    def expires(self, value: bool) -> None: ...
+    @property
+    def expired(self) -> bool: ...
+    @property
+    def expiry_time(self) -> datetime | None: ...
+    @expiry_time.setter
+    def expiry_time(self, value: datetime) -> None: ...
+    @property
+    def ctime(self) -> datetime | None: ...
+    @ctime.setter
+    def ctime(self, value: datetime) -> None: ...
+    @property
+    def atime(self) -> datetime | None: ...
+    @atime.setter
+    def atime(self, value: datetime) -> None: ...
+    @property
+    def mtime(self) -> datetime | None: ...
+    @mtime.setter
+    def mtime(self, value: datetime) -> None: ...
+    def delete(self) -> None: ...
+    def __unicode__(self) -> str: ...
+    def __repr__(self) -> str: ...
+    def __hash__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def touch(self, modify: bool = ...) -> None: ...

pykeepass_stubs-0.1.0/src/pykeepass-stubs/entry.pyi

@@ -0,0 +1,104 @@
+from datetime import datetime
+
+from lxml.etree import Element
+from lxml.objectify import ObjectifiedElement
+from pykeepass.attachment import Attachment
+from pykeepass.baseelement import BaseElement
+from pykeepass.group import Group
+from pykeepass.pykeepass import PyKeePass
+
+class Entry(BaseElement):
+    def __init__(
+        self,
+        title: str | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        url: str | None = None,
+        notes: str | None = None,
+        otp: str | None = None,
+        tags: list[str] | str | None = None,
+        expires: bool = False,
+        expiry_time: datetime | None = None,
+        icon: str | None = None,
+        autotype_sequence: str | None = None,
+        autotype_enabled: bool = True,
+        autotype_window: str | None = None,
+        element: Element | ObjectifiedElement | None = None,
+        kp: PyKeePass | None = None,
+    ) -> None: ...
+    @property
+    def index(self) -> int: ...
+    def reindex(self, new_index: int) -> None: ...
+    @property
+    def attachments(self) -> list[Attachment]: ...
+    def add_attachment(self, id: int, filename: str) -> Attachment: ...
+    def delete_attachment(self, attachment: Attachment) -> None: ...
+    def deref(self, attribute: str) -> str | None: ...
+    @property
+    def title(self) -> str | None: ...
+    @title.setter
+    def title(self, value: str | None) -> None: ...
+    @property
+    def username(self) -> str | None: ...
+    @username.setter
+    def username(self, value: str | None) -> None: ...
+    @property
+    def password(self) -> str | None: ...
+    @password.setter
+    def password(self, value: str | None) -> None: ...
+    @property
+    def url(self) -> str | None: ...
+    @url.setter
+    def url(self, value: str | None) -> None: ...
+    @property
+    def notes(self) -> str | None: ...
+    @notes.setter
+    def notes(self, value: str | None) -> None: ...
+    @property
+    def otp(self) -> str | None: ...
+    @otp.setter
+    def otp(self, value: str | None) -> None: ...
+    @property
+    def tags(self) -> list[str]: ...
+    @tags.setter
+    def tags(self, value: list[str] | str) -> None: ...
+    @property
+    def history(self) -> list[HistoryEntry]: ...
+    @property
+    def autotype_enabled(self) -> bool | None: ...
+    @autotype_enabled.setter
+    def autotype_enabled(self, value: bool | None) -> None: ...
+    @property
+    def autotype_sequence(self) -> str | None: ...
+    @autotype_sequence.setter
+    def autotype_sequence(self, value: str | None) -> None: ...
+    @property
+    def autotype_window(self) -> str | None: ...
+    @autotype_window.setter
+    def autotype_window(self, value: str | None) -> None: ...
+    @property
+    def is_a_history_entry(self) -> bool: ...
+    @property
+    def path(self) -> list[str | None] | None: ...
+    @property
+    def custom_properties(self) -> dict[str, str | None]: ...
+    def set_custom_property(
+        self, key: str, value: str, protect: bool = False
+    ) -> None: ...
+    def get_custom_property(self, key: str) -> str | None: ...
+    def delete_custom_property(self, key: str) -> None: ...
+    def is_custom_property_protected(self, key: str) -> bool: ...
+    def ref(self, attribute: str) -> str: ...
+    def save_history(self) -> None: ...
+    def delete_history(
+        self, history_entry: Entry | None = None, all: bool = False
+    ) -> None: ...
+    @property
+    def group(self) -> Group | None: ...
+    @property
+    def parentgroup(self) -> Group | None: ...
+    def __str__(self) -> str: ...
+
+class HistoryEntry(Entry):
+    def __str__(self) -> str: ...
+    def __hash__(self) -> int: ...

pykeepass_stubs-0.1.0/src/pykeepass-stubs/exceptions.pyi

@@ -0,0 +1,5 @@
+class CredentialsError(Exception): ...
+class PayloadChecksumError(Exception): ...
+class HeaderChecksumError(Exception): ...
+class BinaryError(Exception): ...
+class UnableToSendToRecycleBin(Exception): ...

pykeepass_stubs-0.1.0/src/pykeepass-stubs/group.pyi

@@ -0,0 +1,41 @@
+from datetime import datetime
+
+from lxml.etree import Element
+from lxml.objectify import ObjectifiedElement
+from pykeepass.baseelement import BaseElement
+from pykeepass.entry import Entry
+from pykeepass.pykeepass import PyKeePass
+
+class Group(BaseElement):
+    def __init__(
+        self,
+        name: str | None = None,
+        element: Element | ObjectifiedElement | None = None,
+        icon: str | None = None,
+        notes: str | None = None,
+        kp: PyKeePass | None = None,
+        expires: bool | None = None,
+        expiry_time: datetime | None = None,
+    ) -> None: ...
+    @property
+    def name(self) -> str | None: ...
+    @name.setter
+    def name(self, value: str) -> None: ...
+    @property
+    def notes(self) -> str | None: ...
+    @notes.setter
+    def notes(self, value: str) -> None: ...
+    @property
+    def entries(self) -> list[Entry]: ...
+    @property
+    def subgroups(self) -> list[Group]: ...
+    @property
+    def is_root_group(self) -> bool: ...
+    @property
+    def path(self) -> list[str | None]: ...
+    @property
+    def group(self) -> Group | None: ...
+    @property
+    def parentgroup(self) -> Group | None: ...
+    def append(self, entries: Entry | Group | list[Entry] | list[Group]) -> None: ...
+    def __str__(self) -> str: ...

pykeepass_stubs-0.1.0/src/pykeepass-stubs/icons.pyi

@@ -0,0 +1,3 @@
+from types import SimpleNamespace
+
+icons: SimpleNamespace

pykeepass_stubs-0.1.0/src/pykeepass-stubs/py.typed

@@ -0,0 +1 @@
+partial

pykeepass_stubs-0.1.0/src/pykeepass-stubs/pykeepass.pyi

@@ -0,0 +1,242 @@
+import uuid as _uuid
+from datetime import datetime
+from io import IOBase
+from pathlib import Path
+from typing import Any, Self, overload
+
+from lxml.etree import Element, ElementTree
+from pykeepass.attachment import Attachment
+from pykeepass.entry import Entry
+from pykeepass.group import Group
+
+class PyKeePass:
+    filename: str | Path
+    kdbx: object
+
+    def __init__(
+        self,
+        filename: str | Path | IOBase,
+        password: str | None = None,
+        keyfile: str | Path | None = None,
+        transformed_key: bytes | None = None,
+        decrypt: bool = True,
+    ) -> None: ...
+    def __enter__(self) -> Self: ...
+    def __exit__(
+        self,
+        typ: type[BaseException] | None,
+        value: BaseException | None,
+        tb: object,
+    ) -> None: ...
+    def read(
+        self,
+        filename: str | Path | IOBase | None = None,
+        password: str | None = None,
+        keyfile: str | Path | None = None,
+        transformed_key: bytes | None = None,
+        decrypt: bool = True,
+    ) -> None: ...
+    def reload(self) -> None: ...
+    def save(
+        self,
+        filename: str | Path | IOBase | None = None,
+        transformed_key: bytes | None = None,
+    ) -> None: ...
+    @property
+    def version(self) -> tuple[int, int]: ...
+    @property
+    def encryption_algorithm(self) -> str: ...
+    @property
+    def kdf_algorithm(self) -> str | None: ...
+    @property
+    def transformed_key(self) -> bytes: ...
+    @property
+    def database_salt(self) -> bytes: ...
+    @property
+    def tree(self) -> ElementTree: ...
+    @property
+    def root_group(self) -> Group: ...
+    @property
+    def recyclebin_group(self) -> Group | None: ...
+    @property
+    def groups(self) -> list[Group]: ...
+    @property
+    def entries(self) -> list[Entry]: ...
+    @property
+    def database_name(self) -> str | None: ...
+    @database_name.setter
+    def database_name(self, name: str) -> None: ...
+    @property
+    def database_description(self) -> str | None: ...
+    @database_description.setter
+    def database_description(self, name: str) -> None: ...
+    @property
+    def default_username(self) -> str | None: ...
+    @default_username.setter
+    def default_username(self, name: str) -> None: ...
+    def xml(self) -> bytes: ...
+    def dump_xml(self, filename: str) -> None: ...
+    @overload
+    def xpath(
+        self,
+        xpath_str: str,
+        tree: Element | ElementTree | None = None,
+        *,
+        first: bool = False,
+        cast: bool = False,
+        **kwargs: Any,
+    ) -> list[Element]: ...
+    @overload
+    def xpath(
+        self,
+        xpath_str: str,
+        tree: Element | ElementTree | None = None,
+        first: bool = False,
+        cast: bool = False,
+        **kwargs: Any,
+    ) -> list[Element] | Element | None: ...
+    def xpath(
+        self,
+        xpath_str: str,
+        tree: Element | ElementTree | None = None,
+        first: bool = False,
+        cast: bool = False,
+        **kwargs: Any,
+    ) -> list[Element] | Element | None: ...
+
+    _xpath = xpath
+
+    # --- Groups ---
+
+    def find_groups(
+        self,
+        recursive: bool = True,
+        path: list[str] | None = None,
+        group: Group | None = None,
+        *,
+        name: str | None = None,
+        uuid: _uuid.UUID | None = None,
+        notes: str | None = None,
+        first: bool = False,
+        regex: bool = False,
+        flags: str | None = None,
+    ) -> list[Group] | Group | None: ...
+    def add_group(
+        self,
+        destination_group: Group,
+        group_name: str,
+        icon: str | None = None,
+        notes: str | None = None,
+    ) -> Group: ...
+    def delete_group(self, group: Group) -> None: ...
+    def move_group(self, group: Group, destination_group: Group) -> None: ...
+    def trash_group(self, group: Group) -> None: ...
+    def empty_group(self, group: Group) -> None: ...
+
+    # --- Entries ---
+
+    def find_entries(
+        self,
+        recursive: bool = True,
+        path: list[str | None] | None = None,
+        group: Group | None = None,
+        *,
+        title: str | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        url: str | None = None,
+        notes: str | None = None,
+        otp: str | None = None,
+        string: dict[str, str] | None = None,
+        uuid: _uuid.UUID | None = None,
+        tags: list[str] | None = None,
+        autotype_enabled: bool | None = None,
+        autotype_sequence: str | None = None,
+        autotype_window: str | None = None,
+        first: bool = False,
+        history: bool = False,
+        regex: bool = False,
+        flags: str | None = None,
+    ) -> list[Entry] | Entry | None: ...
+    def add_entry(
+        self,
+        destination_group: Group,
+        title: str | None,
+        username: str | None,
+        password: str | None,
+        url: str | None = None,
+        notes: str | None = None,
+        expiry_time: datetime | None = None,
+        tags: list[str] | str | None = None,
+        otp: str | None = None,
+        icon: str | None = None,
+        force_creation: bool = False,
+    ) -> Entry: ...
+    def delete_entry(self, entry: Entry) -> None: ...
+    def move_entry(self, entry: Entry, destination_group: Group) -> None: ...
+    def trash_entry(self, entry: Entry) -> None: ...
+
+    # --- Attachments ---
+
+    def find_attachments(
+        self,
+        recursive: bool = True,
+        path: list[str] | None = None,
+        element: Entry | Group | None = None,
+        *,
+        id: int | None = None,
+        filename: str | None = None,
+        first: bool = False,
+        history: bool = False,
+        regex: bool = False,
+        flags: str | None = None,
+    ) -> list[Attachment] | Attachment | None: ...
+    @property
+    def attachments(self) -> list[Attachment]: ...
+    @property
+    def binaries(self) -> list[bytes]: ...
+    def add_binary(
+        self, data: bytes, compressed: bool = True, protected: bool = True
+    ) -> int: ...
+    def delete_binary(self, id: int) -> None: ...
+
+    # --- Misc ---
+
+    def deref(self, value: str | None) -> str | _uuid.UUID | None: ...
+    def _encode_time(self, value: datetime) -> str: ...
+    def _decode_time(self, text: str) -> datetime: ...
+
+    # --- Credentials ---
+
+    @property
+    def password(self) -> str | None: ...
+    @password.setter
+    def password(self, password: str | None) -> None: ...
+    @property
+    def keyfile(self) -> str | Path | None: ...
+    @keyfile.setter
+    def keyfile(self, keyfile: str | Path | None) -> None: ...
+    @property
+    def credchange_required_days(self) -> int | None: ...
+    @credchange_required_days.setter
+    def credchange_required_days(self, days: int) -> None: ...
+    @property
+    def credchange_recommended_days(self) -> int | None: ...
+    @credchange_recommended_days.setter
+    def credchange_recommended_days(self, days: int) -> None: ...
+    @property
+    def credchange_date(self) -> datetime | None: ...
+    @credchange_date.setter
+    def credchange_date(self, date: datetime) -> None: ...
+    @property
+    def credchange_required(self) -> bool: ...
+    @property
+    def credchange_recommended(self) -> bool: ...
+
+def create_database(
+    filename: str | Path | IOBase,
+    password: str | None = None,
+    keyfile: str | Path | None = None,
+    transformed_key: bytes | None = None,
+) -> PyKeePass: ...
+def debug_setup() -> None: ...