Declare PEP 561 compliance (type checking support) about portalocker

[wolph]

I didn't know about py.typed either, that's news to me :)
In any case, good idea. I'll add it to this library (and possibly a few others as well).

Due to the fragile nature of apple hardware my laptop is currently out of commission unfortunately, and that's the only system I've completely setup to properly create new releases with signing and everything so it'll probably take a few weeks until I can create a new release.

[BoniLindsley]

Thank you for adding this! Now I can have this in some commits!

-import portalocker  # type: ignore[import]
+import portalocker

There is one tinsy little issue I ran into when using the type hint -- the exception base class is not type hinted. I think the following is sufficient to type hint it:

+import typing
+
+
class BaseLockException(Exception):
    # Error codes:
    LOCK_FAILED = 1

-    def __init__(self, *args, fh=None, **kwargs):
+    def __init__(
+        self,
+        *args: typing.Any,
+        fh: typing.Optional[typing.IO] = None,
+        **kwargs: typing.Any,
+    ) -> None:
        self.fh = fh
        Exception.__init__(self, *args, **kwargs)

That was the only one I ran into directly. Checking the package shows a few untyped functions. These are in utils though, so I am guessing these probably do not matter much for the users.

• portalocker.utils.coalesce(*args: typing.Any, test_value: typing.Any = None)
  https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/utils.py#L31
• portalocker.utils.LockBase._timeout_generator(self, timeout: float, check_interval: float)
  https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/utils.py#L132
• portalocker.utils.LockBase.__exit__(self, type_, value, tb): This one is a little more complicated, and requires extra imports, as suggested in https://mypy.readthedocs.io/en/stable/protocols.html#contextmanager-t
  https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/utils.py#L155
• I have not used __delete__ before.
  https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/utils.py#L158
• portalocker.utils.BoundedSemaphore.get_filename(self, number: int)
  https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/utils.py#L389

There are also two in the redis module, but I do not know enough about it to suggest anything, and the redis-py package does not seem to have type hints anyway.

• https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/redis.py#L113
• https://github.com/WoLpH/portalocker/blob/631352fbfd9f2b780a6d5f9da39646f4088910aa/portalocker/redis.py#L179

[wolph]

I completely forgot to reply to this... obviously we've already had a few releases so it's definitely included but it's certainly not perfect yet. I've improved the type hints somewhat but I'm not at 100% coverage yet

Perhaps some day :)

Thank you for all the help @BoniLindsley!