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

이 솔루션 중 다수는 git버전 태그를 무시 하므로 여전히 여러 위치에서 버전을 추적해야합니다 (나쁜). 나는 다음 목표로 이것에 접근했다.

• gitrepo 의 태그에서 모든 Python 버전 참조를 파생하십시오.
• 자동화 git tag/ push과 setup.py upload어떤 입력을지지 않습니다 하나의 명령으로 단계.

작동 방식 :

1. A로부터 make release명령의 자식의 repo의 마지막 태그 버전을 찾아 증가합니다. 태그가로 푸시됩니다 origin.

2. 이 Makefile버전은 버전을 src/_version.py읽고 setup.py릴리스에 포함 할 버전을 저장합니다 . 소스 컨트롤을 확인하지 마십시오 _version.py!

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

세부:

메이크 파일

# 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목표는 항상 3 버전 숫자를 증가,하지만 당신은 사용할 수 있습니다 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

답변

{"version": "0.1.0"}

from distutils.core import setup
import json

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

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

import json
from os.path import dirname

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

__version__ = _info['version']