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

#1316 Update packaging-projects.rst with a tip on good module naming #1424

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
17e76be
Update packaging-projects.rst with a tip on good module naming
LLyaudet Nov 30, 2023
1815996
Update packaging-projects.rst add empty line after items
LLyaudet Dec 1, 2023
24d81e5
Update packaging-projects.rst ???
LLyaudet Dec 1, 2023
b8890ba
Update packaging-projects.rst use intersphinx
LLyaudet Dec 1, 2023
74af3e9
Merge branch 'pypa:main' into patch-1
LLyaudet Dec 2, 2023
2779b98
Update packaging-projects.rst use correctly intersphinx
LLyaudet Dec 2, 2023
c12f338
LL: create discussion choosing-a-module-name and link between it and …
LLyaudet Dec 2, 2023
cc8ffd5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 2, 2023
614bf97
LL: correction nox build.
LLyaudet Dec 2, 2023
5f7790e
Update source/discussions/choosing-a-module-name.rst
LLyaudet Dec 3, 2023
408d7aa
Update source/discussions/choosing-a-module-name.rst
LLyaudet Dec 3, 2023
2893273
LL: correction code-block python -> pycon.
LLyaudet Dec 3, 2023
81d8d52
LL : more markup in choosing-a-module-name.
LLyaudet Dec 3, 2023
43e64d9
LL: add warning and ref to PEP8 for unnatural module names.
LLyaudet Dec 3, 2023
76bb7bf
LL: add import package since import packages are a special case of mo…
LLyaudet Dec 3, 2023
4e5053e
LL: clarify terminology with links to the glossary.
LLyaudet Dec 3, 2023
fd7909e
Merge branch 'pypa:main' into patch-1
LLyaudet Dec 3, 2023
8f314ae
LL: typo cumbersone -> cumbersome.
LLyaudet Dec 3, 2023
8115dae
LL: correction Title underline too short.
LLyaudet Dec 3, 2023
63b5b46
Merge branch 'main' into patch-1
LLyaudet Dec 10, 2023
23e289e
Update source/discussions/choosing-a-package-module-name.rst
LLyaudet Dec 10, 2023
de7fbfa
LL: add recommendation to have only one importable package.
LLyaudet Dec 10, 2023
f962554
Update source/discussions/choosing-a-package-module-name.rst
LLyaudet Dec 10, 2023
b5fdb5c
LL: PyPI back after applying suggestion.
LLyaudet Dec 10, 2023
b93f306
LL: partial rewrite following in part suggestions by sinoroc.
LLyaudet Dec 10, 2023
a1745ef
LL: add section on the consequences of naming for consistency of the …
LLyaudet Dec 10, 2023
dfe196d
LL: refs for build backends.
LLyaudet Dec 10, 2023
7a52305
LL: missing new line before pycon.
LLyaudet Dec 10, 2023
8a20cac
LL: another missing new line.
LLyaudet Dec 10, 2023
eecfc2f
LL: correction `dist-info` -> ``dist-info``.
LLyaudet Dec 10, 2023
7d29053
LL: correct name normalization ref that fails in nox.
LLyaudet Dec 10, 2023
fcff555
LL: warning about 2 types of name normalization.
LLyaudet Dec 10, 2023
401d037
LL: naming gymnastic at the end with a little joke :).
LLyaudet Dec 10, 2023
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
32 changes: 32 additions & 0 deletions source/discussions/choosing-a-module-name.rst
Copy link
Member

Choose a reason for hiding this comment

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

It seems like it's best to have this absorbed in #1426, it's much more comprehensive and there's a section for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello :),
Thanks for the suggestions of corrections :).
I was seeing it coming regarding #1426 ;). Do as you want, you have writing rights on my PR.
I think my PR is ok as is as far as your other requests are concerned.
I have no experience of merging two PRs:

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Choosing a Module Name
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved
=========================

This discussion is a complement to :doc:`/tutorials/packaging-projects`.
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved

Make sure to have a valid :ref:`Python identifier <python:identifiers>` for your module name.
The PyPI project/dist name and the Python module may differ slightly.
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved
For example, your package in pyproject.toml and on PyPI may have the name abcd-1234.
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved
But a module named abcd-1234 would be cumbersome to import in Python,
since it isn't a valid identifier.
(There is a way to import it anyway, see :doc:`importlib <python:library/importlib>` and this question_.)

.. code-block:: python
LLyaudet marked this conversation as resolved.
Show resolved Hide resolved

>>> import abcd-1234
>>> from abcd-1234 import something

would not work.
But having a directory structure with src/abcd_1234/ instead of src/abcd-1234/ has 2 consequences:

- The following works:

.. code-block:: python

>>> import abcd_1234
>>> from abcd_1234 import something

- Hatch will recognize that the module corresponding to the package is abcd_1234 instead of defaulting to src and building a not working wheel.

More information about :doc:`Python imports <python:reference/import>` and its :doc:`grammar <python:reference/grammar>`.

.. _question: https://stackoverflow.com/questions/8350853/how-to-import-module-when-module-name-has-a-dash-or-hyphen-in-it
1 change: 1 addition & 0 deletions source/discussions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ specific topic. If you're just trying to get stuff done, see
wheel-vs-egg
src-layout-vs-flat-layout
setup-py-deprecated
choosing-a-module-name
2 changes: 1 addition & 1 deletion source/tutorials/packaging-projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ some things you can do:
:ref:`pdm`, and :ref:`poetry`.
* Read :pep:`517` and :pep:`518` for background and details on build tool configuration.
* Read about :doc:`/guides/packaging-binary-extensions`.

* Read about :doc:`/discussions/choosing-a-module-name`.

----

Expand Down