kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

clarified module naming re: underscores

Browse Source
This commit is contained in:
Sharlak
2017-07-30 21:57:19 +01:00
parent 4432d82020
commit d39c485d16
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/structure.rst
+11 -1
View File
@@ -391,7 +391,17 @@ folder named :file:`my` which is not the case. There is an
dot notation should be used in the Python docs. dot notation should be used in the Python docs.
If you'd like you could name your module :file:`my_spam.py`, but even our If you'd like you could name your module :file:`my_spam.py`, but even our
friend the underscore should not be seen often in module names. friend the underscore should not be seen often in module names. However, using other
characters (spaces or hyphens) in module names will prevent importing
(- is the subtract operator), so try to keep module names short so there is
no need to separate words. And, most of all, don't namespace with underscores, use submodules instead.
.. code-block:: python
# OK
import library.plugin.foo
# not OK
import library.foo_plugin
Aside from some naming restrictions, nothing special is required for a Python Aside from some naming restrictions, nothing special is required for a Python
file to be a module, but you need to understand the import mechanism in order file to be a module, but you need to understand the import mechanism in order