Module _version

Classes

• class NotThisMethod
  Exception raised if a method is not valid for the current scenario.
• class VersioneerConfig
  Container for Versioneer configuration parameters.

Functions

• ▷ def get_config()

  Create, populate and return the VersioneerConfig() object.

  source link
• ▷ def get_keywords()

  Get the keywords needed to look up the version information.

  source link
• ▶ def get_versions()

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

  source link

  Reexports

  • Imported in distributed.
• ▷ def git_get_keywords(versionfile_abs) @register_vcs_handler("git", "get_keywords")

  Extract version information from the given file.

  @register_vcs_handler("git", "get_keywords")
  def git_get_keywords(versionfile_abs)

  source link
• ▶ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command) @register_vcs_handler("git", "pieces_from_vcs")

  Get version from 'git describe' in the root of the source tree.

  @register_vcs_handler("git", "pieces_from_vcs")
  def git_pieces_from_vcs(

  tag_prefix,

  root,

  verbose,

  run_command=run_command,

  )

  source link

  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.

• ▷ def git_versions_from_keywords(keywords, tag_prefix, verbose) @register_vcs_handler("git", "keywords")

  Get version information from git keywords.

  @register_vcs_handler("git", "keywords")
  def git_versions_from_keywords(

  keywords,

  tag_prefix,

  verbose,

  )

  source link
• ▷ def plus_or_dot(pieces)

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

  source link
• ▷ def register_vcs_handler(vcs, method)

  Decorator to mark a method as the handler for a particular VCS.

  source link
• ▷ def render(pieces, style)

  Render the given version pieces into the requested style.

  source link
• ▶ def render_git_describe(pieces)

  TAG[-DISTANCE-gHEX][-dirty].

  source link

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

• ▶ def render_git_describe_long(pieces)

  TAG-DISTANCE-gHEX[-dirty].

  source link

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

• ▶ def render_pep440(pieces)

  Build up version string, with post-release "local version identifier".

  source link

  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]

• ▶ def render_pep440_old(pieces)

  TAG[.postDISTANCE[.dev0]] .

  source link

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

• ▶ def render_pep440_post(pieces)

  TAG[.postDISTANCE[.dev0]+gHEX] .

  source link

  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]

• ▶ def render_pep440_pre(pieces)

  TAG[.post.devDISTANCE] -- No -dirty.

  source link

  Exceptions:
  1: no tags. 0.post.devDISTANCE

• ▷ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None)

  Call the given command(s).

  source link
• ▶ def versions_from_parentdir(parentdir_prefix, root, verbose)

  Try to determine the version from the parent directory name.

  source link

  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

Generated by nedoc v0.9 at 2020-12-29 14:05