Should I use `import os.path` or `import os`?

by

os.path works in a funny way. It looks like os should be a package with a submodule path, but in reality os is a normal module that does magic with sys.modules to inject os.path. Here’s what happens:

  • When Python starts up, it loads a bunch of modules into sys.modules. They aren’t bound to any names in your script, but you can access the already-created modules when you import them in some way.

    • sys.modules is a dict in which modules are cached. When you import a module, if it already has been imported somewhere, it gets the instance stored in sys.modules.

  • os is among the modules that are loaded when Python starts up. It assigns its path attribute to an os-specific path module.

  • It injects sys.modules['os.path'] = path so that you’re able to do “import os.path” as though it was a submodule.

I tend to think of os.path as a module I want to use rather than a thing in the os module, so even though it’s not really a submodule of a package called os, I import it sort of like it is one and I always do import os.path. This is consistent with how os.path is documented.

Incidentally, this sort of structure leads to a lot of Python programmers’ early confusion about modules and packages and code organization, I think. This is really for two reasons

  1. If you think of os as a package and know that you can do import os and have access to the submodule os.path, you may be surprised later when you can’t do import twisted and automatically access twisted.spread without importing it.

  2. It is confusing that os.name is a normal thing, a string, and os.path is a module. I always structure my packages with empty __init__.py files so that at the same level I always have one type of thing: a module/package or other stuff. Several big Python projects take this approach, which tends to make more structured code.

More Related Contents:

  1. Importing modules in Python – best practice
  2. How to do relative imports in Python?
  3. How to import a module given its name as string?
  4. Best way to return multiple values from a function? [closed]
  5. How to import the class within the same directory or sub directory?
  6. Automatically create requirements.txt
  7. How to check if a Python module exists without importing it
  8. Importing files from different folder
  9. What are the most common Python docstring formats? [closed]
  10. adding directory to sys.path /PYTHONPATH
  11. Absolute vs. explicit relative import of Python module
  12. In Python, what happens when you import inside of a function? [duplicate]
  13. Is `import module` better coding style than `from module import function`?
  14. Why use sys.path.append(path) instead of sys.path.insert(1, path)?
  15. In Python, is it better to use list comprehensions or for-each loops?
  16. Why use def main()? [duplicate]
  17. How to unimport a python module which is already imported?
  18. Why can’t Python import Image from PIL?
  19. Local import statements in Python
  20. Python: reload component Y imported with ‘from X import Y’?
  21. Python import mechanics
  22. When to use os.name, sys.platform, or platform.system?
  23. Python import modules from a higher level package
  24. Is nested function a good approach when required by only one function? [closed]
  25. How to fix “no module named ‘app_one'”
  26. Installing lxml module in python
  27. ImportError: libSM.so.6: cannot open shared object file: No such file or directory
  28. Attributes initialization/declaration in Python class: where to place them?
  29. How to reference python package when filename contains a period
  30. Why does PEP-8 specify a maximum line length of 79 characters? [closed]

Leave a Comment