Is it ok to use dashes in Python files when trying to import them?

python naming
Joan Venge picture Joan Venge · Apr 17, 2009 · Viewed 78.7k times · Source

Basically when I have a python file like:

python-code.py

and use:

import (python-code)

the interpreter gives me syntax error.

Any ideas on how to fix it? Are dashes illegal in python file names?

Answer

Paolo Bergantino picture Paolo Bergantino · Apr 17, 2009

You should check out PEP 8, the Style Guide for Python Code:

Package and Module Names Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

Since module names are mapped to file names, and some file systems are case insensitive and truncate long names, it is important that module names be chosen to be fairly short -- this won't be a problem on Unix, but it may be a problem when the code is transported to older Mac or Windows versions, or DOS.

In other words: rename your file :)

Related questions

Python "private" function coding convention

When writing a python module and functions in it, I have some "public" functions that are supposed to be exposed to outsiders, but some other "private" functions that are only supposed to be seen and used locally and internally. I …

Read More
Folder naming convention for python projects

What is the naming convention in python community to set names for project folders and subfolders? my-great-python-project my_great_python_project myGreatPythonProject MyGreatPythonProject I find mixed up in the github. Appreciate your expert opinion.

Read More
Why are underscores better than hyphens for file names?

From Building Skills in Python: A file name like exercise_1.py is better than the name execise-1.py. We can run both programs equally well from the command line, but the name with the hyphen limits our ability to write …

Read More