nonetheless/FlexVersion

Python library to manipulate software version stuff

FlexVersion

A cute Python library to manipulate version stuff.

Terminology

A software version is a numbered string to record the development progress or iteration of software applications. This tiny, cute library handles with some common processing when you require awareness-versioning processing in your program.

A representative version would be like 1.0, 2.0.1, sometimes with suffix of maintenance stage such as 1.0-beta1. In FlexVersion, a standard version takes the form of

[prefix-]x[.y[.z[.b]]][-suffix]

in which:

• prefix: usually taking the software name, such as flex_version-1.0, OPTIONAL
• x: the major version, REQUIRED
• y: the minor version, OPTIONAL
• z: the maintenance version, OPTIONAL
• b: the build version, OPTIONAL
• suffix: usually taking the QA stage label such as alpha, beta etc., OPTIONAL

Install

pip install -U flex_version

Routines

from flex_version import FlexVersion

1. Class VersionMeta

Meta class to store parsed data parts of versioning string.

The FlexVersion also supports versioned suffix, such as flex_version-1.0-beta1. You can trigger this feature with a given grouped regex string (.*(?P<suffix_version>\d+) as default) to the initializer, e.g.,

from flex_version import VersionMeta
v = VersionMeta('flex_version-1.0-beta1-foo', versioned_suffix='.*(?P<suffix_version>\d+)-\w+')

where suffix_version is a predefined group name to extract the version number.

2. Class FlexVersion

Utility class for available methods:

• parse_version(ver_str): Parse a versioning string into VersionMeta.

• in_range(v, minx, maxv): Check if a version v lies between (minv, maxv).

• compare(v1, v2): Compare the level of two versions, returns -1 (lower), 0 (equal), and 1 (larger).

• share_prefix(v1, v2): Check if two versions sharing the same prefix.

By

Xiaming Chen chenxm35@gmail.com