The Python Oracle

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

--------------------------------------------------
Rise to the top 3% as a developer or hire one of them at Toptal: https://topt.al/25cXVn
--------------------------------------------------

Music by Eric Matyas
https://www.soundimage.org
Track title: City Beneath the Waves Looping

--

Chapters
00:00 Is It Ok To Use Dashes In Python Files When Trying To Import Them?
00:23 Accepted Answer Score 212
01:08 Answer 2 Score 142
01:41 Answer 3 Score 109
02:49 Answer 4 Score 38
03:12 Answer 5 Score 17
03:26 Thank you

--

Full question
https://stackoverflow.com/questions/7615...

--

Content licensed under CC BY-SA
https://meta.stackexchange.com/help/lice...

--

Tags
#python #naming

#avk47



ACCEPTED ANSWER

Score 212


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 :)




ANSWER 2

Score 144


One other thing to note in your code is that import is not a function. So import(python-code) should be import python-code which, as some have already mentioned, is interpreted as "import python minus code", not what you intended. If you really need to import a file with a dash in its name, you can do the following::

python_code = __import__('python-code')

But, as also mentioned above, this is not really recommended. You should change the filename if it's something you control.




ANSWER 3

Score 111


TLDR

Dashes are not illegal but you should not use them for 3 reasons:

  1. You need special syntax to import files with dashes
  2. Nobody expects a module name with a dash
  3. It's against the recommendations of the Python Style Guide

If you definitely need to import a file name with a dash the special syntax is this:

module_name = __import__('module-name')

Curious about why we need special syntax?

The reason for the special syntax is that when you write import somename you're creating a module object with identifier somename (so you can later use it with e.g. somename.funcname). Of course module-name is not a valid identifier and hence the special syntax that gives a valid one.

You don't get why module-name is not valid identifier?

Don't worry -- I didn't either. Here's a tip to help you: Look at this python line: x=var1-var2. Do you see a subtraction on the right side of the assignment or a variable name with a dash?

PS

Nothing original in my answer except including what I considered to be the most relevant bits of information from all other answers in one place




ANSWER 4

Score 38


The problem is that python-code is not an identifier. The parser sees this as python minus code. Of course this won't do what you're asking. You will need to use a filename that is also a valid python identifier. Try replacing the - with an underscore.