是否整理Python软件包以从其顶层目录运行？

Question

How do I organize a Python package so its code runs from the top-level directory without adding that directory to the host's Python path?

I would also like to organize the code so I can run tests from the various test subdirectories, again without adding the package's top-level directory to the python path.

Consider the following code layout:

foobar/
  __init__.py
  README.txt
  its_a_module.py
  one_package/
    __init__.py
    foo.py
    bar.py
    tests/
      __init__.py
       testing_one_package.py
  tests/
    __init__.py
    test_foobar.py

• When in foobar/, I should be able to import foobar and all its submodules in the python interpreter
• From foobar/, I should be able to run tests/test_foobar.py.
• From foobar/tests, I should be able to run test_foobar.py
• From one_package/tests, I should be able to run testing_one_package.py.

How do I organize the import statements of my various modules, and the contents of my init .py files, to meet those objectives?

(I would like to use distutils to manage the code, and I read that running the code from the top-level directory is a useful precursor.)

Answer 1

You can add .. to your PYTHONPATH . That will satisfy your first two conditions:

• When in foobar/, I should be able to import foobar and all its submodules in the python interpreter
• From foobar/, I should be able to run tests/test_foobar.py.

You can always import absolutely, import foobar and from foobar.one_package import ... no import one_package and other relative imports. In this way you can run any submodule from the foobar dir.

For the other two stipulations,

• From foobar/tests, I should be able to run test_foobar.py
• From one_package/tests, I should be able to run testing_one_package.py.

you could add grandparents and great-grandparents of the PWD to the PYTHONPATH but I have never heard of this and it sounds bad. You can't really get around installing foobar , ie, putting it on your path, if you want the foobar package to be available no matter how deeply you go.