setup.py 技巧

PiscesYE 發(fā)布于2019-07-24 17:53 / 1122人閱讀

摘要：本文原文是在開始之前，我要聲明我們要解釋的是技巧。不是最佳實踐，并且在至少一種情況下，它是不可取的。技巧這些技巧使得我的包管理更容易一點。我很確定我的一些讀者使用這個技巧會有一個嚴(yán)重的問題。盡管如此，因為這些技巧，我喜歡讓事情簡單明了。

本文原文是 setup.py tricks

在開始之前，我要聲明我們要解釋的是‘技巧’。不是最佳實踐，并且在至少一種情況下，它是不可取的。

說到不明智的做法，在某時我將寫一篇“setup.py 陷阱”的博客文章，我相信你應(yīng)該絕不會在 setup.py 模塊做的事情。

技巧

這些技巧使得我的 Python 包管理更容易一點。在你試圖實現(xiàn)它們之前，我建議你最少有創(chuàng)建新包的基礎(chǔ)經(jīng)驗。有兩種方式可以學(xué)習(xí)到 Python 包的知識，一個是 New Library Sprint（適合初學(xué)者），另外一個是 Python Packaging User Guide（更高級）。

"python setup.py publish"

這是一切開始的地方。某天我看到了一些 Tom Christie 的代碼，并發(fā)現(xiàn)了 Django Rest 框架的 setup.py 模塊的 python setup.py publish 命令。它看起來像這樣：

# setup.py
import os
import sys

# I"ll discuss version tricks in a future blog post.
version = "42.0.0"

if sys.argv[-1] == "publish":
    os.system("python setup.py sdist upload")
    os.system("python setup.py bdist_wheel upload")
    print("You probably want to also tag the version now:")
    print("  git tag -a %s -m "version %s"" % (version, version))
    print("  git push --tags")
    sys.exit()

# Below this point is the rest of the setup() function

了不起的是使用的這個技術(shù)我沒有發(fā)現(xiàn)有稍微隱秘的 python setup.py sdist upload 命令，或者實際上隱秘的是 python setup.py bdist_wheel upload。當(dāng)我把其中一個包 push 到 PyPI 上去的時候，我僅僅需要鍵入：

$ python setup.py publish

非常簡單。

"python setup.py tag"

Tom Christie 的 python setup.py publish 命令的問題是它強迫我打印輸出 git tag 命令。好吧，讓我們說實話吧，它強迫我復(fù)制/粘貼我的輸出到我的屏幕上。因此，對于我自己，我‘創(chuàng)造’了 python setup.py tag 命令：

# setup.py

if sys.argv[-1] == "tag":
    os.system("git tag -a %s -m "version %s"" % (version, version))
    os.system("git push --tags")
    sys.exit()

相當(dāng)漂亮，是不是？現(xiàn)在我不需要記住一些隱秘的 git 命令。然后我獲得了更短的 python setup.py publish 命令：

if sys.argv[-1] == "publish":
    os.system("python setup.py sdist upload")
    os.system("python setup.py bdist_wheel upload")
    sys.exit()

當(dāng)我需要一個版本發(fā)布，我提交我的代碼然后鍵入：

$ python setup.py publish
$ python setup.py tag

為什么我部組合這些命令？好吧，你不會支持 put 東西像 "RC1" 或 "-alpha" 到你的 PyPI 版本名字。通過分離這些命令，我可以更細(xì)粒度的控制包發(fā)布。我鼓勵在 git tags 中對 alpha，beta，和候選版本分類，而不是正式 PyPI 版本。

"python setup.py test"

我很確定我的一些讀者使用這個技巧會有一個嚴(yán)重的問題。實際上，依賴于管理 Python 包架構(gòu)的響應(yīng)，它可能會被移動到我即將出版的“陷阱”的博客文章。

我喜歡 py.test。我已經(jīng)寫了一遍關(guān)于使用 py.test 的博客，我嘗試在任何地方使用它。我們應(yīng)該如何配合進 python setup.py test。恰好在那個時刻，使得我舒服的是使用 py.test 在 setup.py 中加入指定的類。

幸運的是，有另外一種方式：

if sys.argv[-1] == "test":
    test_requirements = [
        "pytest",
        "flake8",
        "coverage"
    ]
    try:
        modules = map(__import__, test_requirements)
    except ImportError as e:
        err_msg = e.message.replace("No module named ", "")
        msg = "%s is not installed. Install your test requirments." % err_msg
        raise ImportError(msg)
    os.system("py.test")
    sys.exit()

這意味著我用一個簡單的添加代碼使用了 py.test 和 python setup.py test 。

$ python setup.py test

理論上，可以運行 pip install 安裝缺失的包，或者從一個 requirements 文件中調(diào)用它們。盡管如此，因為這些技巧，我喜歡讓事情簡單明了。如果我得到足夠明確的結(jié)果，我將更新這個示例來包含調(diào)用 pip 來安裝缺失的 requirements。

注意，這并不意味著我不使用 tox，我使用 tox 來調(diào)用我 python setup.py test 的版本。