Python 工程管理

接触Python也有五六年了，一直都是小打小闹，撑死了也就一个几十行的小脚本。 大型工程也就知道需要一个requirement.txt去管理依赖，从来没有实践过。 前段时间用Python开发了一个图床工具simple-image-tool， 在这里分享一下用到的工程管理工具Poetry(主页很酷炫)

简单介绍

当我们谈到工程管理时，通常我们关心的基本需求有

• 依赖管理
• 打包

Python也有一些工具可以满足这些需求，但太复杂了，让我们看看Poetry的开发动机

Packaging systems and dependency management in Python are rather convoluted and hard to understand for newcomers. Even for seasoned developers it might be cumbersome at times to create all files needed in a Python project: setup.py, requirements.txt, setup.cfg, MANIFEST.in and the newly added Pipfile.

So I wanted a tool that would limit everything to a single configuration file to do: dependency management, packaging and publishing.

Poetry可以满足我们的这些基本需求，且所有配置都放在一个叫pyproject.toml的文件里，个人觉得使用体验和npm/yarn差不多。

安装

• 独立安装(推荐)

  curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
  

• pip 安装

  pip install --user poetry
  

  这种方式会安装poetry的所有依赖，可能会有冲突

安装完成后可以查看版本

poetry --version

也可通过命令行更新版本

poetry self update

如果想要命令自动补全，可以根据自己的shell类型执行下面的命令

# Bash
poetry completions bash > /etc/bash_completion.d/poetry.bash-completion

# Bash (Homebrew)
poetry completions bash > $(brew --prefix)/etc/bash_completion.d/poetry.bash-completion

# Fish
poetry completions fish > ~/.config/fish/completions/poetry.fish

# Fish (Homebrew)
poetry completions fish > (brew --prefix)/share/fish/vendor_completions.d/poetry.fish

# Zsh
# After this command, add fpath+=~/.zfunc before compinit in ~/.zshrc
poetry completions zsh > ~/.zfunc/_poetry

# Zsh (Homebrew)
poetry completions zsh > $(brew --prefix)/share/zsh/site-functions/_poetry

# Zsh (Oh-My-Zsh)
# After the command, enable poetry plugin in ~/.zshrc
mkdir $ZSH/plugins/poetry
poetry completions zsh > $ZSH/plugins/poetry/_poetry

# Zsh (prezto)
poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry

创建工程

poetry new poetry-demo

执行完这个命令后，我们将得到如下的工程结构

poetry-demo
├── pyproject.toml
├── README.rst
├── poetry_demo
│   └── __init__.py
└── tests
    ├── __init__.py
    └── test_poetry_demo.py

pyproject.toml 是整个工程的配置文件，其内容大体如下

[tool.poetry]
name = "poetry-demo"
version = "0.1.0"
description = ""
authors = ["Sébastien Eustace <sebastien@eustace.io>"]

[tool.poetry.dependencies]
python = "*"

[tool.poetry.dev-dependencies]
pytest = "^3.4"

[tool.poetry.scripts]
my-script = "my_module:main"

• tool.poetry

  工程的基本信息

• tool.poetry.dependencies

  工程发布后需要的依赖

• tool.poetry.dev-dependencies

  工程仅在开发时需要的依赖

• tool.poetry.scripts

  工程安装后支持的命令，也可以通过poetry run 在本地执行

如果想要交互式的创建工程，可以执行poetry init。

依赖管理

• 添加依赖

  poetry add <dependency>[@<version>]
  
  # poetry add requests@latest
  

• 删除依赖

  poetry remove <dependency>
  
  # poetry remove requests
  

• 更新依赖

  poetry update [dependency]
  
  # poetry update requests
  

• 锁定版本

  和yarn类似，当我们安装完依赖后会产生一个poetry.lock文件, 只需将该文件一起上传到代码库即可。

• 安装所有依赖

  poetry install # 安装所有依赖
  poetry install --no-dev # 忽略开发依赖
  poetry install --no-root # 忽略本代码库发布的包
  

打包发布

• 工程打包

  poetry build 
  

  该命令会生成两种格式的包： 源代码(sdist)和编译文件(wheel)

• 发布到PyPI

  poetry publish
  

  运行该命令前，我们需要先注册PyPI得到用户名和密码

• 定义命令

  如果我们只是提供一个第三方库供别人调用，这步可以忽略。

  如果我们提供的是一个可以执行的命令，我们就需要定义该命令要如何安装，调用入口是哪里。

  pyproject.toml中的tool.poetry.scripts可以实现我们的需求。

  [tool.poetry.scripts]
  simple-image-tool = 'simple_image_tool:main'
  

  当我们用pip安装该库时，pip会安装一个simple-image-tool 命令，执行该命令时会调用simple_image_tool包中的main方法。

  在本地环境我们也可以通过下面的方式执行该命令

  poetry run simple-image-tool
  

总结

很不错的一款工具，极大的减少了学习Python工程管理的时间。 除了这些基本的功能，它还支持环境隔离，私有库等，还在慢慢探索中，后续会陆续分享给大家。