如何组织一个Python项目？

Question

我是 Python 新手，正在启动一个迷你项目，但我对如何以“Python 方式”组织文件夹有一些疑问。

我在开发环境中使用 PyDev，当我创建一个新项目时，会创建一个名为 src 的文件夹。

+ src

现在，在 PyDev 中，我可以创建 Pydev Module 和 PyDev Package

我需要按以下方式组织我的项目：

+ Indicators
    - Moving_averages.py
    - Stochastics.py
+ Strategies
    - Moving_averages_cross.py
- example.py

如何根据模块和包来组织它？模块和包的含义是什么？

Answer 1

包基本上是一个文件夹，其下有 __init__.py 文件，通常还有一些模块，其中模块是一个 *.py 文件。
它主要与import有关。如果您将 __init__.py 添加到指标中，您可以使用：

from Indicators.Stochastics import *

或

from Indicators import Stochastics

顺便说一句，我建议将模块/包名称保持小写。它不影响功能，但更“Pythonic”。

Answer 2

从文件系统的角度来看，模块是以 .py 结尾的文件，包是包含模块和（嵌套）包的文件夹。如果文件夹包含 __init__.py 文件，Python 会将其识别为包。

像这样的文件结构

some/
    __init__.py
    foofoo.py
    thing/
        __init__.py
        barbar.py

定义了包 some，它有一个模块 foofoo 和一个嵌套包 thing，它又有一个模块 酒吧。但是，在使用包和模块时，您并没有真正区分这两种类型：

import some

some.dothis() # dothis is defined in 'some/__init__.py'

import some.foofoo # <- module
import some.thing # <- package

请遵循 PEP8 当选择命名你的包/模块时（即使用小写名称）。

Answer 3

参见 python-package-template

目录结构

    .
    |-- bin
    |   `-- my_program
    |-- docs
    |   `-- doc.txt
    |-- my_program
    |   |-- data
    |   |   `-- some_data.html
    |   |-- __init__.py
    |   |-- submodule
    |   |   `-- __init__.py
    |   |-- helpers.py
    |-- tests
    |   |-- __init__.py
    |   |-- test_helpers.py
    |-- Makefile
    |-- CHANGES.txt
    |-- LICENSE.txt
    |-- README.md
    |-- requirements-dev.txt
    |-- requirements.txt
    `-- setup.py

cat Makefile

    PYTHON=`which python`
    NAME=`python setup.py --name`


    all: check test source deb

    init:
        pip install -r requirements.txt --use-mirrors

    dist: source deb

    source:
        $(PYTHON) setup.py sdist

    deb:
        $(PYTHON) setup.py --command-packages=stdeb.command bdist_deb

    rpm:
        $(PYTHON) setup.py bdist_rpm --post-install=rpm/postinstall --pre-uninstall=rpm/preuninstall

    test:
        unit2 discover -s tests -t .
        python -mpytest weasyprint

    check:
        find . -name \*.py | grep -v "^test_" | xargs pylint --errors-only --reports=n
        # pep8
        # pyntch
        # pyflakes
        # pychecker
        # pymetrics

    clean:
        $(PYTHON) setup.py clean
        rm -rf build/ MANIFEST dist build my_program.egg-info deb_dist
        find . -name '*.pyc' -delete

Answer 4

您可能想查看modern-package-template 库。它提供了一种为项目设置非常好的基本布局的方法，它会引导您解决一些问题，并尝试帮助您获得能够相当轻松地分发的内容。

http://pypi.python.org/pypi/modern-package-template

Answer 5

在决定项目结构之前，最好先问自己该项目的目的是什么。这将是一次性分析吗？您想研究一个玩具概念吗？您打算分发一个完整的项目吗？您在构建项目时想要投入的精力会有所不同。

• 如果是一次性分析，我喜欢使用 ipython 笔记本。笔记本将记录您的想法，您可以在代码中添加注释以供以后参考。
• 如果您想研究一个玩具概念，我会找到一种简单、快速的方法，效果最佳。您希望能够快速实施您的概念，以发现它是否可行，从而值得花费更多时间。 Python 哲学的一部分是“不要尝试完美，因为“足够好”往往就是这样。”您随时可以稍后回来并按照最佳软件工程实践的方式构建您的项目。

• 如果您想构建项目以便以后可以分发它，并使其扩展到许多模块，我建议使用以下结构：

  项目名称
   ├── MANIFEST.in
   ├── setup.py
   ├── 自述文件
   ├── .gitignore
   ├── .git
   ├── 项目名称_env
   └── 项目名称
       ├── __init__.py
       ├── 分包one
       │ ├── __init__.py
       │ ├── 第二个模块.py
       │ ├── 测试
       │ │ └── test_second_module.py
       │ └── 型号
       │ └── 型号1
       ├── 第一个模块.py   
       └── 测试
           └── 测试_第二_模块.py
  

我喜欢这种结构的详细原因 在我的博客文章中，但基本要点是层次结构较低的projectname 目录包含您的实际项目。除此之外还有所有帮助管理（git）和打包（setup.py、MANIFEST.in）的工具。

Answer 6

包是一个包含 __init__.py 的目录。与目录的区别在于您可以导入它。

本身并没有一种“Python 方式”，但您会发现将所有模块放入一个包中并使用与项目相关的名称是一个好主意。

此外，为了遵循 Python 风格指南 PEP8，包和模块名称应全部小写。因此，如果我们假设该项目名为“Botond Statistics”，您的结构将是这样的：

botondstats/
    indicators/
        moving_averages.py
        stochastics.py
    strategies/
        moving_averages_cross.py
    example.py

然后您可以通过执行以下操作找到 Stochastics 类

from botondstats.indicators.stochastics.Stochastics

（有多种方法可以保持结构但使导入更短，但这是另一个问题）。

如果您愿意，可以将此结构放在 src/ 下，但这不是必需的。我从来不这样做。
相反，我有一个主目录：

BotondStatistics/
    docs/
    botonstats/ # the above structure
    setup.py    # Distutils/distribute configuration for packaging.

在这个目录中，我通常还有一个 virtualenv，所以我实际上也有 bin/lib/ 等。开发通常是通过运行来完成的

./bin/python setup.py tests

，因为我使用 Distrubute 测试运行程序来运行测试。

我就是这么做的。 :-)

Answer 7

尝试python_boilerplate_template：

https://pypi.python.org/pypi/python_boilerplate_template

Answer 8

audreyr 的 cookiecutter 项目包含多个 Python项目模板：

• https://github.com/audreyr/cookiecutter#python

该包使用单个 ~/.cookiecutterrc 文件即可使用 Python、Java、JS 和其他语言创建自定义项目模板。

例如，与 PyPI 兼容的 Python 模板：

• https://github.com /audreyr/cookiecutter-pypackage