Skip to content

Commit

Permalink
Clarify dots canonicalisation change is breaking
Browse files Browse the repository at this point in the history
The handling of package names within the Python packaging ecosystem
is unfortunately not in a great state at the moment. There exist
a large number of packages which contain characters which (some of)
the specs indicate are invalid, yet there is not a clear migration
path nor destination at the moment.

Poetry's approach is to normalise project names towards their
"canonical" form, meaning that existing projects on PyPI which
use the more relaxed name forms will be silently renamed if they
move to (recent versions of) Poetry. As well as changing the name
of these packages (which maintainers are unlikely to expect nor
desire) this unfortunately ends up breaking introspection via
`importlib.metadata` in Python 3.8 and 3.9 which are not aware of
the canonicalisation rules which Poetry is using.

Adding this compatibility note informs maintainers so that they can
decide how (and if) they want this name canonicalisation to happen.

See also python-poetry#6198
  • Loading branch information
PeterJCLaw committed Mar 5, 2023
1 parent f27308f commit a047f08
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@
- Fixed several style issues in the docs ([#6254](https://github.com/python-poetry/poetry/pull/6254))
- Fixed outdated info about `--only` parameter ([#6263](https://github.com/python-poetry/poetry/pull/6263))

### Breaking

- Packages with dots in their names will be canonicalised to underscores for compatibility with PEP 503. This will rename projects on PYPI and is potentially breaking on Python versions earlier than 3.10, which may need to use [`importlib-metadata`](https://pypi.org/project/importlib-metadata/) rather than standard library [`importlib.metadata`](https://docs.python.org/3/library/importlib.metadata.html). ([#6022](https://github.com/python-poetry/poetry/pull/6022))


## [1.2.0rc2] - 2022-08-26

Expand Down

0 comments on commit a047f08

Please sign in to comment.