Что еще находится в папке Python src, в соответствии с фактическими стандартами или стандартами де-факто?
При использовании макета src вместо плоского макета в проекте Python ожидается ли что-либо, кроме модуля проекта, в папке src?
Насколько я понимаю, если я добавлю mypkg2 под src в приведенном ниже макете и опубликую результат в PyPI, любой, кто сделает pip install, сможет import mypkg и import mypkg2 (что может показаться удивительным). Я что-то пропустил?
project_root_directory
├── pyproject.toml # AND/OR setup.cfg, setup.py
├── ...
└── src/
└── mypkg/
├── __init__.py
├── ...
├── module.py
├── subpkg1/
│ ├── __init__.py
│ ├── ...
│ └── module1.py
└── subpkg2/
├── __init__.py
├── ...
└── module2.py
Пример макета из https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#src-layout
Я не смог найти ни примера проекта, в котором было бы что-то еще, ни явной инструкции не помещать туда что-то еще. Я ищу PEP или упаковочный документ, который отвечает на этот вопрос.
В правильном проекте src-layout единственное, что присутствует в каталоге src, — это пакеты и модули импорта верхнего уровня (подпакеты, очевидно, находятся в подкаталогах пакетов верхнего уровня). -- По соглашению каждый дистрибутив содержит один и только один импортный пакет (или модуль) верхнего уровня. Если бы у вас были src/mypkg и src/mypkg2, в вашем проекте было бы 2 пакета импорта верхнего уровня, что необычно (но возможно).
Более важным, чем знание того, что должно или не должно быть в src, является понимание того, как src обрабатывается данным сеансом Python. Как только вы это поймете, вам будет легко рассуждать о том, как получить доступ к чему-либо внутри или вне src.
(Что касается упаковки, а не исполнения, в src нет ничего особенного.)
Ответы 1
В правильном проекте src-layout единственное, что должно присутствовать в каталоге src, — это пакеты импорта верхнего уровня и модули импорта верхнего уровня (подпакеты находятся в подкаталогах каталога верхнего уровня). пакеты, понятно).
По соглашению каждый дистрибутив содержит один и только один пакет импорта верхнего уровня (или модуль импорта верхнего уровня). И я предполагаю, что это соглашение является «стандартом де-факто», который запрашивается в вопросе.
В случае примера, показанного в вопросе, если бы в проекте были каталоги src/mypkg и src/mypkg2, то в проекте было бы 2 пакета импорта верхнего уровня, что необычно (но возможно).
Известным примером проекта, не следующего этому соглашению, является setuptools , он имеет 2 импорта верхнего уровня: setuptools и pkg_resources.
Я не знаю какой-либо авторитетной документации, разъясняющей этот конкретный момент src-макета, самое близкое, что я могу найти, это «макет src против плоского макета» в Руководстве пользователя упаковки Python.
«src» означает исходный код, как в исходном коде, поэтому можно ожидать найти исходный код там, а не исходный код там нет. Но ничто логически не мешает вам помещать любые файлы туда, куда вы хотите.