如何在setuptools包中包含VCS信息

我（試圖）使用setuptools來構建一個包。我試圖使用版本號major.minor.mercurial_revision，但它抱怨說：如何在setuptools包中包含VCS信息

The version specified ('1.0.7ae7970a82c1') is an invalid version, this may 
not work as expected with newer versions of setuptools, pip, and PyPI. 
Please see PEP 440 for more details.`

好。所以我看看PEP440裏面說基本上說「不要那麼做」：

As hashes cannot be ordered reliably such versions are not permitted in the 
public version field. As with semantic versioning, the public .devN 
suffix may be used to uniquely identify such releases for publication, 
while the original DVCS based label can be stored in the project metadata.

我理解這裏的邏輯。但如何可以我在項目元數據中包含hg修訂版？我無法找到setup.py:setup()的參數可以包含的任何（最新）文檔，但是我發現的distutils之一here似乎沒有爲此提供一個字段。

來源

2016-07-28 lost

您可以使用local version identifier來完成此操作。

本地版本標識符必須符合以下方案：

<public version identifier>[+<local version label>]

你的情況，這將是<major>.<minor>+<mercurial_version>，這將導致到1.0+7ae7970a82c1

來源

2016-07-28 14:54:57

把它作爲一個屬性包含在你的Python代碼中怎麼樣？

echo '__revision__ = $HG_HASH' > mypackage/revision.py

一旦安裝完畢，您可以：

from mypackage.revision import __revision__ 
print 'build from', __revision__

或者你可以把它寫入一個文件，幷包含在源代碼分發通過MANIFEST.in。

你甚至可以直接將其包含在參數setup()，這似乎簡單地忽略未知關鍵字參數：

setup(name='Distutils', 
     version='1.0', 
     description='Python Distribution Utilities', 
     author='Greg Ward', 
     author_email='[email protected]', 
     url='https://www.python.org/sigs/distutils-sig/', 
     packages=['distutils', 'distutils.command'], 
     revision='7ae7970a82c1', 
    )

這不會取得任何記錄，但它始終是可通過檢查，如果有人需要知道它的調試信息或什麼的。因爲這依賴setup()忽略未知參數 - 我不確定是明確記錄的行爲 - 我不知道這個想法實際上是我會推薦的。

來源

2016-07-28 14:53:59 larsks

因爲那麼你已經有了一個在你的源代碼中未跟蹤的文件，這不是很好，你的構建腳本必須做「回聲」位。這都是非標準的，上面的答案解決了它。 – lost

如果您在項目中包含修訂版本信息 - 通過'setup.py'或其他文件 - 您顯然會*生成*該文件作爲發佈過程的一部分。因此，無論是（a）未跟蹤，還是（b）您都會自動更新/提交它作爲發佈過程的一部分。 – larsks

嗯。你當然是對的。事實上，這些問題有點正交; Remco的答案解決了讓distutils接受我的版本號，但是從包內的「內部」獲取*版本號需要一個'__revision__'或者類似你的建議。 – lost

如何在setuptools包中包含VCS信息

回答

相關問題