bareutils 4.0.2__tar.gz → 5.0.0a2__tar.gz

bareutils-5.0.0a2/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: bareutils
+Version: 5.0.0a2
+Summary: Utilities for bareASGI and bareClient
+Author-email: Rob Blackbourn <rob.blackbourn@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://rob-blackbourn.github.io/bareUtils
+Project-URL: Repository, https://github.com/rob-blackbourn/bareUtils
+Project-URL: Issues, https://github.com/rob-blackbourn/bareUtils/issues
+Keywords: asgi,web,framework,asyncio,http
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: autopep8; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: jetblack-markdown; extra == "docs"
+Requires-Dist: mike; extra == "docs"
+Dynamic: license-file
+
+# bareutils
+
+Utilities for [bareASGI](https://github.com/rob-blackbourn/bareASGI)
+and [bareClient](https://github.com/rob-blackbourn/bareClient)
+(read the [docs](https://rob-blackbourn.github.io/bareUtils/)).
+
+## Installation
+
+The package can be installed with pip.
+
+```bash
+pip install bareutils
+```
+
+This is a Python 3.12 and later package.

{bareutils-4.0.2 → bareutils-5.0.0a2}/README.md

@@ -12,4 +12,4 @@ The package can be installed with pip.
 pip install bareutils
 ```
 
-This is a Python3.7 and later package.
+This is a Python 3.12 and later package.

bareutils-5.0.0a2/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+name = "bareutils"
+version = "5.0.0-alpha.2"
+description = "Utilities for bareASGI and bareClient"
+authors = [
+    { name = "Rob Blackbourn", email = "rob.blackbourn@gmail.com" }
+]
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+]
+readme = "README.md"
+license = "Apache-2.0"
+license-files = [
+    "LICENSE"
+]
+keywords = [
+    "asgi",
+    "web",
+    "framework",
+    "asyncio",
+    "http",
+]
+
+[project.optional-dependencies]
+dev = [
+    "autopep8",
+    "coverage",
+    "mypy",
+    "pytest",
+    "pytest-asyncio",
+    "pylint",
+    "types-setuptools",
+]
+docs = [
+    "mkdocs",
+    "mkdocs-material",
+    "jetblack-markdown",
+    "mike",
+]
+
+[project.urls]
+Homepage = "https://rob-blackbourn.github.io/bareUtils"
+Repository = "https://github.com/rob-blackbourn/bareUtils"
+Issues = "https://github.com/rob-blackbourn/bareUtils/issues"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+# pylint
+[tool.pylint.main]
+py-version = "3.12"
+jobs = 4
+
+[tool.pylint.basic]
+good-names = ["i", "j", "k", "ex", "Run", "_"]
+bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"]
+
+[tool.pylint."messages control"]
+disable = [
+    "raw-checker-failed",
+    "bad-inline-option",
+    "locally-disabled",
+    "file-ignored",
+    "suppressed-message",
+    "useless-suppression",
+    "deprecated-pragma",
+    "use-symbolic-message-instead",
+    "use-implicit-booleaness-not-comparison-to-string",
+    "use-implicit-booleaness-not-comparison-to-zero",
+    "missing-module-docstring",
+]
+
+# pytest
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+asyncio_default_fixture_loop_scope = "session"
+asyncio_default_test_loop_scope = "function"
+
+# mypy
+[tool.mypy]
+files = [ "src/bareutils", "tests" ]
+
+[[tool.mypy.overrides]]
+module = "pytest"
+ignore_missing_imports = true

bareutils-5.0.0a2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/__init__.py

@@ -31,6 +31,8 @@ from .cookies import (
     decode_cookies
 )
 
+__version__ = "5.0.0.alpha.1"
+
 __all__ = [
     "text_writer",
     "text_reader",

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/compression.py

@@ -1,10 +1,13 @@
-"""
-Compression streaming.
+"""Compression utilities
+
+Only compression directly supported by standard library functions are provided
+here to avoid the need for additional dependencies. Other compression methods
+should be implemented in a separate module.
 """
 
 from __future__ import annotations
 from abc import ABCMeta, abstractmethod
-from typing import AsyncIterable, Callable, Optional, cast
+from typing import AsyncIterable, Callable, cast
 import zlib
 
 from .streaming import bytes_writer, bytes_reader
@@ -24,6 +27,7 @@ class Compressor(metaclass=ABCMeta):
             bytes: The compressed buffer.
         """
 
+    @abstractmethod
     def flush(self) -> bytes:
         """Flush the compressor
 
@@ -116,29 +120,82 @@ class Decompressor(metaclass=ABCMeta):
     @property
     @abstractmethod
     def unused_data(self) -> bytes:
-        ...
+        """A bytes object which contains any bytes past the end of the
+        compressed data.
+
+        That is, this remains b"" until the last byte that contains compression
+        data is available. If the whole bytestring turned out to contain
+        compressed data, this is b"", an empty bytes object.
+        """
 
     @property
     @abstractmethod
     def unconsumed_tail(self) -> bytes:
-        ...
+        """A bytes object that contains any data that was not consumed by the
+        last decompress() call because it exceeded the limit for the
+        uncompressed data buffer.
+        """
 
     @property
     @abstractmethod
     def eof(self) -> bool:
-        ...
+        """A boolean indicating whether the end of the compressed data stream has been reached.
+
+        This makes it possible to distinguish between a properly formed compressed
+        stream, and an incomplete or truncated one.
+        """
 
     @abstractmethod
     def decompress(self, buf: bytes, max_length: int = 0) -> bytes:
-        ...
+        """Decompress data, returning a bytes object containing the uncompressed
+        data corresponding to at least part of the data in string.
+
+        This data should be concatenated to the output produced by any preceding
+        calls to the decompress() method. Some of the input data may be
+        preserved in internal buffers for later processing.
+
+        If the optional parameter max_length is non-zero then the return value
+        will be no longer than max_length. This may mean that not all of the
+        compressed input can be processed; and unconsumed data will be stored in
+        the attribute unconsumed_tail. This bytestring must be passed to a
+        subsequent call to decompress() if decompression is to continue. If
+        max_length is zero then the whole input is decompressed, and
+        unconsumed_tail is empty.
+
+        Args:
+            buf (bytes): The data to decompress.
+            max_length (int, optional): Max length of output. Defaults to 0.
+
+        Returns:
+            bytes: The decompressed data.
+        """
 
     @abstractmethod
-    def flush(self, length: Optional[int] = None) -> bytes:
-        ...
+    def flush(self, length: int | None = None) -> bytes:
+        """All pending input is processed, and a bytes object containing the
+        remaining uncompressed output is returned. After calling flush(), the
+        decompress() method cannot be called again; the only realistic action is
+        to delete the object.
+
+        Args:
+            length (int | None, optional): The initial size of the output
+                buffer. Defaults to None.
+
+        Returns:
+            bytes: The remaining uncompressed output.
+        """
 
     @abstractmethod
     def copy(self) -> Decompressor:
-        ...
+        """Returns a copy of the decompression object.
+
+        This can be used to save the state of the decompressor midway through
+        the data stream in order to speed up random seeks into the stream at a
+        future point.
+
+        Returns:
+            Decompressor: A copy of the decompressor.
+        """
 
 
 DecompressorFactory = Callable[[], Decompressor]
@@ -178,7 +235,7 @@ def make_compress_decompressobj() -> Decompressor:
     """
     return cast(
         Decompressor,
-        zlib.decompressobj(9, zlib.DEFLATED, zlib.MAX_WBITS) # type: ignore
+        zlib.decompressobj(zlib.MAX_WBITS)
     )
 
 
@@ -186,6 +243,18 @@ async def compression_reader_adapter(
         reader: AsyncIterable[bytes],
         decompressobj: Decompressor
 ) -> AsyncIterable[bytes]:
+    """Adapters a reader to decompress the data.
+
+    Args:
+        reader (AsyncIterable[bytes]): The reader.
+        decompressobj (Decompressor): The decompressor.
+
+    Returns:
+        AsyncIterable[bytes]: An async iterable of decompressed bytes.
+
+    Yields:
+        bytes: Decompressed bytes.
+    """
     async for item in reader:
         yield decompressobj.decompress(item)
     yield decompressobj.flush()
@@ -195,4 +264,13 @@ async def compression_reader(
         source: AsyncIterable[bytes],
         decompressobj: Decompressor
 ) -> bytes:
+    """Reads a compressed stream and returns the decompressed bytes.
+
+    Args:
+        source (AsyncIterable[bytes]): The input stream.
+        decompressobj (Decompressor): The decompressor.
+
+    Returns:
+        bytes: The decompressed bytes.
+    """
     return await bytes_reader(compression_reader_adapter(source, decompressobj))

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/cookies.py

@@ -3,12 +3,8 @@
 from datetime import datetime, timedelta
 from typing import (
     Any,
-    Dict,
-    List,
     Mapping,
-    MutableMapping,
-    Optional,
-    Union
+    MutableMapping
 )
 
 from .dates import parse_date
@@ -19,13 +15,13 @@ def encode_set_cookie(
         name: bytes,
         value: bytes,
         *,
-        expires: Optional[datetime] = None,
-        max_age: Optional[Union[int, timedelta]] = None,
-        path: Optional[bytes] = None,
-        domain: Optional[bytes] = None,
+        expires: datetime | None = None,
+        max_age: int | timedelta | None = None,
+        path: bytes | None = None,
+        domain: bytes | None = None,
         secure: bool = False,
         http_only: bool = False,
-        same_site: Optional[bytes] = None
+        same_site: bytes | None = None
 ) -> bytes:
     """Encode set-cookie
 
@@ -45,14 +41,13 @@ def encode_set_cookie(
         same_site (Optional[bytes], optional): CORS directive. Defaults to None.
 
     Raises:
-        RuntimeError: Raised if the __Secure- or __Host- was used without secure
-        ValueError: If a date could not be parsed.
+        ValueError: Raised if the __Secure- or __Host- was used without secure
 
     Returns:
         bytes: The set-cookie header
     """
     if not secure and (name.startswith(b'__Secure-') or name.startswith(b'__Host-')):
-        raise RuntimeError(
+        raise ValueError(
             'Keys starting __Secure- or __Host- require the secure directive'
         )
 
@@ -89,8 +84,8 @@ def encode_set_cookie(
 def decode_set_cookie(set_cookie: bytes) -> Mapping[str, Any]:
     """Decode a set-cookie header into a dictionary.
 
-    The `max-age` value is represented as a `datatime.timedelta`.
-    The `expires` value is represented as a `datetine.datetime`.
+    The `max-age` value is represented as a `datetime.timedelta`.
+    The `expires` value is represented as a `datetime.datetime`.
     The `secure` value is represented as a `bool`.
 
     Args:
@@ -101,26 +96,26 @@ def decode_set_cookie(set_cookie: bytes) -> Mapping[str, Any]:
     """
     i = iter(set_cookie.split(b';'))
     key, _, value = next(i).partition(b'=')
-    result: Dict[str, Any] = {'name': key, 'value': value}
+    result: dict[str, Any] = {'name': key, 'value': value}
     for item in i:
         key, _, value = item.partition(b'=')
-        name = key.lower().strip().decode('ascii')
-        if name == 'secure':
-            result['secure'] = True
-        elif name == 'httponly':
-            result['http_only'] = True
-        elif name == 'expires':
-            result['expires'] = parse_date(value.decode('ascii'))
-        elif name == 'max-age':
-            result['max_age'] = timedelta(seconds=int(value))
-        elif name == 'samesite':
-            result['same_site'] = value.decode('ascii')
-        else:
-            result[name] = value
+        match key.lower().strip():
+            case b'secure':
+                result['secure'] = True
+            case b'httponly':
+                result['http_only'] = True
+            case b'expires':
+                result['expires'] = parse_date(value.decode('ascii'))
+            case b'max-age':
+                result['max_age'] = timedelta(seconds=int(value))
+            case b'samesite':
+                result['same_site'] = value
+            case name:
+                result[name.decode('ascii')] = value
     return result
 
 
-def encode_cookies(cookies: Mapping[bytes, List[bytes]]) -> bytes:
+def encode_cookies(cookies: Mapping[bytes, list[bytes]]) -> bytes:
     """Encode the cookie header
 
     Args:
@@ -136,16 +131,16 @@ def encode_cookies(cookies: Mapping[bytes, List[bytes]]) -> bytes:
     )
 
 
-def decode_cookies(cookies: bytes) -> Mapping[bytes, List[bytes]]:
+def decode_cookies(cookies: bytes) -> Mapping[bytes, list[bytes]]:
     """Decode a cookie header
 
     Args:
         cookies (bytes): The header
 
     Returns:
-        Mapping[bytes, List[bytes]]: The cookies
+        Mapping[bytes, list[bytes]]: The cookies
     """
-    result: MutableMapping[bytes, List[bytes]] = dict()
+    result: MutableMapping[bytes, list[bytes]] = {}
     for morsel in cookies.rstrip(b'; ').split(b'; '):
         name, _, value = morsel.partition(b'=')
         result.setdefault(name, []).append(value)
@@ -156,12 +151,12 @@ def make_cookie(
         key: bytes,
         value: bytes,
         *,
-        expires: Optional[Union[datetime, timedelta]] = None,
-        path: Optional[bytes] = None,
-        domain: Optional[bytes] = None,
+        expires: datetime | timedelta | None = None,
+        path: bytes | None = None,
+        domain: bytes | None = None,
         secure: bool = False,
         http_only: bool = False,
-        same_site: Optional[bytes] = None
+        same_site: bytes | None = None
 ) -> bytes:
     """Make a set-cookie header
 

bareutils-5.0.0a2/src/bareutils/dates/constants.py

@@ -0,0 +1,7 @@
+"""Constants for date and time operations."""
+
+DAY_NAMES = ("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")
+MONTH_NAMES = (
+    "Jan", "Feb", "Mar", "Apr", "May", "Jun",
+    "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
+)

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/dates/helpers.py

@@ -1,13 +1,12 @@
 """Date helpers"""
 
 from datetime import datetime
-from typing import Optional
 
 from . import rfc_7231
 from . import rfc_850
 
 
-def try_parse_date(value: str) -> Optional[datetime]:
+def try_parse_date(value: str) -> datetime | None:
     """Try to parse a date
 
     Args:

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/dates/rfc_7231.py

@@ -1,20 +1,18 @@
-"""RFC7231"""
+"""RFC 7231"""
 
 from datetime import datetime, timezone
 import re
-from typing import Optional
+
+from .constants import DAY_NAMES, MONTH_NAMES
 
 # pylint: disable=line-too-long
 # Date: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
 DATE_PATTERN = re.compile(
     r'^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), (\d{2}) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (\d{4}) (\d{2}):(\d{2}):(\d{2}) GMT$'
 )
-DAY_NAMES = ("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")
-MONTH_NAMES = ("Jan", "Feb", "Mar", "Apr", "May", "Jun",
-               "Jul", "Aug", "Sep", "Oct", "Nov", "Dec")
 
 
-def try_parse_date(value: str) -> Optional[datetime]:
+def try_parse_date(value: str) -> datetime | None:
     """Parse a date according to RFC 7231, section 7.1.1.2: Date
 
     Args:

{bareutils-4.0.2 → bareutils-5.0.0a2/src}/bareutils/dates/rfc_850.py

@@ -2,18 +2,16 @@
 
 from datetime import datetime, timezone
 import re
-from typing import Optional
+
+from .constants import DAY_NAMES, MONTH_NAMES
 
 # 'Mon, 23-Mar-20 07:36:36 GMT'
 DATE_PATTERN = re.compile(
     r'^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), (\d{2})-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(\d{2}) (\d{2}):(\d{2}):(\d{2}) GMT$'
 )
-DAY_NAMES = ("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")
-MONTH_NAMES = ("Jan", "Feb", "Mar", "Apr", "May", "Jun",
-               "Jul", "Aug", "Sep", "Oct", "Nov", "Dec")
 
 
-def try_parse_date(value: str) -> Optional[datetime]:
+def try_parse_date(value: str) -> datetime | None:
     """Parse a date according to RFC 850.
 
     e.g. 'Mon, 23-Mar-20 07:36:36 GMT'
@@ -58,7 +56,7 @@ def format_date(value: datetime) -> str:
         day=DAY_NAMES[time_tuple.tm_wday],
         mday=time_tuple.tm_mday,
         mon=MONTH_NAMES[time_tuple.tm_mon - 1],
-        year=2000-time_tuple.tm_year,
+        year=time_tuple.tm_year % 100,
         hour=time_tuple.tm_hour,
         min=time_tuple.tm_min,
         sec=time_tuple.tm_sec