-
Notifications
You must be signed in to change notification settings - Fork 915
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
LLyaudet
wants to merge
33
commits into
pypa:main
Choose a base branch
from
LLyaudet:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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 1815996
Update packaging-projects.rst add empty line after items
LLyaudet 24d81e5
Update packaging-projects.rst ???
LLyaudet b8890ba
Update packaging-projects.rst use intersphinx
LLyaudet 74af3e9
Merge branch 'pypa:main' into patch-1
LLyaudet 2779b98
Update packaging-projects.rst use correctly intersphinx
LLyaudet c12f338
LL: create discussion choosing-a-module-name and link between it and …
LLyaudet cc8ffd5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 614bf97
LL: correction nox build.
LLyaudet 5f7790e
Update source/discussions/choosing-a-module-name.rst
LLyaudet 408d7aa
Update source/discussions/choosing-a-module-name.rst
LLyaudet 2893273
LL: correction code-block python -> pycon.
LLyaudet 81d8d52
LL : more markup in choosing-a-module-name.
LLyaudet 43e64d9
LL: add warning and ref to PEP8 for unnatural module names.
LLyaudet 76bb7bf
LL: add import package since import packages are a special case of mo…
LLyaudet 4e5053e
LL: clarify terminology with links to the glossary.
LLyaudet fd7909e
Merge branch 'pypa:main' into patch-1
LLyaudet 8f314ae
LL: typo cumbersone -> cumbersome.
LLyaudet 8115dae
LL: correction Title underline too short.
LLyaudet 63b5b46
Merge branch 'main' into patch-1
LLyaudet 23e289e
Update source/discussions/choosing-a-package-module-name.rst
LLyaudet de7fbfa
LL: add recommendation to have only one importable package.
LLyaudet f962554
Update source/discussions/choosing-a-package-module-name.rst
LLyaudet b5fdb5c
LL: PyPI back after applying suggestion.
LLyaudet b93f306
LL: partial rewrite following in part suggestions by sinoroc.
LLyaudet a1745ef
LL: add section on the consequences of naming for consistency of the …
LLyaudet dfe196d
LL: refs for build backends.
LLyaudet 7a52305
LL: missing new line before pycon.
LLyaudet 8a20cac
LL: another missing new line.
LLyaudet eecfc2f
LL: correction `dist-info` -> ``dist-info``.
LLyaudet 7d29053
LL: correct name normalization ref that fails in nox.
LLyaudet fcff555
LL: warning about 2 types of name normalization.
LLyaudet 401d037
LL: naming gymnastic at the end with a little joke :).
LLyaudet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
Let us know what you prefer :).
Best regards,
Laurent Lyaudet