Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog #185

Merged
merged 5 commits into from
Aug 9, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ recursive-include docs Makefile make.bat conf.py *.rst

# Miscellaneous assets
include LICENSE
include NEWS
include README.rst
include pytest.ini
include tox.ini
40 changes: 40 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
w3lib release notes
===================

2.0.0 (to be released)
----------------------

Backwards incompatible changes:

- Python 2 is no longer supported; Python 3.6+ is required now (#168, #175).
- :func:`w3lib.url.safe_url_string` and :func:`w3lib.url.canonicalize_url`
no longer convert "%23" to "#" when it appears in URl path. This is a bug
fix. It's listed as a backwards incomatible change because in some
cases :func:`w3lib.url.canonicalize_url` output is going to change,
and so, if this output is used to generate URL fingerprints, fingerprints
might be incompatible with those created with the previous w3lib versions
(#141).

Deprecation removals (#169):

- ``w3lib.form`` module is removed.
- ``w3lib.html.remove_entities`` function is removed.
- ``w3lib.url.urljoin_rfc`` function is removed.

The following functions are deprecated, and will be removed in future releases
(#170):

- ``w3lib.util.str_to_unicode``
- ``w3lib.util.unicode_to_str``
- ``w3lib.util.to_native_str``
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These functions are not documented as :func:..., because they're not in w3lib.rst auto-generated API docs, and I didn't want to add them there.


Other improvements and bug fixes:

- Type annotations are added (#172, #184).
Gallaecio marked this conversation as resolved.
Show resolved Hide resolved
- Added support for Python 3.9 and 3.10 (#168, #176).
- Fixed :func:`w3lib.html.get_meta_refresh` for ``<meta>`` tags where
``http-equiv`` is written after ``content`` (#179).
- Fixed :func:`w3lib.url.safe_url_string` for IDNA domains with ports (#174).
- :func:`w3lib.url.url_query_cleaner` no longer adds an unneeded ``#`` when
``keep_fragments=True`` is passed, and URL doesn't have a fragment (#159).
- Removed a workaround for ancient pathname2url bug (#142)
- CI is migrated to Github Actions (#166, #177); other CI improvements (#160, #182).
- Code is formatted using black (#173)

1.22.0 (2020-05-13)
-------------------

Expand Down