如何运行使用pybuilder构建的脚本?有没有`pyb run`?

时间:2018-04-09 16:24:16

标签: python virtualenv pybuilder

请原谅我可能琐碎的问题,但是:如何运行pybuilder发布的脚本?

我正在尝试关注官方Pybuilder Tutorial

我已经完成了这些步骤并成功生成了一个项目

  • 运行单元测试
  • 计算覆盖率
  • 生成setup.py
  • 生成可由.tar.gz使用的pip install

这一切都非常好,但我仍然没有看到实际的可运行工件是什么?

target目录中包含的所有内容似乎与src目录中的内容或其他报告和可安装存档的内容大致相同。

教程本身在“添加可运行脚本”一节结尾处得出结论“脚本已被拾取”。好的,它已被拿起,现在我该怎么运行它?教程在任何时候都没有证明我们可以实际打印字符串“Hello,World!”在屏幕上,尽管整个玩具项目都是关于这样做的事实。

MCVE

下面是一个Bash脚本,它使用Python源文件和构建脚本生成以下目录树:

projectRoot
├── build.py
└── src
    └── main
        ├── python
        │   └── pkgRoot
        │       ├── __init__.py
        │       ├── pkgA
        │       │   ├── __init__.py
        │       │   └── modA.py
        │       └── pkgB
        │           ├── __init__.py
        │           └── modB.py
        └── scripts
            └── entryPointScript.py

7 directories, 7 files
================================================================================
projectRoot/build.py
--------------------------------------------------------------------------------
from pybuilder.core import use_plugin

use_plugin("python.core")
use_plugin("python.distutils")

default_task = "publish"

================================================================================
projectRoot/src/main/scripts/entryPointScript.py
--------------------------------------------------------------------------------
#!/usr/bin/env python

from pkgRoot.pkgB.modB import b

if __name__ == "__main__":
  print(f"Hello, world! 42 * 42 - 42 = {b(42)}")

================================================================================
projectRoot/src/main/python/pkgRoot/pkgA/modA.py
--------------------------------------------------------------------------------
def a(n):
  """Computes square of a number."""
  return n * n

================================================================================
projectRoot/src/main/python/pkgRoot/pkgB/modB.py
--------------------------------------------------------------------------------
from pkgRoot.pkgA.modA import a

def b(n):
  """Evaluates a boring quadratic polynomial."""
  return a(n) - n

生成示例项目的完整脚本(免责声明:按原样提供,修改文件和目录,执行风险自负):

#!/bin/bash

# Creates a very simple hello-world like project
# that can be build with PyBuilder, and describes
# the result.

# Uses BASH heredocs and `cut -d'|' -f2-` to strip
# margin from indented code.

# strict mode
set -eu

# set up directory tree for packages and scripts
ROOTPKG_PATH="projectRoot/src/main/python/pkgRoot"
SCRIPTS_PATH="projectRoot/src/main/scripts"
mkdir -p "$ROOTPKG_PATH/pkgA"
mkdir -p "$ROOTPKG_PATH/pkgB"
mkdir -p "$SCRIPTS_PATH"

# Touch bunch of `__init__.py` files
touch "$ROOTPKG_PATH/__init__.py"
touch "$ROOTPKG_PATH/pkgA/__init__.py"
touch "$ROOTPKG_PATH/pkgB/__init__.py"

# Create module `modA` in package `pkgA`
cut -d'|' -f2- <<__HEREDOC > "$ROOTPKG_PATH/pkgA/modA.py"
  |def a(n):
  |  """Computes square of a number."""
  |  return n * n
  |
__HEREDOC

# Create module `modB` in package `pkgB`
cut -d'|' -f2- <<__HEREDOC > "$ROOTPKG_PATH/pkgB/modB.py"
  |from pkgRoot.pkgA.modA import a
  |
  |def b(n):
  |  """Evaluates a boring quadratic polynomial."""
  |  return a(n) - n
  |
__HEREDOC

# Create a hello-world script in `scripts`:
cut -d'|' -f2- <<__HEREDOC > "$SCRIPTS_PATH/entryPointScript.py"
  |#!/usr/bin/env python
  |
  |from pkgRoot.pkgB.modB import b
  |
  |if __name__ == "__main__":
  |  print(f"Hello, world! 42 * 42 - 42 = {b(42)}")
  |
__HEREDOC

# Create a simple `build.py` build script for PyBuilder
cut -d'|' -f2- <<__HEREDOC > "projectRoot/build.py"
  |from pybuilder.core import use_plugin
  |
  |use_plugin("python.core")
  |use_plugin("python.distutils")
  |
  |default_task = "publish"
  |
__HEREDOC

#################################################
#   Directory tree construction finished, only  #
#   debug output below this box.                #
#################################################

# show the layout of the generater result
tree "projectRoot"

# walk through each python file, show path and content
find "projectRoot" -name "*.py" -print0 | \
while IFS= read -r -d $'\0' pathToFile
do
  if [ -s "$pathToFile" ]
  then
    printf "=%.0s" {1..80} # thick horizontal line
    echo ""
    echo "$pathToFile"
    printf -- "-%.0s" {1..80}
    echo ""
    cat "$pathToFile"
  fi
done

我发现运行新建项目的最简单方法如下(从包含projectRoot的目录中使用):

virtualenv env
source env/bin/activate
cd projectRoot
pyb
cd target/dist/projectRoot-1.0.dev0/dist/
pip install projectRoot-1.0.dev0.tar.gz
entryPointScript.py

这确实成功地运行了脚本及其对用户定义的包的所有依赖关系,并打印:

Hello, world! 42 * 42 - 42 = 1722

但整个程序看起来很复杂。为了比较,在SBT的类似情况下,我只发出单个

run
来自SBT-shell的

命令 - 这就是为什么上面的七步食谱对我来说有点怀疑。

是否有pyb runpyb exec插件可以执行相同操作,但是我不需要设置所有这些环境并安装任何内容?我正在寻找的是SBT中的sbt run或Maven中的mvn exec:java的类比,它将构建所有内容,设置所有类路径,然后使用main方法运行类,不留任何项目目录之外的痕迹。

由于源代码和目标输出之间基本没有区别,我可能会错过一些如何运行脚本的明显方法。如果根本不需要PyBuilder本身,那也没关系:我想要的是以某种方式得到Hello, world! 42 * 42 - 42 = 1722 - 在终端打印字符串。

2 个答案:

答案 0 :(得分:1)

显然是以下工作流程:

  • pyb publish
  • pip install .tar.gz
  • runMyScript.py
  • 卸载

正是PyBuilder in this talk的创建者提出的。

请注意,链接的视频来自2014年。如果有人可以提出更精简的最近提供的解决方案,我当然会接受这一点。

答案 1 :(得分:0)

在build.py中创建任务

@task
def run(project):
    path.append("src/main/python")
    from test_pack import test_app
    test_app.main()

尝试:

pyb run