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

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

@@ -1,5 +1,9 @@
 # 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).

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-multipart
-Version: 0.0.12
+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.12 → 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.12 → python_multipart-0.0.13}/pyproject.toml

@@ -55,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/"
@@ -62,13 +65,14 @@ 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

{python_multipart-0.0.12/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.12"
+__version__ = "0.0.13"
 
 from .multipart import (
     BaseParser,

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

@@ -25,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:
@@ -55,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
         """
@@ -97,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
@@ -118,7 +118,7 @@ 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.
 

{python_multipart-0.0.12/multipart → python_multipart-0.0.13/python_multipart}/multipart.py

@@ -241,7 +241,7 @@ class Field:
             value: the value of the form field - either a bytestring or None.
 
         Returns:
-            A new instance of a [`Field`][multipart.Field].
+            A new instance of a [`Field`][python_multipart.Field].
         """
 
         f = cls(name)
@@ -351,7 +351,7 @@ class File:
     | MAX_MEMORY_FILE_SIZE  | `int` | 1 MiB   | The maximum number of bytes of a File to keep in memory. By default, the contents of a File are kept into memory until a certain limit is reached, after which the contents of the File are written to a temporary file. This behavior can be disabled by setting this value to an appropriately large value (or, for example, infinity, such as `float('inf')`. |
 
     Args:
-        file_name: The name of the file that this [`File`][multipart.File] represents.
+        file_name: The name of the file that this [`File`][python_multipart.File] represents.
         field_name: The name of the form field that this file was uploaded with.  This can be None, if, for example,
             the file was uploaded with Content-Type application/octet-stream.
         config: The configuration for this File.  See above for valid configuration keys and their corresponding values.
@@ -663,7 +663,7 @@ class OctetStreamParser(BaseParser):
     | on_end         | None            | Called when the parser is finished parsing all data.|
 
     Args:
-        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][multipart.BaseParser].
+        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][python_multipart.BaseParser].
         max_size: The maximum size of body to parse.  Defaults to infinity - i.e. unbounded.
     """
 
@@ -733,12 +733,12 @@ class QuerystringParser(BaseParser):
     | on_end         | None            | Called when the parser is finished parsing all data.|
 
     Args:
-        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][multipart.BaseParser].
+        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][python_multipart.BaseParser].
         strict_parsing: Whether or not to parse the body strictly.  Defaults to False.  If this is set to True, then the
             behavior of the parser changes as the following: if a field has a value with an equal sign
             (e.g. "foo=bar", or "foo="), it is always included.  If a field has no equals sign (e.g. "...&name&..."),
             it will be treated as an error if 'strict_parsing' is True, otherwise included.  If an error is encountered,
-            then a [`QuerystringParseError`][multipart.exceptions.QuerystringParseError] will be raised.
+            then a [`QuerystringParseError`][python_multipart.exceptions.QuerystringParseError] will be raised.
         max_size: The maximum size of body to parse.  Defaults to infinity - i.e. unbounded.
     """  # noqa: E501
 
@@ -969,7 +969,7 @@ class MultipartParser(BaseParser):
 
     Args:
         boundary: The multipart boundary.  This is required, and must match what is given in the HTTP request - usually in the Content-Type header.
-        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][multipart.BaseParser].
+        callbacks: A dictionary of callbacks.  See the documentation for [`BaseParser`][python_multipart.BaseParser].
         max_size: The maximum size of body to parse.  Defaults to infinity - i.e. unbounded.
     """  # noqa: E501
 

{python_multipart-0.0.12 → python_multipart-0.0.13}/tests/test_multipart.py

@@ -11,9 +11,15 @@ from unittest.mock import Mock
 
 import yaml
 
-from multipart.decoders import Base64Decoder, QuotedPrintableDecoder
-from multipart.exceptions import DecodeError, FileError, FormParserError, MultipartParseError, QuerystringParseError
-from multipart.multipart import (
+from python_multipart.decoders import Base64Decoder, QuotedPrintableDecoder
+from python_multipart.exceptions import (
+    DecodeError,
+    FileError,
+    FormParserError,
+    MultipartParseError,
+    QuerystringParseError,
+)
+from python_multipart.multipart import (
     BaseParser,
     Field,
     File,
@@ -31,7 +37,7 @@ from .compat import parametrize, parametrize_class
 if TYPE_CHECKING:
     from typing import Any, Iterator, TypedDict
 
-    from multipart.multipart import FieldProtocol, FileConfig, FileProtocol
+    from python_multipart.multipart import FieldProtocol, FileConfig, FileProtocol
 
     class TestParams(TypedDict):
         name: str