Docstrings, typos and formatting

Author: defnull

CHANGELOG.rst

@@ -15,15 +15,15 @@ Release 1.4 (not released yet)
 ==============================
 
 * feat: Hardened (and faster) header validation.
-* change: Dropped support for Python 3.8 and 3.8 (both EOL)
+* change: Dropped support for Python 3.8 and 3.9 (both EOL)
 * change: Raise more helpful :exc:`ParserStateError` instead of implicit
   :exc:`AssertionError` or :exc:`TypeError` when the parser is used
   incorrectly.
 * change: Enforce `part_limit` (128 by default) for url-encoded data in
-  `parse_form_data()`. This is consistend with the handling of multipart
-  and an improtant safeguard against denial of service.
+  `parse_form_data()`. This is consistent with the handling of multipart
+  and an important safeguard against denial of service.
 * change: New strict-mode check to reject extremely large boundaries.
-* build: Change default brach to `main`.
+* build: Change default branch to `main`.
 
 
 Release 1.3

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2025, Marcel Hellkamp
+Copyright (c) 2010-2026, Marcel Hellkamp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -44,7 +44,7 @@ Features
 * 100% test coverage with test data from actual browsers and HTTP clients.
 * High throughput and low latency (see `benchmarks <https://github.com/defnull/multipart_bench>`_).
 * Predictable memory and disk resource consumption via fine grained limits.
-* Strict mode: Spent less time parsing malicious or broken inputs.
+* Strict mode: Spend less time parsing malicious or broken inputs.
 
 Scope and compatibility
 =======================

docs/index.rst

@@ -47,7 +47,7 @@ Features and Scope
 * 100% test coverage with test data from actual browsers and HTTP clients.
 * High throughput and low latency (see `benchmarks <https://github.com/defnull/multipart_bench>`_).
 * Predictable memory and disk resource consumption via fine grained limits.
-* Strict mode: Spent less time parsing malicious or broken inputs.
+* Strict mode: Spend less time parsing malicious or broken inputs.
 
 **Scope:** All parsers in this module implement ``multipart/form-data`` as defined by HTML5_
 and RFC7578_, supporting all modern browsers or HTTP clients in use today.
@@ -65,8 +65,8 @@ Installation
 
 ``pip install multipart`` or ``uv add multipart``
 
-Table of Content
-================
+Table of Contents
+=================
 
 .. toctree::
     :maxdepth: 2

docs/usage.rst

@@ -55,7 +55,7 @@ based environment:
             else:
               print("Form text field without a filename")
 
-          elif event:  # Non-empty batearray
+          elif event:  # Non-empty bytearray
             print(f"Received {len(event)} bytes of data")
 
           else:  # None
@@ -128,7 +128,7 @@ Buffered Parser
 The :class:`MultipartParser` parser is the lazy blocking cousin of
 :class:`PushMultipartParser`. It can read from a blocking byte stream (e.g.
 ``environ["wsgi.input"]``) and emits :class:`MultipartPart` instances that are
-either memory- or disk-buffered debending on size.
+either memory- or disk-buffered depending on size.
 
 The main benefit is that you no longer have to assemble the payload chunks of
 each segment yourself. It is still a streaming parser, which means you can start
@@ -156,7 +156,7 @@ Here is a basic example for a typical WSGI_ application:
           elif part.size < 1024:
             print(f"{part.name}: Text field ({part.value!r})")
           else:
-            print(f"{part.name}: Test field, but too big to print :/")
+            print(f"{part.name}: Text field, but too big to print :/")
 
         # Free up resources after use
         for part in parser.parts():
@@ -167,7 +167,7 @@ Results are cached, so you can iterate or call :meth:`MultipartParser.get` or
 
 Do not forget to :meth:`close() <MultipartPart.close>` all parts after use to
 remove unused temporary files quicker and avoid :exc:`ResourceWarning`.
-Framework developers may want to add hooks to automatically frees up resources
+Framework developers may want to add hooks to automatically free up resources
 after the request ended.
 
 
@@ -236,4 +236,3 @@ to do its job. Do not forget to add proper error handling.
     environ = dict(os.environ.items())
     environ['wsgi.input'] = sys.stdin.buffer
     forms, files = multipart.parse_form_data(environ)
-

multipart.py

@@ -6,11 +6,10 @@
 
 https://multipart.readthedocs.io/
 
-Copyright (c) 2010-2025, Marcel Hellkamp
+Copyright (c) 2010-2026, Marcel Hellkamp
 License: MIT (see LICENSE file)
 """
 
-
 __author__ = "Marcel Hellkamp"
 __version__ = "1.4.0-dev"
 __license__ = "MIT"
@@ -40,7 +39,7 @@
     Tuple,
     List,
     Callable,
-    Awaitable
+    Awaitable,
 )
 
 from urllib.parse import unquote_plus as _unquote_plus
@@ -479,7 +478,6 @@ def parse(self, chunk: t_ByteString) -> Generator[t_ParserEvent, None, None]:
             offset = 0
 
             while True:
-
                 if self._state is _PREAMBLE:
                     # Scan for first delimiter (CRLF prefix is optional here)
                     index = buffer.find(delimiter[2:], offset)
@@ -541,7 +539,6 @@ def parse(self, chunk: t_ByteString) -> Generator[t_ParserEvent, None, None]:
                         break  # wait for more data
 
                 elif self._state is _BODY:
-
                     # Ensure there is enough data in buffer to fit a delimiter
                     if offset + d_len + 2 > bufferlen:
                         break  # wait for more data
@@ -890,6 +887,9 @@ def __init__(
         data as needed to return the next part. Results are cached and the same
         part can be requested multiple times without extra cost.
 
+        Note that you should either set `partsize_limit` or `disk_limit` depending
+        on your specific requirements. Both are unlimited by default.
+
         :param stream: A readable byte stream or any other object that implements
           a :meth:`read(size) <io.BufferedIOBase.read>` method.
         :param boundary: The multipart boundary as found in the Content-Type header.
@@ -901,7 +901,7 @@ def __init__(
         :param header_limit: Maximum number of headers per part.
         :param headersize_limit: Maximum length of a single header line (name and value).
         :param part_limit: Maximum number of parts.
-        :param partsize_limit: Maximum content size of a single parts.
+        :param partsize_limit: Maximum content size of a single part.
         :param spool_limit: Parts up to this size are buffered in memory and count
           towards `memory_limit`. Larger parts are spooled to temporary files on
           disk and count towards `disk_limit`.
@@ -970,7 +970,7 @@ def _iterparse(self):
             max_segment_count=self.part_limit,
             max_segment_size=self.partsize_limit,
             header_charset=self.charset,
-            strict=self.strict
+            strict=self.strict,
         )
 
         with parser: