파이썬 패키지에 버전을 포함시키는 표준 방법?

StackOverflow https://stackoverflow.com/questions/458550

  •  19-08-2019
  •  | 
  •  

문제

다음을 수행 할 수있는 방식으로 버전 문자열을 파이썬 패키지와 연결하는 표준 방법이 있습니까?

import foo
print foo.version

사소한/주요 문자열이 지정되어 있기 때문에 추가 하드 코딩없이 해당 데이터를 검색 할 수있는 방법이 있다고 생각합니다. setup.py 이미. 내가 찾은 대체 솔루션은 가지고있었습니다 import __version__ 내 foo/__init__.py 그리고 가지고 있습니다 __version__.py 에 의해 생성 된 setup.py.

도움이 되었습니까?

해결책

귀하의 질문에 대한 답변은 아니지만 이름 지정을 고려해야합니다. __version__, 아니다 version.

이것은 거의 준 표준입니다. 표준 라이브러리 사용의 많은 모듈 __version__, 그리고 이것은 또한 사용됩니다 많이 제 3 자 모듈 중 하나 인 준 표준입니다.

대개, __version__ 끈이지만 때로는 플로트 또는 튜플이기도합니다.

편집 : S.Lott가 언급했듯이 (감사합니다!), PEP 8 명시 적으로 말한다 :

버전 부기

소스 파일에 전복, CV 또는 RCS CRUD가 있어야하는 경우 다음과 같이 수행하십시오.

    __version__ = "$Revision: 63990 $"
    # $Source$

이 라인은 모듈의 docstring 이후에 다른 코드 앞에 포함되어야하며, 위와 아래의 빈 줄로 분리되어야합니다.

또한 버전 번호가 다음에 설명 된 형식을 준수해야합니다. PEP 440 (PEP 386 이 표준의 이전 버전).

다른 팁

나는 싱글을 사용한다 _version.py 버전 정보를 저장하려면 "한 번 대포 장소"로 파일을 제출하십시오.

  1. 그것은 a를 제공합니다 __version__ 기인하다.

  2. 표준 메타 데이터 버전을 제공합니다. 따라서 감지됩니다 pkg_resources 또는 패키지 메타 데이터 (Egg-Info 및/또는 PKG-Info, PEP 0345)를 구문 분석하는 다른 도구.

  3. 패키지를 작성할 때 패키지 (또는 다른 항목)를 가져 오지 않으므로 일부 상황에서 문제가 발생할 수 있습니다. (이것이 어떤 문제를 일으킬 수 있는지 아래의 의견을 참조하십시오.)

  4. 버전 번호가 기록 된 장소는 단 하나뿐이므로 버전 번호가 변경 될 때 변경할 장소는 단 하나 뿐이며 일관되지 않은 버전이 적습니다.

작동 방식은 다음과 같습니다. 버전 번호를 저장하는 "하나의 정식 장소"는 Python 패키지에있는 "_version.py"라는 이름의 .py 파일입니다. myniftyapp/_version.py. 이 파일은 파이썬 모듈이지만 Setup.py는 가져 오지 않습니다! (그것은 기능 3을 물리 칠 것입니다.) 대신 당신의 setup.py는이 파일의 내용이 매우 간단하다는 것을 알고 있습니다.

__version__ = "3.6.5"

따라서 setup.py는 파일을 열고 다음과 같은 코드로 파일을 구문 분석합니다.

import re
VERSIONFILE="myniftyapp/_version.py"
verstrline = open(VERSIONFILE, "rt").read()
VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"
mo = re.search(VSRE, verstrline, re.M)
if mo:
    verstr = mo.group(1)
else:
    raise RuntimeError("Unable to find version string in %s." % (VERSIONFILE,))

그런 다음 setup.py는 그 문자열을 "버전"인수의 값으로 전달합니다. setup(), 따라서 만족스러운 기능 2.

기능 1을 만족시키기 위해 패키지를 가질 수 있습니다 (설정 시간이 아닌 런타임에!) myniftyapp/__init__.py 이와 같이:

from _version import __version__

여기에 있습니다 이 기술의 예 몇 년 동안 사용해 왔습니다.

이 예제의 코드는 조금 더 복잡하지만이 의견에 쓴 단순화 된 예는 완전한 구현이어야합니다.

여기에 있습니다 버전 가져 오기 코드.

이 접근법에 문제가 있으면 알려주십시오.

2017-05를 다시 작성했습니다

10 년 이상 Python 코드를 작성하고 다양한 패키지를 관리 한 후 DIY가 최선의 방법이 아닐 수도 있다는 결론에 도달했습니다.

나는 사용을 시작했다 pbr 내 패키지에서 버전을 처리하기위한 패키지. GIT를 SCM으로 사용하는 경우 마법과 같은 워크 플로에 적합하여 몇 주 동안의 작업을 절약 할 수 있습니다 (문제가 얼마나 복잡 할 수 있는지 놀랄 것입니다).

오늘의로 PBR은 가장 많이 사용되는 Python 패키지 #11 순위입니다 그리고이 수준에 도달하는 데 더러운 속임수는 포함되지 않았습니다. 단 하나 일뿐입니다. 매우 간단한 방식으로 일반적인 포장 문제를 해결하는 것입니다.

pbr 패키지 유지 보수 부담을 더 많이 수행 할 수 있으며, 버전 설정에만 국한되지는 않지만 모든 혜택을 채택하도록 강요하지는 않습니다.

따라서 한 커밋에서 PBR을 채택하는 방법에 대한 아이디어를 제공하기 위해 PBR에 대한 스위치 포장

아마도 버전이 저장소에 전혀 저장되지 않은 것을 관찰했을 것입니다. PBR은 git 브랜치와 태그에서이를 감지합니다.

PBR이 "컴파일"하고 응용 프로그램을 패키지하거나 설치할 때 버전을 캐시하기 때문에 GIT 저장소가 없을 때 발생하는 일에 대해 걱정할 필요가 없으므로 GIT에 대한 런타임 의존성이 없습니다.

오래된 솔루션

지금까지 본 최고의 솔루션은 다음과 같습니다.

내부에 yourpackage/version.py:

# Store the version here so:
# 1) we don't load dependencies by storing it in __init__.py
# 2) we can import it in setup.py for the same reason
# 3) we can import it into your module module
__version__ = '0.12'

내부에 yourpackage/__init__.py:

from .version import __version__

내부에 setup.py:

exec(open('yourpackage/version.py').read())
setup(
    ...
    version=__version__,
    ...

더 나은 것으로 보이는 또 다른 접근법을 알고 있다면 알려주십시오.

연기에 따라 PEP 396 (모듈 버전 번호),이를위한 제안 된 방법이 있습니다. 이론적으로 이론적으로 모듈이 따라야 할 표준이라는 표준을 설명합니다. 스 니펫은 다음과 같습니다.

3) 모듈 (또는 패키지)에 버전 번호가 포함 된 경우 버전은 __version__ 기인하다.

4) 네임 스페이스 패키지 내부에 거주하는 모듈의 경우 모듈에 __version__ 기인하다. 네임 스페이스 패키지 자체에는 자체가 포함되어서는 안됩니다 __version__ 기인하다.

5) __version__ 속성의 값은 문자열이어야합니다.

이것은 아마도 너무 늦었을 것입니다. 이전 답변에 대한 약간 간단한 대안이 있습니다.

__version_info__ = ('1', '2', '3')
__version__ = '.'.join(__version_info__)

(그리고 버전 번호의 자동 증가 부분을 사용하여 문자열로 변환하는 것은 상당히 간단합니다. str().)

물론, 내가 본 것에서, 사람들은 사용할 때 이전에 언급 한 버전과 같은 것을 사용하는 경향이 있습니다. __version_info__, 그리고 그와 같이 그것은 ints의 튜플로 보관합니다. 그러나 나는 당신이 호기심이나 자동 증가 (그리고 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어, 심지어는, 어떤 목적 으로든 버전 번호의 일부에 대한 추가 및 뺄셈과 같은 수학적 연산을 수행 할 상황이 의심 스럽기 때문에 그렇게하는 요점을 잘 보지 못한다. int() 그리고 str() 상당히 쉽게 사용할 수 있습니다). (반면에, 다른 사람의 코드가 문자열 튜플이 아닌 숫자 튜플을 기대할 가능성이있어서 실패 할 가능성이 있습니다.)

물론 이것은 내 자신의 견해이며, 나는 수치 튜플을 사용하는 것에 대한 다른 사람들의 입력을 기꺼이 좋아할 것입니다.

Shezi가 나에게 상기시킨 바와 같이, (어휘) 숫자 문자열의 비교가 반드시 직접 수치 비교와 동일한 결과를 가져지는 것은 아닙니다. 주요 0은이를 제공해야합니다. 결국 저장 __version_info__ 정수 값의 튜플로서 (또는 그것이 무엇이든 호출되는 것은 무엇이든)보다 효율적인 버전 비교를 가능하게합니다.

패키지 dir에서 JSON 파일을 사용합니다. 이것은 Zooko의 요구 사항에 맞습니다.

내부에 pkg_dir/pkg_info.json:

{"version": "0.1.0"}

내부에 setup.py:

from distutils.core import setup
import json

with open('pkg_dir/pkg_info.json') as fp:
    _info = json.load(fp)

setup(
    version=_info['version'],
    ...
    )

내부에 pkg_dir/__init__.py:

import json
from os.path import dirname

with open(dirname(__file__) + '/pkg_info.json') as fp:
    _info = json.load(fp)

__version__ = _info['version']

나는 또한 다른 정보를 넣습니다 pkg_info.json, 저자처럼. 메타 데이터 관리를 자동화 할 수 있기 때문에 JSON을 사용하고 싶습니다.

여기서 이러한 솔루션 중 많은 부분이 무시합니다 git 버전 태그는 여전히 여러 장소에서 버전을 추적해야한다는 것을 의미합니다 (나쁜). 나는 다음과 같은 목표로 이것에 접근했다.

  • 태그에서 모든 Python 버전 참조를 도출합니다. git 레포
  • 자동화 git tag/push 그리고 setup.py upload 입력이없는 단일 명령이있는 단계.

작동 방식 :

  1. a make release GIT Repo의 마지막 태그 버전 인 명령이 발견되고 증가합니다. 태그가 다시 밀려 나옵니다 origin.

  2. 그만큼 Makefile 버전을 저장합니다 src/_version.py 읽을 곳 setup.py 릴리스에도 포함되어 있습니다. 확인하지 마십시오 _version.py 소스 제어로!

  3. setup.py 명령은 새 버전 문자열을 읽습니다 package.__version__.

세부:

Makefile

# remove optional 'v' and trailing hash "v1.0-N-HASH" -> "v1.0-N"
git_describe_ver = $(shell git describe --tags | sed -E -e 's/^v//' -e 's/(.*)-.*/\1/')
git_tag_ver      = $(shell git describe --abbrev=0)
next_patch_ver = $(shell python versionbump.py --patch $(call git_tag_ver))
next_minor_ver = $(shell python versionbump.py --minor $(call git_tag_ver))
next_major_ver = $(shell python versionbump.py --major $(call git_tag_ver))

.PHONY: ${MODULE}/_version.py
${MODULE}/_version.py:
    echo '__version__ = "$(call git_describe_ver)"' > $@

.PHONY: release
release: test lint mypy
    git tag -a $(call next_patch_ver)
    $(MAKE) ${MODULE}/_version.py
    python setup.py check sdist upload # (legacy "upload" method)
    # twine upload dist/*  (preferred method)
    git push origin master --tags

그만큼 release 대상은 항상 세 번째 버전의 숫자를 증가하지만 사용할 수 있습니다. next_minor_ver 또는 next_major_ver 다른 숫자를 증가시킵니다. 명령은 versionbump.py 리포의 루트에 체크인 스크립트

versionbump.py

"""An auto-increment tool for version strings."""

import sys
import unittest

import click
from click.testing import CliRunner  # type: ignore

__version__ = '0.1'

MIN_DIGITS = 2
MAX_DIGITS = 3


@click.command()
@click.argument('version')
@click.option('--major', 'bump_idx', flag_value=0, help='Increment major number.')
@click.option('--minor', 'bump_idx', flag_value=1, help='Increment minor number.')
@click.option('--patch', 'bump_idx', flag_value=2, default=True, help='Increment patch number.')
def cli(version: str, bump_idx: int) -> None:
    """Bumps a MAJOR.MINOR.PATCH version string at the specified index location or 'patch' digit. An
    optional 'v' prefix is allowed and will be included in the output if found."""
    prefix = version[0] if version[0].isalpha() else ''
    digits = version.lower().lstrip('v').split('.')

    if len(digits) > MAX_DIGITS:
        click.secho('ERROR: Too many digits', fg='red', err=True)
        sys.exit(1)

    digits = (digits + ['0'] * MAX_DIGITS)[:MAX_DIGITS]  # Extend total digits to max.
    digits[bump_idx] = str(int(digits[bump_idx]) + 1)  # Increment the desired digit.

    # Zero rightmost digits after bump position.
    for i in range(bump_idx + 1, MAX_DIGITS):
        digits[i] = '0'
    digits = digits[:max(MIN_DIGITS, bump_idx + 1)]  # Trim rightmost digits.
    click.echo(prefix + '.'.join(digits), nl=False)


if __name__ == '__main__':
    cli()  # pylint: disable=no-value-for-parameter

이것은 버전 번호를 처리하고 증분하는 방법을 무거운 리프팅합니다. git.

__init__.py

그만큼 my_module/_version.py 파일이 가져옵니다 my_module/__init__.py. 모듈에 배포하려는 정적 설치 구성을 여기에 넣으십시오.

from ._version import __version__
__author__ = ''
__email__ = ''

setup.py

마지막 단계는 my_module 기준 치수.

from setuptools import setup, find_packages

pkg_vars  = {}

with open("{MODULE}/_version.py") as fp:
    exec(fp.read(), pkg_vars)

setup(
    version=pkg_vars['__version__'],
    ...
    ...
)

물론,이 모든 것이 작동하려면 다시 시작하려면 리포지토리에 하나 이상의 버전 태그가 있어야합니다.

git tag -a v0.0.1

파이썬 패키지에 버전 문자열을 포함시키는 표준 방법이없는 것 같습니다. 내가 본 대부분의 패키지는 솔루션의 변형, 즉 eitner를 사용합니다.

  1. 버전을 포함시킵니다 setup.py 그리고 가지고 있습니다 setup.py 모듈을 생성하십시오 (예 : version.py) 버전 정보 만 포함하거나 패키지로 가져 오거나

  2. 반대로 : 패키지 자체에 버전 정보를 넣고 가져 오기 저것 버전을 설정합니다 setup.py

또한 주목할만한 가치가 있습니다 __version__ 반 STD입니다. 파이썬에서도 그렇습니다 __version_info__ 튜플, 간단한 경우에는 다음과 같은 작업을 수행 할 수 있습니다.

__version__ = '1.2.3'
__version_info__ = tuple([ int(num) for num in __version__.split('.')])

... 그리고 당신은 얻을 수 있습니다 __version__ 파일 또는 무엇이든 문자열.

나는 또한 또 다른 스타일을 보았다 :

>>> django.VERSION
(1, 1, 0, 'final', 0)

화살 흥미로운 방법으로 처리합니다.

~ 안에 arrow/__init__.py:

__version__ = '0.8.0'
VERSION = __version__

~ 안에 setup.py:

def grep(attrname):
    pattern = r"{0}\W*=\W*'([^']+)'".format(attrname)
    strval, = re.findall(pattern, file_text)
    return strval

setup(
    name='arrow',
    version=grep('__version__'),
    # [...]
)

Numpy Distutils를 사용하는 경우 가치가있는 것에 대해 numpy.distutils.misc_util.Configuration a make_svn_version_py() 수정 번호를 내부에 포함시키는 방법 package.__svn_version__ 변수에서 version .

  1. a version.py 만 파일 __version__ = <VERSION> 파일의 매개 변수. 에서 setup.py 파일 가져 오기 __version__ PARAM과 값을 넣습니다 setup.py 다음과 같은 파일 :version=__version__
  2. 또 다른 방법은 a를 사용하는 것입니다 setup.py 파일 version=<CURRENT_VERSION> - current_version이 하드 코딩되었습니다.

새 태그를 만들 때마다 파일의 버전을 수동으로 변경하고 싶지 않기 때문에 (새 패키지 버전을 해제 할 준비가되어 있음) 다음을 사용할 수 있습니다.

적극 권장합니다 범프 버션 패키지. 나는 몇 년 동안 그것을 사용하여 버전을 부딪 쳤습니다.

추가하여 시작하십시오 version=<VERSION> 너의 ~에게 setup.py 아직 없으면 파일.

버전을 충돌 할 때마다 이와 같은 짧은 스크립트를 사용해야합니다.

bumpversion (patch|minor|major) - choose only one option
git push
git push --tags

그런 다음 호출 된 리포 당 하나의 파일을 추가하십시오. .bumpversion.cfg:

[bumpversion]
current_version = <CURRENT_TAG>
commit = True
tag = True
tag_name = {new_version}
[bumpversion:file:<RELATIVE_PATH_TO_SETUP_FILE>]

메모:

  • 당신이 사용할 수있는 __version__ 아래의 매개 변수 version.py 다른 게시물에서 제안 된 것과 같은 파일은 다음과 같은 범죄자 파일을 업데이트합니다.[bumpversion:file:<RELATIVE_PATH_TO_VERSION_FILE>]
  • 너 ~ 해야 하다 git commit 또는 git reset repo의 모든 것, 그렇지 않으면 더러운 repo 오류가 발생할 수 있습니다.
  • 가상 환경에 범프 버션 패키지가 포함되어 있는지 확인하십시오.

CVS (또는 RCS)를 사용하고 빠른 솔루션을 원하는 경우 다음을 사용할 수 있습니다.

__version__ = "$Revision: 1.1 $"[11:-2]
__version_info__ = tuple([int(s) for s in __version__.split(".")])

(물론, 개정 번호는 CVS로 귀하를 대신 할 것입니다.)

이를 통해 인쇄용 버전과 가져 오는 모듈에 최소한 예상 버전이 있는지 확인하는 데 사용할 수있는 버전 정보가 제공됩니다.

import my_module
assert my_module.__version_info__ >= (1, 1)
라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top