Skip to content

Version#

Newversion Index / Newversion / Version

Auto-generated documentation for newversion.version module.

Version#

Show source in version.py:26

Extended packaging.version.Version implementation.

Signature#

class Version(packaging.version.Version):
    def __init__(self, version: str) -> None: ...

Version().base#

Show source in version.py:65

Underlying version NamedTuple.

Signature#

@property
def base(self) -> BaseVersion: ...

See also#

Version().base#

Show source in version.py:72

Signature#

@base.setter
def base(self, base: BaseVersion) -> None: ...

See also#

Version().bump_dev#

Show source in version.py:221

Get next dev version. If version is stable - bump release for proper versioning as well. Defaults to bumping micro, falls back automatically to post

Arguments#

Examples#

Version("1.2.3").bump_dev()  # "1.2.4.dev0"
Version("1.2.3").bump_dev(1, 'minor')  # "1.3.0.dev0"
Version("1.2.3.dev14").bump_dev()  # "1.2.3.dev15"
Version("1.2.3a4).bump_dev()  # "1.2.3a4.dev0"
Version("1.2.3b5.dev9").bump_dev()  # "1.2.3b5.dev10"
Version("1.2.3.dev3").bump_dev(2)  # "1.2.3.dev5"
Version("1.2.3.post4").bump_dev()  # "1.2.3.post5.dev0"

Returns#

A new copy.

Signature#

def bump_dev(
    self: _R, inc: int = 1, bump_release: ReleaseMainPostTypeDef = "micro"
) -> _R: ...

See also#

Version().bump_major#

Show source in version.py:117

Get next major version.

Arguments#

  • inc - Increment for major version.

Examples#

Version("1.2.3").bump_major()  # "2.0.0"
Version("1.2.3.dev14").bump_major()  # "2.0.0"
Version("1.2.3a5").bump_major()  # "2.0.0"
Version("1.2.3rc3").bump_major(2)  # "3.0.0"
Version("1.2.3rc3").bump_major(0)  # "1.0.0"

Returns#

A new copy.

Signature#

def bump_major(self: _R, inc: int = 1) -> _R: ...

Version().bump_micro#

Show source in version.py:187

Get next micro version.

Arguments#

  • inc - Increment for micro version.

Examples#

Version("1.2.3").bump_micro()  # "1.2.4"
Version("1.2.3.dev14").bump_micro()  # "1.2.4"
Version("1.2.3a5").bump_micro()  # "1.2.4"
Version("1.2.3rc3").bump_micro(2)  # "1.2.5"
Version("1.2.3rc3").bump_micro(0)  # "1.2.3"

Returns#

A new copy.

Signature#

def bump_micro(self: _R, inc: int = 1) -> _R: ...

Version().bump_minor#

Show source in version.py:151

Get next minor version.

Arguments#

  • inc - Increment for minor version.

Examples#

Version("1.2.3").bump_minor()  # "1.3.0"
Version("1.2.3.dev14").bump_minor()  # "1.3.0"
Version("1.2.3a5").bump_minor()  # "1.3.0"
Version("1.2.3rc3").bump_minor(2)  # "1.4.0"
Version("1.2.3rc3").bump_minor(0)  # "1.2.0"
Version("1.3.0rc3").bump_minor()  # "1.3.0"
Version("1.3.0rc3").bump_minor(2)  # "1.4.0"

Returns#

A new copy.

Signature#

def bump_minor(self: _R, inc: int = 1) -> _R: ...

Version().bump_postrelease#

Show source in version.py:316

Get next postrelease version.

Arguments#

  • inc - Increment for micro version.

Examples#

Version("1.2.3").bump_postrelease()  # "1.2.3.post1"
Version("1.2.3.post3").bump_postrelease()  # "1.2.3.post4"
Version("1.2.3a5").bump_postrelease()  # "1.2.3.post1"
Version("1.2.3.post4").bump_postrelease(2)  # "1.2.3.post6"

Returns#

A new copy.

Signature#

def bump_postrelease(self: _R, inc: int = 1) -> _R: ...

Version().bump_prerelease#

Show source in version.py:265

Get next prerelease version. If version is stable - bump micro for proper versioning as well. Defaults to rc pre-releases.

Arguments#

  • inc - Increment for micro version.
  • release_type - Prerelease type: alpha, beta, rc.
  • Version().bump_release - Release number to bump if version is stable.

Examples#

Version("1.2.3").bump_prerelease()  # "1.2.4rc1"
Version("1.2.3").bump_prerelease(bump_release="major")  # "2.0.0rc1"
Version("1.2.3.dev14").bump_prerelease()  # "1.2.3rc1"
Version("1.2.3a5").bump_prerelease()  # "1.2.3a6"
Version("1.2.3rc3").bump_prerelease(2, "beta")  # "1.2.3rc5"

Returns#

A new copy.

Signature#

def bump_prerelease(
    self: _R,
    inc: int = 1,
    release_type: Optional[PrereleaseLooseTypeDef] = None,
    bump_release: ReleaseMainTypeDef = "micro",
) -> _R: ...

See also#

Version().bump_release#

Show source in version.py:87

Get next release version.

Arguments#

  • release_type - Release type: major, minor, micro.
  • inc - Increment for major version.

Examples#

Version("1.2.3").bump_release()  # "1.2.4"
Version("1.2.3").bump_release("major")  # "2.0.0"
Version("1.2.3.dev14").bump_release("minor", 2)  # "1.4.0"

Returns#

A new copy.

Signature#

def bump_release(
    self: _R, release_type: ReleaseMainTypeDef = "micro", inc: int = 1
) -> _R: ...

See also#

Version().copy#

Show source in version.py:76

Create a copy of a current version instance.

Signature#

def copy(self: _R) -> _R: ...

Version().dumps#

Show source in version.py:44

Render to string.

Signature#

def dumps(self) -> str: ...

Version().get_stable#

Show source in version.py:421

Get stable version from pre- or post- release.

Examples#

Version("1.2.3").get_stable() # "1.2.3"
Version("2.1.0a2").get_stable() # "2.1.0"
Version("1.2.5.post3").get_stable() # "1.2.5"

Returns#

A new instance.

Signature#

def get_stable(self: _R) -> _R: ...

Version().is_stable#

Show source in version.py:411

Whether version is not prerelease or devrelease.

Returns#

True if it is stable.

Signature#

@property
def is_stable(self) -> bool: ...

Version().prerelease_type#

Show source in version.py:50

Signature#

@property
def prerelease_type(self) -> Optional[PrereleaseTypeDef]: ...

See also#

Version().replace#

Show source in version.py:349

Modify version parts.

Examples#

Version("1.2.3").replace(dev=24) # "1.2.3.dev24"
Version("1.2.3rc5").replace(17) # "1.2.3.dev17"

Arguments#

  • major - Major release number.
  • minor - Minor release number.
  • micro - Micro release number.
  • alpha - Alpha pre-release number.
  • beta - Beta pre-release number.
  • rc - RC pre-release number.
  • dev - Dev release number.
  • post - Post release number.
  • epoch - Release epoch.
  • local - Local release identifier.

Returns#

A new instance.

Signature#

def replace(
    self: _R,
    major: Optional[int] = None,
    minor: Optional[int] = None,
    micro: Optional[int] = None,
    alpha: Optional[int] = None,
    beta: Optional[int] = None,
    rc: Optional[int] = None,
    dev: Optional[int] = None,
    post: Optional[int] = None,
    epoch: Optional[int] = None,
    local: Optional[str] = None,
) -> _R: ...

Version.zero#

Show source in version.py:37

Get zero version 0.0.0

Signature#

@classmethod
def zero(cls: Type[_R]) -> _R: ...

VersionError#

Show source in version.py:20

Wrapper for InvalidVersion error.

Signature#

class VersionError(packaging.version.InvalidVersion): ...