Skip to main content

Package version query toolkit for Python

Project description

No overhead package versioning for Python, based on git.

package version from PyPI build status from Travis CI build status from AppVeyor grade from Codacy test coverage from Codecov license

Package versioning toolkit for Python which relies on git tags, git history traversal and status of git repository to generate a very fine-grained version number.

Aren’t you tired hardcoding the version numbers when maintaining a Python package?!

And wouldn’t you like have fine-grained versioning scheme with version changing with each commit, for easier development, testing and pre-release deployment?!

Search no more!

As long as you mark your releases using git tags, instead of hardcoding:

__version__ = '1.5.0.dev2'

You can do:

from version_query import predict_version_str

__version__ = predict_version_str()

It’s 21st century, stop hardcoding version numbers!

This will set the version to release version when you really release a new version, and it will automatically generate a suitable development version at development/pre-release phase.

Overview

At development time, the current version number is automatically generated based on:

  • tags
  • current commit SHA
  • index status

in your git repository. Therefore the package can be built and shipped to PyPI based only on status of the git repository. When there is no git repository (this might be the case at installation time or at runtime) then the script relies on metadata generated at packaging time.

That’s why, regardless if package is installed from PyPI (from source or wheel distribution) or cloned from GitHub, the version query will work.

Additionally, version numbers in version-query are mutable objects and they can be conveniently incremented, compared with each other, as well as converted to/from other popular versioning formats.

Versioning scheme

Version scheme used by version-query is a relaxed mixture of:

These two rulesets are mostly compatible. When they are not, a more relaxed approach of the two is used. Details follow.

Version has one of the following forms:

  • <release>
  • <release><pre-release>
  • <release>+<local>
  • <release><pre-release>+<local>

A release version identifier <release> has one of the following forms:

  • <major>
  • <major>.<minor>
  • <major>.<minor>.<patch>

And the pre-release version identifier <pre-release> has one of the following forms:

  • <pre-type>
  • <pre-type><pre-patch>
  • <pre-separator><pre-type>
  • <pre-separator><pre-patch>
  • <pre-separator><pre-type><pre-patch>
  • … and any of these forms can be repeated arbitrary number of times.

And finally the local version identifier <local> has one of the forms:

  • <local-part>
  • <local-part><local-separator><local-part>
  • <local-part><local-separator><local-part><local-separator><local-part>
  • … and so on.

Each version component has a meaning and constraints on its contents:

  • <major> - a non-negative integer, increments when backwards-incompatible changes are made
  • <minor> - a non-negative integer, increments when backwards-compatible features are added
  • <patch> - a non-negative integer, increments when backwards-compatible bugfixes are made
  • <pre-separator> - dot or dash, separates release version information from pre-release
  • <pre-type> - a string of lower-case alphabetic characters, type of the pre-release
  • <pre-patch> - a non-negative integer, revision of the pre-release
  • <local-part> - a sequence of alphanumeric characters, stores arbitrary information
  • <local-separator> - a dot or dash, separates parts of local version identifier

How exactly the version number is determined

The version-query package has two modes of operation:

  • query - only currently available explicit information is used to determine the version number
  • prediction - this applies only to determining version number from git repository, and means that in addition to explicit version information, git repository status can be used to get very fine-grained version number which will be unique for every repository snapshot

Version query from package metadata file

The metadata file (PKG-INFO or metadata.json or METADATA) is automatically generated whenever a Python distribution file is built. Which one, depends on your method of building, but in any case, the file is then packaged into distributions, and when uploaded to PyPI that metadata file is used to populate the package page - therefore all Python packages on PyPI should have it.

Additionally, source code folder of any package using setuptools, in which setup.py build was executed, contains metadata file – even if distribution file was not built.

The version identifier is contained verbatim in the metadata file, therefore version query in this case boils down to simply reading the metadata file.

Information about Python metadata files:

Version query from git repository

The version number is equal to the version contained in the most recent version tag.

Version tags

Any git tag that is a valid version (matching the rules above) is considered a version tag. Version number can be prefixed with v or ver. Other tags are ignored.

Examples of valid version tags:

  • v1.0
  • v0.16.0
  • v1.0.dev3
  • ver0.5.1-4.0.0+a1de3012
  • 42.0
  • 3.14-15
Most recent version tag

The most recent tag is found based on repository history and version precedence.

Search for version tags starts from current commit, and goes backwards in history (towards initial commit). Therefore, commits after current one as well as not-merged branches are ignored in the version tag search.

If there are several version tags on one commit, then highest version number is used.

If there are version tags on several merged branches, then the highest version number is used.

If there are no version tags in the repository, you’ll get an error - so version cannot be queried from git repository without any version tags.

But in such case, version can still be predicted, as described below.

Version prediction from git repository

In version prediction mode, first of all, a most recent version tag is found, as above. If there are no version tags in the repo, then the initial commit is assumed to have tag v0.1.0.dev0.

Then, the new commits since the most recent version tag are counted. Then, the repository index status is queried. All the results are combined to form the predicted version number. Procedure is described below in detail.

Counting new commits

If after the commit with the most recent tag there are any new commits, a suffix .dev# is appended to the version identifier, where # is the number of commits between the current commit and the most recent version tag.

Additionally, the <patch> version component is incremented by 1.

Additionally, a plus (+) character and the first 8 characters of SHA of the latest commit are appended to version identifier, e.g. +a3014fe0.

Repository index status

Additionally, if there are any uncommitted changes in the repository (i.e. the repo is dirty), the suffix .dirty followed by current date and time in format YYYYMMDDhhmmss are appended to the identifier.

Example of how the final version identifier looks like, depending on various conditions of the repository:

  • Most recent version tag is v0.4.5, there were 2 commits since, latest having SHA starting with 812f12ea. Version identifier will be 0.4.6.dev2+812f12ea.
  • Most recent version tag is ver6.0, and there was 1 commit since having SHA starting with e10ac365. Version identifier will be 6.0.1.dev1+e10ac365.
  • Most recent version tag is v9, there were 40 commit since, latest having SHA starting with 1ad22355, the repository has uncommitted changes and version was queried at 19:52.20, 8th June 2017. the result is 9.0.1.dev40+1ad22355.dirty20170608195220.

How exactly version numbers are compared

The base specification of the comparison scheme is:

With the notable difference to both that all version components are taken into account when establishing version precedence.

When being compared, <major>, <minor> and <patch> are assumed equal to 0 if they are not present. In <pre-release>, the <pre-patch> is assumed to be 0 if not present.

Examples of comparison results:

  • 0.3-4.4-2.9 < 0.3-4.4-2.10
  • 0.3dev < 0.3dev1
  • 0.3rc2 < 0.3
  • 0.3 < 0.3-2
  • 1.0.0 < 1.0.0+blahblah
  • 1.0.0+aa < 1.0.0+aaa
  • 1.0.0 = 1.0.0
  • 1 = 1.0.0
  • 1.0 = 1.0.0.0
  • 1.0.0-0.0.DEV42 = 1.0.0.0.0.dev42

How exactly version number is incremented

Some version components have assumed value 0 if they are not present, please see section above for details.

Incrementing any version component clears all existing following components.

Examples of how version is incremented:

  • for 1.5, incrementing <major> results in 2.0;
  • for 1.5.1-2.4, <minor>``++ results in ``1.6;
  • 1.5.1-2.4, <patch>``++, ``1.5.2;
  • 1.5.1, <major>``+=3, ``4.0.0.

API details

All functionality mentioned below is considered as the public API. Other functionality may change without notice.

Main API

import version_query

version_str = version_query.query_version_str()

The version-query package will query the version string while operating in query mode.

version_str = version_query.predict_version_str()

The version-query package will infer the version string while operating in prediction mode.

version = version_query.Version(1, 0, 4)
version = version_query.Version(major=1, patch=4)
version = version_query.Version.from_str('1.0.4')

The Version class is used internally by version-query, but it can be also used explicitly.

import packaging.version
version = version_query.Version.from_py_version(packaging.version.Version())
version.to_py_version()

import semver
version = version_query.Version.from_sem_version(semver.VersionInfo())
version.to_sem_version()

Also, Version class interoperates with packaging and semver packages as well as selected built-in types.

assert version_query.Version(1, 0, 4).increment(version_query.VersionComponent.Patch, 2) \
    == version_query.Version.from_str('1.0.6')
assert version_query.Version.from_str('1.0.4') < version_query.Version.from_str('2.0.0')

The Version objects are mutable, hashable and comparable.

version = version_query.query_folder(pathlib.Path('/my/project'), search_parent_directories=False)
version = version_query.predict_git_repo(pathlib.Path('/my/git/versioned/project/subdir'), True)
version = version_query.query_caller(stack_level=1)
version = version_query.predict_caller(2)

Version object can be obtained for any supported path, as well as for any python code currently being executed – as long as it is located in a supported location.

Command-line interface

python3 -m version_query --help
python3 -m version_query /my/project -p
version_query.__main__.main(args=['--help'])
version_query.__main__.main(args=['/my/project', '-p'])

Version query can be also used as a command-line script, with the entry point also accessible as version_query.__main__.main from within Python.

Utility functions

assert version_query.git_query.preprocess_git_version_tag('v1.0.4') == '1.0.4'
assert version_query.git_query.preprocess_git_version_tag('ver1.0.4') == '1.0.4'
assert version_query.git_query.preprocess_git_version_tag('1.0.4') == '1.0.4'

Remove v and ver prefix from a given string, and preform very crude checking whether the tag is probably a version tag.

Limitations

Either git repository or metadata file must be present for the script to work. When, for example, zipped version of repository is downloaded from GitHub, the resulting archive contains neither metadata files nor repository data.

It is unclear what happens if the queried repository is bare.

The implementation is not fully compatible with Python versioning. Especially, in current implementation at most one of: alpha a / beta b / release candidate rc / development dev suffixes can be used in a version identifier.

And the format in which alpha a, beta b and release candidate rc suffixes are to be used does not match exactly the conditions defined in PEP 440.

Script might feel a bit slow when attempting to find a version tag in a git repository with a very large history and no version tags. It is designed towards packages with short release cycles – in long release cycles the overhead of manual versioning is small anyway.

Despite above limitations, version-query itself (as well as growing number of other packages) are using version-query without any issues.

Requirements

Python version 3.6 or later.

Python libraries as specified in requirements.txt.

Building and running tests additionally requires packages listed in test_requirements.txt.

Tested on Linux, OS X and Windows.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for version-query, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size version_query-1.1.0-py3-none-any.whl (22.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size version-query-1.1.0.tar.gz (41.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page