Version#
Newversion Index / Newversion / Version
Auto-generated documentation for newversion.version module.
Version#
Extended packaging.version.Version
implementation.
Signature#
Version().base#
Underlying version NamedTuple.
Signature#
See also#
Version().base#
Signature#
See also#
Version().bump_dev#
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#
inc
- Increment for dev version.- Version().bump_release - Release number to bump if version is stable.
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#
See also#
Version().bump_major#
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#
Version().bump_micro#
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#
Version().bump_minor#
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#
Version().bump_postrelease#
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#
Version().bump_prerelease#
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#
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#
See also#
Version().copy#
Create a copy of a current version instance.
Signature#
Version().dumps#
Render to string.
Signature#
Version().get_stable#
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#
Version().is_stable#
Whether version is not prerelease or devrelease.
Returns#
True if it is stable.
Signature#
Version().prerelease_type#
Signature#
See also#
Version().replace#
Modify version parts.
Examples#
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#
Get zero version 0.0.0
Signature#
VersionError#
Wrapper for InvalidVersion error.