-
Notifications
You must be signed in to change notification settings - Fork 932
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 19 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,36 @@ | ||
Choosing a Package/Module Name | ||
============================== | ||
|
||
This discussion is a complement to :doc:`/tutorials/packaging-projects`. | ||
|
||
Make sure to have a valid :ref:`Python identifier <python:identifiers>` for your import package/module name. | ||
The (PyPI) :term:`project<Project>`/:term:`distribution package <Distribution Package>` name | ||
and the Python :term:`import package <Import Package>`/module may differ slightly. | ||
LLyaudet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Moreover, one PyPI project/dist may ship more than one module or importable package — it is only possible that one matches the name, others can't. | ||
LLyaudet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
For example, your package in :file:`pyproject.toml` and on PyPI may have the name ``abcd-1234``. | ||
But a module named ``abcd-1234`` would be cumbersome to import in Python, | ||
since it isn't a valid identifier. | ||
(It would be cumbersome, completely unnatural and against the long-established conventions in the Python community; | ||
see, for example, :pep:`8#package-and-module-names`. | ||
LLyaudet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
There is a way to import it anyway, see :doc:`importlib <python:library/importlib>` and this question_.) | ||
|
||
.. code-block:: pycon | ||
|
||
>>> import abcd-1234 | ||
>>> from abcd-1234 import something | ||
|
||
would not work. | ||
LLyaudet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
But having a directory structure with ``src/abcd_1234/`` instead of ``src/abcd-1234/`` has 2 consequences: | ||
|
||
- The following works: | ||
|
||
.. code-block:: pycon | ||
|
||
>>> 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.
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.
Sorry for the late answer. I validated your commit suggestion of the 4th. The 3rd december I modified like this:
So the terms are already referenced.
I found it nice to have all 3 terms referenced in the same sentence when I modified.
But I understand the need to reference one of the 3 terms in the preceding sentence since it is asked here:
packaging.python.org/source/contribute.rst
Line 255 in e8a9716
I have a question: Should I reference the glossary on each appearance of a term in the same document?
I know that when a document is long, it is nice when you can hover over any acronym and check again its meaning if it does not stuck the first time.
I think on Wikipedia, it is frequent that most occurrences are cross-links.
As of now, I kept the second reference in the following sentence.
Let me know if I should remove it.
Moreover, if there is a consensus on this question, I think it should be in contribute.rst :)