python-multipart 0.0.11__tar.gz → 0.0.13__tar.gz

{python_multipart-0.0.11 → python_multipart-0.0.13}/.gitignore

@@ -89,6 +89,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+.ruff_cache/
 cover/
 
 # Translations

{python_multipart-0.0.11 → python_multipart-0.0.13}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.0.13 (2024-10-20)
+
+* Rename import to `python_multipart` [#166](https://github.com/Kludex/python-multipart/pull/166).
+
+## 0.0.12 (2024-09-29)
+
+* Improve error message when boundary character does not match [#124](https://github.com/Kludex/python-multipart/pull/124).
+* Add mypy strict typing [#140](https://github.com/Kludex/python-multipart/pull/140).
+* Enforce 100% coverage [#159](https://github.com/Kludex/python-multipart/pull/159).
+
 ## 0.0.11 (2024-09-28)
 
 * Improve performance, especially in data with many CR-LF [#137](https://github.com/Kludex/python-multipart/pull/137).

{python_multipart-0.0.11 → python_multipart-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-multipart
-Version: 0.0.11
+Version: 0.0.13
 Summary: A streaming multipart parser for Python
 Project-URL: Homepage, https://github.com/Kludex/python-multipart
 Project-URL: Documentation, https://kludex.github.io/python-multipart/
@@ -38,12 +38,3 @@ Test coverage is currently 100%.
 ## Why?
 
 Because streaming uploads are awesome for large files.
-
-## How to Test
-
-If you want to test:
-
-```bash
-$ pip install '.[dev]'
-$ inv test
-```

{python_multipart-0.0.11 → python_multipart-0.0.13}/README.md

@@ -11,12 +11,3 @@ Test coverage is currently 100%.
 ## Why?
 
 Because streaming uploads are awesome for large files.
-
-## How to Test
-
-If you want to test:
-
-```bash
-$ pip install '.[dev]'
-$ inv test
-```

python_multipart-0.0.13/_python_multipart.pth

@@ -0,0 +1 @@
+import _python_multipart_loader

python_multipart-0.0.13/_python_multipart_loader.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+# The purpose of this file is to allow `import multipart` to continue to work
+# unless `multipart` (the PyPI package) is also installed, in which case
+# a collision is avoided, and `import multipart` is no longer injected.
+import importlib
+import importlib.abc
+import importlib.machinery
+import importlib.util
+import sys
+import warnings
+
+
+class PythonMultipartCompatFinder(importlib.abc.MetaPathFinder):
+    def find_spec(
+        self, fullname: str, path: object = None, target: object = None
+    ) -> importlib.machinery.ModuleSpec | None:
+        if fullname != "multipart":
+            return None
+        old_sys_meta_path = sys.meta_path
+        try:
+            sys.meta_path = [p for p in sys.meta_path if not isinstance(p, type(self))]
+            if multipart := importlib.util.find_spec("multipart"):
+                return multipart
+
+            warnings.warn("Please use `import python_multipart` instead.", FutureWarning, stacklevel=2)
+            sys.modules["multipart"] = importlib.import_module("python_multipart")
+            return importlib.util.find_spec("python_multipart")
+        finally:
+            sys.meta_path = old_sys_meta_path
+
+
+def install() -> None:
+    sys.meta_path.insert(0, PythonMultipartCompatFinder())
+
+
+install()

{python_multipart-0.0.11 → python_multipart-0.0.13}/pyproject.toml

@@ -45,6 +45,8 @@ dev-dependencies = [
     "invoke==2.2.0",
     "pytest-timeout==2.3.1",
     "ruff==0.3.4",
+    "mypy",
+    "types-PyYAML",
     "atheris==2.3.0; python_version != '3.12'",
     # Documentation
     "mkdocs",
@@ -53,6 +55,9 @@ dev-dependencies = [
     "mkdocs-autorefs",
 ]
 
+[tool.uv.pip]
+reinstall-package = ["python-multipart"]
+
 [project.urls]
 Homepage = "https://github.com/Kludex/python-multipart"
 Documentation = "https://kludex.github.io/python-multipart/"
@@ -60,13 +65,17 @@ Changelog = "https://github.com/Kludex/python-multipart/blob/master/CHANGELOG.md
 Source = "https://github.com/Kludex/python-multipart"
 
 [tool.hatch.version]
-path = "multipart/__init__.py"
-
-[tool.hatch.build.targets.wheel]
-packages = ["multipart"]
+path = "python_multipart/__init__.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["/multipart", "/tests", "CHANGELOG.md", "LICENSE.txt"]
+include = ["/python_multipart", "/tests", "CHANGELOG.md", "LICENSE.txt", "_python_multipart.pth", "_python_multipart_loader.py"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"_python_multipart.pth" = "_python_multipart.pth"
+"_python_multipart_loader.py" = "_python_multipart_loader.py"
+
+[tool.mypy]
+strict = true
 
 [tool.ruff]
 line-length = 120
@@ -87,7 +96,7 @@ branch = false
 omit = ["tests/*"]
 
 [tool.coverage.report]
-# fail_under = 100
+fail_under = 100
 skip_covered = true
 show_missing = true
 exclude_lines = [

{python_multipart-0.0.11/multipart → python_multipart-0.0.13/python_multipart}/__init__.py

@@ -2,7 +2,7 @@
 __author__ = "Andrew Dunham"
 __license__ = "Apache"
 __copyright__ = "Copyright (c) 2012-2013, Andrew Dunham"
-__version__ = "0.0.11"
+__version__ = "0.0.13"
 
 from .multipart import (
     BaseParser,

{python_multipart-0.0.11/multipart → python_multipart-0.0.13/python_multipart}/decoders.py

@@ -1,9 +1,22 @@
 import base64
 import binascii
-from io import BufferedWriter
+from typing import TYPE_CHECKING
 
 from .exceptions import DecodeError
 
+if TYPE_CHECKING:  # pragma: no cover
+    from typing import Protocol, TypeVar
+
+    _T_contra = TypeVar("_T_contra", contravariant=True)
+
+    class SupportsWrite(Protocol[_T_contra]):
+        def write(self, __b: _T_contra) -> object: ...
+
+        # No way to specify optional methods. See
+        # https://github.com/python/typing/issues/601
+        # close() [Optional]
+        # finalize() [Optional]
+
 
 class Base64Decoder:
     """This object provides an interface to decode a stream of Base64 data.  It
@@ -12,7 +25,7 @@ class Base64Decoder:
     call write() on the underlying object.  This is primarily used for decoding
     form data encoded as Base64, but can be used for other purposes::
 
-        from multipart.decoders import Base64Decoder
+        from python_multipart.decoders import Base64Decoder
         fd = open("notb64.txt", "wb")
         decoder = Base64Decoder(fd)
         try:
@@ -34,7 +47,7 @@ class Base64Decoder:
     :param underlying: the underlying object to pass writes to
     """
 
-    def __init__(self, underlying: BufferedWriter):
+    def __init__(self, underlying: "SupportsWrite[bytes]") -> None:
         self.cache = bytearray()
         self.underlying = underlying
 
@@ -42,7 +55,7 @@ class Base64Decoder:
         """Takes any input data provided, decodes it as base64, and passes it
         on to the underlying object.  If the data provided is invalid base64
         data, then this method will raise
-        a :class:`multipart.exceptions.DecodeError`
+        a :class:`python_multipart.exceptions.DecodeError`
 
         :param data: base64 data to decode
         """
@@ -67,9 +80,9 @@ class Base64Decoder:
         # Get the remaining bytes and save in our cache.
         remaining_len = len(data) % 4
         if remaining_len > 0:
-            self.cache = data[-remaining_len:]
+            self.cache[:] = data[-remaining_len:]
         else:
-            self.cache = b""
+            self.cache[:] = b""
 
         # Return the length of the data to indicate no error.
         return len(data)
@@ -84,7 +97,7 @@ class Base64Decoder:
     def finalize(self) -> None:
         """Finalize this object.  This should be called when no more data
         should be written to the stream.  This function can raise a
-        :class:`multipart.exceptions.DecodeError` if there is some remaining
+        :class:`python_multipart.exceptions.DecodeError` if there is some remaining
         data in the cache.
 
         If the underlying object has a `finalize()` method, this function will
@@ -105,14 +118,14 @@ class Base64Decoder:
 class QuotedPrintableDecoder:
     """This object provides an interface to decode a stream of quoted-printable
     data.  It is instantiated with an "underlying object", in the same manner
-    as the :class:`multipart.decoders.Base64Decoder` class.  This class behaves
+    as the :class:`python_multipart.decoders.Base64Decoder` class.  This class behaves
     in exactly the same way, including maintaining a cache of quoted-printable
     chunks.
 
     :param underlying: the underlying object to pass writes to
     """
 
-    def __init__(self, underlying: BufferedWriter) -> None:
+    def __init__(self, underlying: "SupportsWrite[bytes]") -> None:
         self.cache = b""
         self.underlying = underlying
 
@@ -160,7 +173,7 @@ class QuotedPrintableDecoder:
         call it.
         """
         # If we have a cache, write and then remove it.
-        if len(self.cache) > 0:
+        if len(self.cache) > 0:  # pragma: no cover
             self.underlying.write(binascii.a2b_qp(self.cache))
             self.cache = b""