annotations: add annotations and enforce in linter

Author: sumnerevans

cicd/custom_style_check.py

@@ -28,7 +28,7 @@ def noqa_re(error_id: str = "") -> Pattern:
     return re.compile(rf"#\s*noqa(:\s*{error_id})?\s*\n$")
 
 
-def eprint(*strings):
+def eprint(*strings: str):
     cprint(" ".join(strings), "red", end="", attrs=["bold"])
 
 

examples/listen-for-events.py

@@ -3,6 +3,7 @@
 
 import asyncio
 from linkedin_messaging import LinkedInMessaging, ChallengeException
+from linkedin_messaging.api_objects import RealTimeEventStreamEvent
 
 cookie_path = Path(__file__).parent.joinpath("cookies.pickle")
 
@@ -25,7 +26,7 @@ async def main():
         with open(cookie_path, "wb+") as cf:
             cf.write(linkedin.to_pickle())
 
-    async def on_event(event):
+    async def on_event(event: RealTimeEventStreamEvent):
         print(event)
 
     linkedin.add_event_listener("event", on_event)

linkedin_messaging/api_objects.py

@@ -18,14 +18,14 @@ def __init__(self, urn_str: str):
         self.prefix = ":".join(urn_parts[:-1])
         self.id_parts = urn_parts[-1].strip("()").split(",")
 
-    def get_id(self):
+    def get_id(self) -> str:
         assert len(self.id_parts) == 1
         return self.id_parts[0]
 
-    def id_str(self):
+    def id_str(self) -> str:
         return ",".join(self.id_parts)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return "{}:{}".format(
             self.prefix,
             (
@@ -43,7 +43,7 @@ def __eq__(self, other: Any) -> bool:
             return False
         return self.id_parts == other.id_parts
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"URN('{str(self)}')"
 
 

linkedin_messaging/linkedin.py

@@ -73,7 +73,9 @@ class ChallengeException(Exception):
 class LinkedInMessaging:
     session: aiohttp.ClientSession
     two_factor_payload: Dict[str, Any]
-    event_listeners: DefaultDict[str, List[Callable[[Any], Awaitable[None]]]]
+    event_listeners: DefaultDict[
+        str, List[Callable[[RealTimeEventStreamEvent], Awaitable[None]]]
+    ]
 
     def __init__(self):
         self.session = aiohttp.ClientSession()
@@ -96,10 +98,10 @@ def to_pickle(self) -> bytes:
     async def close(self):
         await self.session.close()
 
-    async def _get(self, relative_url: str, **kwargs) -> aiohttp.ClientResponse:
+    async def _get(self, relative_url: str, **kwargs: Any) -> aiohttp.ClientResponse:
         return await self.session.get(API_BASE_URL + relative_url, **kwargs)
 
-    async def _post(self, relative_url: str, **kwargs) -> aiohttp.ClientResponse:
+    async def _post(self, relative_url: str, **kwargs: Any) -> aiohttp.ClientResponse:
         return await self.session.post(API_BASE_URL + relative_url, **kwargs)
 
     # region Authentication
@@ -375,7 +377,7 @@ async def download_profile_picture(self, picture: Picture) -> bytes:
     def add_event_listener(
         self,
         payload_key: str,
-        fn: Callable[[Any], Awaitable[None]],
+        fn: Callable[[RealTimeEventStreamEvent], Awaitable[None]],
     ):
         self.event_listeners[payload_key].append(fn)
 

poetry.lock

@@ -42,6 +42,7 @@ mypy = "^0.782"
 pytest = "^6.2.4"
 termcolor = "^1.1.0"
 pytest-cov = "^2.12.1"
+flake8-annotations = "^2.6.2"
 
 [tool.pytest.ini_options]
 addopts = """

pyproject.toml

@@ -1,7 +1,9 @@
 [flake8]
-extend-ignore = E203, E402, E722, W503
+extend-ignore = E203, E402, E722, W503, ANN101, ANN102
 exclude = .git,__pycache__,build,dist,.venv
 max-line-length = 88
+suppress-none-returning = True
+suppress-dummy-args = True
 extension =
     MC1 = flake8-pep3101