Skip to content

flowclient._version

Source: flowclient/_version.py

Git implementation of _version.py.

Class NotThisMethod

Source: flowclient/_version.py

Exception raised if a method is not valid for the current scenario.

Class VersioneerConfig

VersioneerConfig()
Source: flowclient/_version.py

Container for Versioneer configuration parameters.

get_config

get_config()
Source: flowclient/_version.py

Create, populate and return the VersioneerConfig() object.

get_keywords

get_keywords()
Source: flowclient/_version.py

Get the keywords needed to look up the version information.

get_versions

get_versions()
Source: flowclient/_version.py

Get version information or return default if unable to do so.

git_get_keywords

git_get_keywords(versionfile_abs)
Source: flowclient/_version.py

Extract version information from the given file.

git_pieces_from_vcs

git_pieces_from_vcs(tag_prefix, root, verbose, runner=<function run_command at 0x7f44097ff550>)
Source: flowclient/_version.py

Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were not expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree.

git_versions_from_keywords

git_versions_from_keywords(keywords, tag_prefix, verbose)
Source: flowclient/_version.py

Get version information from git keywords.

pep440_split_post

pep440_split_post(ver)
Source: flowclient/_version.py

Split pep440 version string at the post-release segment. Returns the release segments before the post-release and the post-release version number (or -1 if no post-release segment is present).

plus_or_dot

plus_or_dot(pieces)
Source: flowclient/_version.py

Return a + if we don't already have one, else return a .

register_vcs_handler

register_vcs_handler(vcs, method)
Source: flowclient/_version.py

Create decorator to mark a method as the handler of a VCS.

render

render(pieces, style)
Source: flowclient/_version.py

Render the given version pieces into the requested style.

render_git_describe

render_git_describe(pieces)
Source: flowclient/_version.py

TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix)

render_git_describe_long

render_git_describe_long(pieces)
Source: flowclient/_version.py

TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix)

render_pep440

render_pep440(pieces)
Source: flowclient/_version.py

Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]

render_pep440_branch

render_pep440_branch(pieces)
Source: flowclient/_version.py

TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . The ".dev0" means not master branch. Note that .dev0 sorts backwards (a feature branch will appear "older" than the master branch). Exceptions: 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty]

render_pep440_old

render_pep440_old(pieces)
Source: flowclient/_version.py

TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Exceptions: 1: no tags. 0.postDISTANCE[.dev0]

render_pep440_post

render_pep440_post(pieces)
Source: flowclient/_version.py

TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0]

render_pep440_post_branch

render_pep440_post_branch(pieces)
Source: flowclient/_version.py

TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . The ".dev0" means not master branch. Exceptions: 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty]

render_pep440_pre

render_pep440_pre(pieces)
Source: flowclient/_version.py

TAG[.postN.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post0.devDISTANCE

run_command

run_command(
    commands, args, cwd=None, verbose=False, hide_stderr=False, env=None
)
Source: flowclient/_version.py

Call the given command(s).

versions_from_parentdir

versions_from_parentdir(parentdir_prefix, root, verbose)
Source: flowclient/_version.py

Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. We will also support searching up two directory levels for an appropriately named parent directory