python-socks 2.5.2__tar.gz → 2.6.0__tar.gz

{python_socks-2.5.2/python_socks.egg-info → python_socks-2.6.0}/PKG-INFO

@@ -1,18 +1,37 @@
 Metadata-Version: 2.1
 Name: python-socks
-Version: 2.5.2
-Summary: Core proxy (SOCKS4, SOCKS5, HTTP tunneling) functionality for Python
-Home-page: https://github.com/romis2012/python-socks
-Author: Roman Snegirev
-Author-email: snegiryev@gmail.com
-License: Apache 2
-Keywords: socks socks5 socks4 http proxy asyncio trio curio anyio
+Version: 2.6.0
+Summary: Proxy (SOCKS4, SOCKS5, HTTP CONNECT) client for Python
+Author-email: Roman Snegirev <snegiryev@gmail.com>
+License: Apache-2.0
+Project-URL: homepage, https://github.com/romis2012/python-socks
+Project-URL: repository, https://github.com/romis2012/python-socks
+Keywords: socks,socks5,socks4,http,proxy,asyncio,trio,curio,anyio
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Provides-Extra: asyncio
-Requires-Dist: async-timeout>=3.0.1; python_version < "3.11" and extra == "asyncio"
+Requires-Dist: async-timeout>=4.0; python_version < "3.11" and extra == "asyncio"
 Provides-Extra: trio
-Requires-Dist: trio>=0.16.0; extra == "trio"
+Requires-Dist: trio>=0.24; extra == "trio"
 Provides-Extra: curio
 Requires-Dist: curio>=1.4; extra == "curio"
 Provides-Extra: anyio
@@ -28,15 +47,15 @@ Requires-Dist: anyio<5.0.0,>=3.3.4; extra == "anyio"
 -->
 
 The `python-socks` package provides a core proxy client functionality for Python.
-Supports SOCKS4(a), SOCKS5(h), HTTP (tunneling) proxy and provides sync and async (asyncio, trio, curio, anyio) APIs.
+Supports `SOCKS4(a)`, `SOCKS5(h)`, `HTTP CONNECT` proxy and provides sync and async (asyncio, trio, curio, anyio) APIs.
 You probably don't need to use `python-socks` directly. 
 It is used internally by 
 [aiohttp-socks](https://github.com/romis2012/aiohttp-socks) and [httpx-socks](https://github.com/romis2012/httpx-socks) packages.  
 
 ## Requirements
-- Python >= 3.6
-- async-timeout >= 3.0.1 (optional)
-- trio >= 0.16.0 (optional)
+- Python >= 3.8
+- async-timeout >= 4.0 (optional)
+- trio >= 0.24 (optional)
 - curio >= 1.4 (optional)
 - anyio >= 3.3.4 (optional)
 

{python_socks-2.5.2 → python_socks-2.6.0}/README.md

@@ -8,15 +8,15 @@
 -->
 
 The `python-socks` package provides a core proxy client functionality for Python.
-Supports SOCKS4(a), SOCKS5(h), HTTP (tunneling) proxy and provides sync and async (asyncio, trio, curio, anyio) APIs.
+Supports `SOCKS4(a)`, `SOCKS5(h)`, `HTTP CONNECT` proxy and provides sync and async (asyncio, trio, curio, anyio) APIs.
 You probably don't need to use `python-socks` directly. 
 It is used internally by 
 [aiohttp-socks](https://github.com/romis2012/aiohttp-socks) and [httpx-socks](https://github.com/romis2012/httpx-socks) packages.  
 
 ## Requirements
-- Python >= 3.6
-- async-timeout >= 3.0.1 (optional)
-- trio >= 0.16.0 (optional)
+- Python >= 3.8
+- async-timeout >= 4.0 (optional)
+- trio >= 0.24 (optional)
 - curio >= 1.4 (optional)
 - anyio >= 3.3.4 (optional)
 

python_socks-2.6.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ['setuptools']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'python-socks'
+license = { text = 'Apache-2.0' }
+description = 'Proxy (SOCKS4, SOCKS5, HTTP CONNECT) client for Python'
+readme = 'README.md'
+authors = [{ name = 'Roman Snegirev', email = 'snegiryev@gmail.com' }]
+keywords = [
+    'socks',
+    'socks5',
+    'socks4',
+    'http',
+    'proxy',
+    'asyncio',
+    'trio',
+    'curio',
+    'anyio',
+]
+requires-python = ">=3.8.0"
+dynamic = ['version']
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Internet :: WWW/HTTP",
+    "Intended Audience :: Developers",
+    "Framework :: AsyncIO",
+    "Framework :: Trio",
+    "License :: OSI Approved :: Apache Software License",
+]
+
+[project.optional-dependencies]
+asyncio = ['async-timeout>=4.0; python_version < "3.11"']
+trio = ['trio>=0.24']
+curio = ['curio>=1.4']
+anyio = ['anyio>=3.3.4,<5.0.0']
+
+[project.urls]
+homepage = 'https://github.com/romis2012/python-socks'
+repository = 'https://github.com/romis2012/python-socks'
+
+[tool.setuptools.dynamic]
+version = { attr = 'python_socks.__version__' }
+
+[tool.setuptools.packages.find]
+include = ['python_socks*']
+
+[tool.black]
+line-length = 99
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+skip-string-normalization = true
+preview = true
+verbose = true
+
+[tool.pytest.ini_options]
+asyncio_mode = 'strict'

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_abc.py

@@ -1,27 +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()
-
-
-class AsyncProxy:
-    async 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 SyncResolver:
@@ -39,7 +16,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 +30,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-2.5.2 → python_socks-2.6.0}/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 @@ from .http_async import HttpAsyncConnector
 
 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-2.5.2 → python_socks-2.6.0}/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 @@ from .http_sync import HttpSyncConnector
 
 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-2.5.2 → python_socks-2.6.0}/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 @@ from .._protocols import http
 class HttpAsyncConnector(AsyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
+        username: Optional[str],
+        password: Optional[str],
         resolver: AsyncResolver,
     ):
         self._username = username

{python_socks-2.5.2 → python_socks-2.6.0}/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 @@ from .._protocols import http
 class HttpSyncConnector(SyncConnector):
     def __init__(
         self,
-        username: str,
-        password: str,
+        username: Optional[str],
+        password: Optional[str],
         resolver: SyncResolver,
     ):
         self._username = username

{python_socks-2.5.2 → python_socks-2.6.0}/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 @@ from .._helpers import is_ip_address
 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-2.5.2 → python_socks-2.6.0}/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 @@ from .._helpers import is_ip_address
 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-2.5.2 → python_socks-2.6.0}/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 @@ from .._helpers import is_ip_address
 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:
@@ -86,7 +87,8 @@ class Socks5AsyncConnector(AsyncConnector):
         elif addr_type == socks5.AddressType.IPV6:
             data += await stream.read_exact(18)
         elif addr_type == socks5.AddressType.DOMAIN:
-            host_len, *_ = await stream.read_exact(1)
+            data += await stream.read_exact(1)
+            host_len = data[-1]
             data += await stream.read_exact(host_len + 2)
 
         return data

{python_socks-2.5.2 → python_socks-2.6.0}/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 @@ from .._helpers import is_ip_address
 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:
@@ -77,7 +78,8 @@ class Socks5SyncConnector(SyncConnector):
         elif addr_type == socks5.AddressType.IPV6:
             data += stream.read_exact(18)
         elif addr_type == socks5.AddressType.DOMAIN:
-            host_len, *_ = stream.read_exact(1)
+            data += stream.read_exact(1)
+            host_len = data[-1]
             data += stream.read_exact(host_len + 2)
 
         return data

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_helpers.py

@@ -1,12 +1,17 @@
 import functools
 import re
+from typing import Optional, Tuple
 from urllib.parse import urlparse, unquote
 
 from ._types import ProxyType
 
-_ipv4_pattern = (r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}'
-                 r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$')
+# pylint:disable-next=invalid-name
+_ipv4_pattern = (
+    r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}'
+    r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
+)
 
+# pylint:disable-next=invalid-name
 _ipv6_pattern = (
     r'^(?:(?:(?:[A-F0-9]{1,4}:){6}|(?=(?:[A-F0-9]{0,4}:){0,6}'
     r'(?:[0-9]{1,3}\.){3}[0-9]{1,3}$)(([0-9A-F]{1,4}:){0,5}|:)'
@@ -15,7 +20,8 @@ _ipv6_pattern = (
     r'(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|(?:[A-F0-9]{1,4}:){7}'
     r'[A-F0-9]{1,4}|(?=(?:[A-F0-9]{0,4}:){0,7}[A-F0-9]{0,4}$)'
     r'(([0-9A-F]{1,4}:){1,7}|:)((:[0-9A-F]{1,4}){1,7}|:)|(?:[A-F0-9]{1,4}:){7}'
-    r':|:(:[A-F0-9]{1,4}){7})$')
+    r':|:(:[A-F0-9]{1,4}){7})$'
+)
 
 _ipv4_regex = re.compile(_ipv4_pattern)
 _ipv6_regex = re.compile(_ipv6_pattern, flags=re.IGNORECASE)
@@ -31,8 +37,9 @@ def _is_ip_address(regex, regexb, host):
     elif isinstance(host, (bytes, bytearray, memoryview)):
         return bool(regexb.match(host))
     else:
-        raise TypeError('{} [{}] is not a str or bytes'  # pragma: no cover
-                        .format(host, type(host)))
+        raise TypeError(
+            '{} [{}] is not a str or bytes'.format(host, type(host))  # pragma: no cover
+        )
 
 
 is_ipv4_address = functools.partial(_is_ip_address, _ipv4_regex, _ipv4_regexb)
@@ -43,7 +50,7 @@ def is_ip_address(host):
     return is_ipv4_address(host) or is_ipv6_address(host)
 
 
-def parse_proxy_url(url):
+def parse_proxy_url(url: str) -> Tuple[ProxyType, str, int, Optional[str], Optional[str]]:
     parsed = urlparse(url)
 
     scheme = parsed.scheme
@@ -62,12 +69,12 @@ def parse_proxy_url(url):
 
     try:
         port = parsed.port
-    except (ValueError, TypeError):  # pragma: no cover
-        raise ValueError('Invalid port component')
+        assert port is not None
+    except (ValueError, TypeError, AssertionError) as e:  # pragma: no cover
+        raise ValueError('Invalid port component') from e
 
     try:
-        username, password = (unquote(parsed.username),
-                              unquote(parsed.password))
+        username, password = (unquote(parsed.username), unquote(parsed.password))
     except (AttributeError, TypeError):
         username, password = '', ''
 

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_protocols/http.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass
 import base64
 import binascii
 from collections import namedtuple
+from typing import Optional
 
 from .._version import __title__, __version__
 
@@ -88,8 +89,8 @@ class _Buffer:
 class ConnectRequest:
     host: str
     port: int
-    username: str
-    password: str
+    username: Optional[str]
+    password: Optional[str]
 
     def dumps(self) -> bytes:
         buff = _Buffer()

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_protocols/socks4.py

@@ -2,6 +2,7 @@ import enum
 import ipaddress
 import socket
 from dataclasses import dataclass
+from typing import Optional
 
 from .errors import ReplyError
 from .._helpers import is_ipv4_address
@@ -38,7 +39,7 @@ ReplyMessages = {
 class ConnectRequest:
     host: str  # hostname or IPv4 address
     port: int
-    user_id: str
+    user_id: Optional[str]
 
     def dumps(self):
         port_bytes = self.port.to_bytes(2, 'big')

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_protocols/socks5.py

@@ -1,7 +1,7 @@
 import enum
 import ipaddress
 import socket
-import typing
+from typing import Optional, Union
 from dataclasses import dataclass, field
 
 from .errors import ReplyError
@@ -67,8 +67,8 @@ ReplyMessages = {
 
 @dataclass
 class AuthMethodsRequest:
-    username: str
-    password: str
+    username: Optional[str]
+    password: Optional[str]
     methods: bytearray = field(init=False)
 
     def __post_init__(self):
@@ -260,7 +260,7 @@ class StateServerWaitingForAuth:
 
 @dataclass
 class StateClientAuthenticated:
-    data: typing.Optional[AuthReply] = None
+    data: Optional[AuthReply] = None
 
 
 @dataclass
@@ -278,19 +278,19 @@ class StateServerConnected:
     data: ConnectReply
 
 
-Request = typing.Union[
+Request = Union[
     AuthMethodsRequest,
     AuthRequest,
     ConnectRequest,
 ]
 
-Reply = typing.Union[
+Reply = Union[
     AuthMethodReply,
     AuthReply,
     ConnectReply,
 ]
 
-ConnectionState = typing.Union[
+ConnectionState = Union[
     StateServerWaitingForAuthMethods,
     StateClientSentAuthMethods,
     StateServerWaitingForAuth,

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/_version.py

@@ -1,2 +1,2 @@
 __title__ = 'python-socks'
-__version__ = '2.5.2'
+__version__ = '2.6.0'

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/async_/_proxy_chain.py

@@ -1,9 +1,8 @@
 from typing import Iterable
-from .. import _abc as abc
 
 
 class ProxyChain:
-    def __init__(self, proxies: Iterable[abc.AsyncProxy]):
+    def __init__(self, proxies: Iterable):
         self._proxies = proxies
 
     async def connect(self, dest_host, dest_port, timeout=None):

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/async_/anyio/_proxy.py

@@ -1,5 +1,5 @@
 import ssl
-from typing import Optional
+from typing import Any, Optional
 
 import anyio
 
@@ -25,10 +25,10 @@ class AnyioProxy:
         proxy_type: ProxyType,
         host: str,
         port: int,
-        username: str = None,
-        password: str = None,
-        rdns: bool = None,
-        proxy_ssl: ssl.SSLContext = None,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+        rdns: Optional[bool] = None,
+        proxy_ssl: Optional[ssl.SSLContext] = None,
     ):
         self._proxy_type = proxy_type
         self._proxy_host = host
@@ -44,13 +44,15 @@ class AnyioProxy:
         self,
         dest_host: str,
         dest_port: int,
-        dest_ssl: ssl.SSLContext = None,
-        timeout: float = None,
-        _stream: AnyioSocketStream = None,
+        dest_ssl: Optional[ssl.SSLContext] = None,
+        timeout: Optional[float] = None,
+        **kwargs: Any,
     ) -> AnyioSocketStream:
         if timeout is None:
             timeout = DEFAULT_TIMEOUT
 
+        _stream = kwargs.get('_stream')
+
         try:
             with anyio.fail_after(timeout):
                 if _stream is None:
@@ -117,7 +119,7 @@ class AnyioProxy:
         return self._proxy_port
 
     @classmethod
-    def create(cls, *args, **kwargs):
+    def create(cls, *args, **kwargs):  # for backward compatibility
         return cls(*args, **kwargs)
 
     @classmethod

{python_socks-2.5.2 → python_socks-2.6.0}/python_socks/async_/anyio/v2/_proxy.py

@@ -1,4 +1,5 @@
 import ssl
+from typing import Optional
 
 import anyio
 
@@ -22,11 +23,11 @@ class AnyioProxy:
         proxy_type: ProxyType,
         host: str,
         port: int,
-        username: str = None,
-        password: str = None,
-        rdns: bool = None,
-        proxy_ssl: ssl.SSLContext = None,
-        forward: 'AnyioProxy' = None,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+        rdns: Optional[bool] = None,
+        proxy_ssl: Optional[ssl.SSLContext] = None,
+        forward: Optional['AnyioProxy'] = None,
     ):
         self._proxy_type = proxy_type
         self._proxy_host = host
@@ -44,8 +45,8 @@ class AnyioProxy:
         self,
         dest_host: str,
         dest_port: int,
-        dest_ssl: ssl.SSLContext = None,
-        timeout: float = None,
+        dest_ssl: Optional[ssl.SSLContext] = None,
+        timeout: Optional[float] = None,
     ) -> AnyioSocketStream:
         if timeout is None:
             timeout = DEFAULT_TIMEOUT
@@ -58,13 +59,15 @@ class AnyioProxy:
                     dest_ssl=dest_ssl,
                 )
         except TimeoutError as e:
-            raise ProxyTimeoutError('Proxy connection timed out: {}'.format(timeout)) from e
+            raise ProxyTimeoutError(
+                'Proxy connection timed out: {}'.format(timeout)
+            ) from e
 
     async def _connect(
         self,
         dest_host: str,
         dest_port: int,
-        dest_ssl: ssl.SSLContext = None,
+        dest_ssl: Optional[ssl.SSLContext] = None,
     ) -> AnyioSocketStream:
         if self._forward is None:
             try:
@@ -120,7 +123,7 @@ class AnyioProxy:
         return stream
 
     @classmethod
-    def create(cls, *args, **kwargs):
+    def create(cls, *args, **kwargs):  # for backward compatibility
         return cls(*args, **kwargs)
 
     @classmethod