Add type annotations

Author: romis2012

.gitignore

@@ -39,4 +39,5 @@ virtualenv.py
 .install-deps
 .develop
 .idea/
+.vscode/
 usage*.py

python_socks/_abc.py

@@ -1,14 +1,4 @@
-class SyncProxy:
-    def connect(self, dest_host, dest_port, timeout=None, **kwargs):
-        raise NotImplementedError()
-
-    @property
-    def proxy_host(self):
-        raise NotImplementedError()
-
-    @property
-    def proxy_port(self):
-        raise NotImplementedError()
+from typing import Optional
 
 
 class AsyncProxy:
@@ -39,7 +29,7 @@ class SyncSocketStream:
     def write_all(self, data: bytes):
         raise NotImplementedError()
 
-    def read(self, max_bytes: int = None):
+    def read(self, max_bytes: Optional[int] = None):
         raise NotImplementedError()
 
     def read_exact(self, n: int):
@@ -53,7 +43,7 @@ class AsyncSocketStream:
     async def write_all(self, data: bytes):
         raise NotImplementedError()
 
-    async def read(self, max_bytes: int = None):
+    async def read(self, max_bytes: Optional[int] = None):
         raise NotImplementedError()
 
     async def read_exact(self, n: int):

python_socks/_connectors/factory_async.py

@@ -1,3 +1,4 @@
+from typing import Optional
 from .._abc import AsyncResolver
 from .._types import ProxyType
 
@@ -9,9 +10,9 @@
 
 def create_connector(
     proxy_type: ProxyType,
-    username: str,
-    password: str,
-    rdns: bool,
+    username: Optional[str],
+    password: Optional[str],
+    rdns: Optional[bool],
     resolver: AsyncResolver,
 ) -> AsyncConnector:
     if proxy_type == ProxyType.SOCKS4:

python_socks/_connectors/factory_sync.py

@@ -1,3 +1,4 @@
+from typing import Optional
 from .._abc import SyncResolver
 from .._types import ProxyType
 
@@ -9,9 +10,9 @@
 
 def create_connector(
     proxy_type: ProxyType,
-    username: str,
-    password: str,
-    rdns: bool,
+    username: Optional[str],
+    password: Optional[str],
+    rdns: Optional[bool],
     resolver: SyncResolver,
 ) -> SyncConnector:
     if proxy_type == ProxyType.SOCKS4:

python_socks/_connectors/http_async.py

@@ -1,3 +1,4 @@
+from typing import Optional
 from .._abc import AsyncSocketStream, AsyncResolver
 from .abc import AsyncConnector
 
@@ -7,8 +8,8 @@
 class HttpAsyncConnector(AsyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
+        username: Optional[str],
+        password: Optional[str],
         resolver: AsyncResolver,
     ):
         self._username = username

python_socks/_connectors/http_sync.py

@@ -1,3 +1,4 @@
+from typing import Optional
 from .._abc import SyncSocketStream, SyncResolver
 from .abc import SyncConnector
 
@@ -7,8 +8,8 @@
 class HttpSyncConnector(SyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
+        username: Optional[str],
+        password: Optional[str],
         resolver: SyncResolver,
     ):
         self._username = username

python_socks/_connectors/socks4_async.py

@@ -1,4 +1,5 @@
 import socket
+from typing import Optional
 
 from .._abc import AsyncSocketStream, AsyncResolver
 from .abc import AsyncConnector
@@ -10,8 +11,8 @@
 class Socks4AsyncConnector(AsyncConnector):
     def __init__(
         self,
-        user_id: str,
-        rdns: bool,
+        user_id: Optional[str],
+        rdns: Optional[bool],
         resolver: AsyncResolver,
     ):
         if rdns is None:

python_socks/_connectors/socks4_sync.py

@@ -1,4 +1,5 @@
 import socket
+from typing import Optional
 
 from .._abc import SyncSocketStream, SyncResolver
 from .abc import SyncConnector
@@ -10,8 +11,8 @@
 class Socks4SyncConnector(SyncConnector):
     def __init__(
         self,
-        user_id: str,
-        rdns: bool,
+        user_id: Optional[str],
+        rdns: Optional[bool],
         resolver: SyncResolver,
     ):
         if rdns is None:

python_socks/_connectors/socks5_async.py

@@ -1,4 +1,5 @@
 import socket
+from typing import Optional
 
 from .._abc import AsyncSocketStream, AsyncResolver
 from .abc import AsyncConnector
@@ -10,9 +11,9 @@
 class Socks5AsyncConnector(AsyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
-        rdns: bool,
+        username: Optional[str],
+        password: Optional[str],
+        rdns: Optional[bool],
         resolver: AsyncResolver,
     ):
         if rdns is None:

python_socks/_connectors/socks5_sync.py

@@ -1,4 +1,5 @@
 import socket
+from typing import Optional
 
 from .._abc import SyncSocketStream, SyncResolver
 from .abc import SyncConnector
@@ -10,9 +11,9 @@
 class Socks5SyncConnector(SyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
-        rdns: bool,
+        username: Optional[str],
+        password: Optional[str],
+        rdns: Optional[bool],
         resolver: SyncResolver,
     ):
         if rdns is None: