Skip to content

Commit

Permalink
docs: Move changelog to separate file
Browse files Browse the repository at this point in the history
  • Loading branch information
defnull committed Oct 8, 2024
1 parent 2044511 commit 1d5ad97
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 68 deletions.
70 changes: 70 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
=========
Changelog
=========

Release 1.1
===========

Some of these fixes changed behavior to match documentation or specification, none of them should be a surprise. Existing apps should be able to upgrade without change.

* fix: Fail faster on input with invalid line breaks (#55)
* fix: Allow empty segment names (#56)
* fix: Avoid ResourceWarning when using parse_form_data (#57)
* fix: MultipartPart now always has a sensible content type.
* fix: Actually check parser state on context manager exit.
* fix: Honor Content-Length header, if present.
* perf: Reduce overhead for small segments (-21%)
* perf: Reduce write overhead for large uploads (-2%)

Release 1.0
===========

This release introduces a completely new, fast, non-blocking ``PushMultipartParser`` parser, which now serves as the basis for all other parsers.

* feat: ``PushMultipartParser`` parser
* change: Stricter parser rejects clearly broken input quicker, even in non-strict mode (e.g. invalid line breaks or header names). This should not affect data sent by actual browsers or HTTP clients.
* change: Default charset for ``MultipartParser`` headers and text fields changed to ``utf8``, as recommended by W3C HTTP.
* change: Default disk and memory limits for ``MultipartParser`` increased, but multiple other limits added for finer control. Check if the the new defaults still fit your needs.
* change: Undocumented APIs deprecated or removed, some of which were not strictly private. This includes parameters for ``MultipartParser`` and some ``MultipartPart`` methods, but those should not be used by anyone but the parser itself.

Release 0.2
===========

* change: Dropped support for Python versions below 3.6. Stay on 0.1 if you need Python 2.5+ support.

Patch 0.2.1
-----------

* fix: empty payload (#20)

Patch 0.2.2
-----------

* fix: ResourceWarnings on Python 3 (#21)

Patch 0.2.3
-----------

* fix: Import MutableMapping from collections.abc (#23)
* fix: Allow stream to contain data before first boundary (#25)
* tests: Fix a few more ResourceWarnings in the test suite (#24)

Patch 0.2.4
-----------

* dix: Consistently decode non-utf8 URL-encoded form-data

Patch 0.2.5
-----------

* security: Don't test semicolon separators in urlencoded data (#33)
* build: Add python-requires directive, indicating Python 3.5 or later is required and preventing older Pythons from attempting to download this version (#32)
* fix: Add official support for Python 3.10-3.12 (#38, #48)
* dix: Default value of ``copy_file`` should be ``2 ** 16``, not ``2 * 16`` (#41)
* docs: Update URL for Bottle (#42)


Release 0.1
===========

* First release
68 changes: 0 additions & 68 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,71 +184,3 @@ all the other parsers in this library:
else: # Result is None
print(f"== End of segment")
Changelog
=========

* **1.1**

* Some of these fixes changed behavior to match documentation or specification,
none of them should be a surprise. Existing apps should be able to upgrade
without change.
* fix: Fail faster on input with invalid line breaks (#55)
* fix: Allow empty segment names (#56)
* fix: Avoid ResourceWarning when using parse_form_data (#57)
* fix: MultipartPart now always has a sensible content type.
* fix: Actually check parser state on context manager exit.
* fix: Honor Content-Length header, if present.
* perf: Reduce overhead for small segments (-21%)
* perf: Reduce write overhead for large uploads (-2%)

* **1.0**

* A completely new, fast, non-blocking ``PushMultipartParser`` parser, which
now serves as the basis for all other parsers.
* The new parser is stricter and rejects clearly broken input quicker, even in
non-strict mode (e.g. invalid line breaks or header names). This should not
affect data sent by actual browsers or HTTP clients.
* Default charset for ``MultipartParser`` headers and text fields changed to
``utf8``, as recommended by W3C HTTP.
* Default disk and memory limits for ``MultipartParser`` increased, but
multiple other limits added for finer control. Check if the the new defaults
still fit your needs.
* Undocumented APIs deprecated or removed, some of which were not strictly
private. This includes parameters for ``MultipartParser`` and some
``MultipartPart`` methods, but those should not be used by anyone but the
parser itself.

* **0.2.5**

* Don't test semicolon separators in urlencoded data (#33)
* Add python-requires directive, indicating Python 3.5 or later is required and preventing older Pythons from attempting to download this version (#32)
* Add official support for Python 3.10-3.12 (#38, #48)
* Default value of ``copy_file`` should be ``2 ** 16``, not ``2 * 16`` (#41)
* Update URL for Bottle (#42)

* **0.2.4**

* Consistently decode non-utf8 URL-encoded form-data

* **0.2.3**

* Import MutableMapping from collections.abc (#23)
* Fix a few more ResourceWarnings in the test suite (#24)
* Allow stream to contain data before first boundary (#25)

* **0.2.2**

* Fix #21 ResourceWarnings on Python 3

* **0.2.1**

* Fix #20 empty payload

* **0.2**

* Dropped support for Python versions below 3.6. Stay on 0.1 if you need Python 2.5+ support.

* **0.1**

* First release

0 comments on commit 1d5ad97

Please sign in to comment.