py.typed

[fried]

Have you considered providing a init.pyi file for the lmdb package?

https://www.python.org/dev/peps/pep-0561/#packaging-type-information

[jnwatson]

I have. It is on the list to do. PRs are always welcome. :)

[jnwatson]

(Leaving this open as a reminder)

[fried]

I have a local lmdb.pyi to make pylance (pyright) happy, but it only has the stuff I use. The hardest part was Cursor.iternext because it changes the return type based on arguments (the other iter methods will need similar treatment).

If I have time i'll see if I can fill out the pyi fully and submit a pull. But If I don't make it and somebody takes up the mantle here is the hard parts. Also we would have to probably use lmdb.__init__.pyi

class Cusor:
    @overload
    def iternext(self, keys: Literal[False]) -> Iterator[bytes]:
        ...

    @overload
    def iternext(self, keys: Literal[False], values: Literal[True]) -> Iterator[bytes]:
        ...

    @overload
    def iternext(self, values: Literal[False]) -> Iterator[bytes]:
        ...

    @overload
    def iternext(self, keys: Literal[True], values: Literal[False]) -> Iterator[bytes]:
        ...

    @overload
    def iternext(
        self, keys: Literal[True], values: Literal[True]
    ) -> Iterator[tuple[bytes, bytes]]:
        ...

    @overload
    def iternext(self) -> Iterator[tuple[bytes, bytes]]:
        ...

Oh and txn.get is a little complex, also included put so you can see how I indicated keyword only arguments to keep it straight in my head

T = TypeVar("T")

class DatabaseHandle: ...  #  _Database so people can reference the type without pylint complaining about protected. 

class Transaction:
    def get(
        self,
        key: bytes,
        default: Optional[T] = ...,
        *,  
        db: Optional[DatabaseHandle] = ...,
    ) -> Union[Optional[T], bytes]:
        ...

    def put(
        self,
        key: bytes,
        value: bytes,
        *,
        db: Optional[DatabaseHandle] = ...,
        dupdata: bool = ...,
        overwrite: bool = ...,
    ) -> bool:
        ...

[jnwatson]

Thanks! I'll have to check out pylance/pyright.