如何使用命令行脚本的诗歌组织 python 项目

Question

在进行诗歌初始化时，我得到了以下结构：

/packagename
  __init__.py
  packagename.py
 /packagename
  /tests
   __init__.py
   test_packagename.py
pyproject.toml

这对于 package 来说很好，但我不知道如何使它适合命令行脚本。 当我有一个像 script.py 这样的脚本时，它的代码结构如下：

在文件 script.py 中：

#!/usr/bin/python3

def main():
  print("Ok")

if __name__ == '__main__':
  main()

它不打算用作 python 模块，但是，它可能具有与诗歌一起处理的有趣的依赖项和测试。

在某些示例中，显示了以下诗歌语法：

[tool.poetry.scripts]
cli_script = 'script.py:main'

然后可以使用以下命令调用脚本：

poetry run cli_script

我正在寻找一些关于如何正确组织我的诗歌项目以供此类使用的指南。

例如，我已经寻找了诗歌 init 的选项（如诗歌 init --script）。 但似乎这种用例并未包含在 new/init 诗歌选项中。

Answer 1

“诗歌初始化”我猜你的意思是poetry new 。 但是你的结构看起来也有点奇怪。 我建议采用以下结构：

packagename
├── packagename
│   ├── __init__.py
│   └── cli.py
├── tests
│   ├── __init__.py
│   └── test_packagename.py
└── pyproject.toml

pyproject.toml看起来像这样：

[tool.poetry]
name = "packagename"
version = "0.1.0"
description = ""
authors = ["finswimmer <finswimmer@example.org>"]

[tool.poetry.scripts]
cli_script = "packagename.cli:main"

[tool.poetry.dependencies]
python = "^3.6"

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

[build-system]
requires = ["poetry>=1.0"]
build-backend = "poetry.masonry.api"

你cli.py就像你的例子一样：

#!/usr/bin/python3

def main():
  print("Ok")

if __name__ == '__main__':
  main()

poetry install后，您可以运行poetry run cli_script 。

Answer 2

或者，您可以运行：

poetry run python3 script.py

在哪里：

• script.py是具有 python 代码的文件的名称。
• python3是诗歌虚拟环境中的 python 可执行文件。 这也可以是python ，具体取决于您拥有的 python 版本。 在执行上述命令之前，您可以使用poetry run python3 -V或poetry run python -V确认相同。

此命令也可以在crontab中使用，以安排简单的脚本。