Skip to content

Clarification for Module Naming #830

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.

Sign up for GitHub

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

Merged
kennethreitz merged 2 commits into from
Jul 30, 2017
Merged

Clarification for Module Naming #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4432d82
lengthened title underline appropriately
elanorigby Jul 30, 2017
d39c485
clarified module naming re: underscores
elanorigby Jul 30, 2017
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
2 changes: 1 addition & 1 deletion docs/starting/install3/win.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _install3-windows:

Installing Python 3 on Windows
============================
==============================

First, download the `latest version <https://www.python.org/ftp/python/3.6.0/python-3.6.0.exe>`_
of Python 3.6 from the official website. If you want to be sure you are installing a fully
Expand Down
12 changes: 11 additions & 1 deletion docs/writing/structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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
file to be a module, but you need to understand the import mechanism in order
Expand Down