Add additional typing (#438)

Author: bdraco

pyisy/__init__.py

@@ -21,6 +21,8 @@
 limitations under the License.
 """
 
+from __future__ import annotations
+
 from importlib.metadata import PackageNotFoundError, version
 
 from .exceptions import (

pyisy/__main__.py

@@ -8,6 +8,8 @@
 using this module.
 """
 
+from __future__ import annotations
+
 import argparse
 import asyncio
 import logging

pyisy/configuration.py

@@ -1,5 +1,7 @@
 """ISY Configuration Lookup."""
 
+from __future__ import annotations
+
 from xml.dom import minidom
 
 from .constants import (

pyisy/connection.py

@@ -1,5 +1,7 @@
 """Connection to the ISY."""
 
+from __future__ import annotations
+
 import asyncio
 import ssl
 from urllib.parse import quote, urlencode
@@ -57,15 +59,15 @@ class Connection:
 
     def __init__(
         self,
-        address,
-        port,
-        username,
-        password,
-        use_https=False,
-        tls_ver=1.1,
-        webroot="",
-        websession=None,
-    ):
+        address: str,
+        port: int,
+        username: str,
+        password: str,
+        use_https: bool = False,
+        tls_ver: float = 1.1,
+        webroot: str = "",
+        websession: aiohttp.ClientSession | None = None,
+    ) -> None:
         """Initialize the Connection object."""
         if len(_LOGGER.handlers) == 0:
             enable_logging(add_null_handler=True)
@@ -90,27 +92,27 @@ def __init__(
         self.req_session = websession
         self.sslcontext = get_sslcontext(use_https, tls_ver)
 
-    async def test_connection(self):
+    async def test_connection(self) -> str | None:
         """Test the connection and get the config for the ISY."""
         config = await self.get_config(retries=None)
         if not config:
             _LOGGER.error("Could not connect to the ISY with the parameters provided.")
             raise ISYConnectionError
         return config
 
-    def increase_available_connections(self):
+    def increase_available_connections(self) -> None:
         """Increase the number of allowed connections for newer hardware."""
         _LOGGER.debug("Increasing available simultaneous connections")
         self.semaphore = asyncio.Semaphore(
             MAX_HTTPS_CONNECTIONS_IOX if self.use_https else MAX_HTTP_CONNECTIONS_IOX
         )
 
-    async def close(self):
+    async def close(self) -> None:
         """Cleanup connections and prepare for exit."""
         await self.req_session.close()
 
     @property
-    def connection_info(self):
+    def connection_info(self) -> dict[str, str | int | bytes | None]:
         """Return the connection info required to connect to the ISY."""
         connection_info = {}
         connection_info["auth"] = self._auth.encode()
@@ -124,12 +126,12 @@ def connection_info(self):
         return connection_info
 
     @property
-    def url(self):
+    def url(self) -> str:
         """Return the full connection url."""
         return self._url
 
     # COMMON UTILITIES
-    def compile_url(self, path: list[str], query: str | None = None):
+    def compile_url(self, path: list[str], query: str | None = None) -> str:
         """Compile the URL to fetch from the ISY."""
         url = self.url
         if path is not None:

pyisy/constants.py

@@ -1,5 +1,7 @@
 """Constants for the PyISY Module."""
 
+from __future__ import annotations
+
 import datetime
 
 UPDATE_INTERVAL = 0.5

pyisy/events/__init__.py

@@ -1 +1,3 @@
 """ISY Event Stream Subclasses."""
+
+from __future__ import annotations

pyisy/events/eventreader.py

@@ -1,5 +1,7 @@
 """ISY TCP Socket Event Reader."""
 
+from __future__ import annotations
+
 import errno
 import select
 import ssl

pyisy/events/strings.py

@@ -1,5 +1,7 @@
 """Strings for Event Stream Requests."""
 
+from __future__ import annotations
+
 # Subscribe Message
 SUB_MSG = {
     "head": """POST /services HTTP/1.1

pyisy/events/tcpsocket.py

@@ -1,5 +1,7 @@
 """ISY Event Stream."""
 
+from __future__ import annotations
+
 import asyncio
 import logging
 import socket

pyisy/exceptions.py

@@ -1,5 +1,7 @@
 """Exceptions used by the PyISY module."""
 
+from __future__ import annotations
+
 from xml.parsers.expat import ExpatError
 
 XML_ERRORS = (AttributeError, KeyError, ValueError, TypeError, IndexError, ExpatError)