cmp_version (version 2.1.1)
index

The following work authored by Tim Savannah has been dedicated to the Public Domain.
You are free to use or modify.

 
Package Contents
       

 
Classes
       
builtins.str(builtins.object)
VersionString

 
class VersionString(builtins.str)
    A string where all comparison methods will compare as versions.
 
This supports all the rich comparison operators.
 
Example:
 
    >> version1 = VersionString('1.1b')
    >> version2 = VersionString('1.1a')
    >> version1 > version2
    True
 
 
Method resolution order:
VersionString
builtins.str
builtins.object

Methods defined here:
__add__(self, other)
Return self+value.
__cmp__(self, other)
__eq__(self, other)
Return self==value.
__ge__(self, other)
Return self>=value.
__gt__(self, other)
Return self>value.
__le__(self, other)
Return self<=value.
__lt__(self, other)
Return self<value.
__ne__(self, other)
Return self!=value.
__repr__(self)
Return repr(self).

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__hash__ = None

Methods inherited from builtins.str:
__contains__(self, key, /)
Return key in self.
__format__(...)
S.__format__(format_spec) -> str
 
Return a formatted version of S as described by format_spec.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__getnewargs__(...)
__iter__(self, /)
Implement iter(self).
__len__(self, /)
Return len(self).
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.n
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return self*value.
__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes
__str__(self, /)
Return str(self).
capitalize(...)
S.capitalize() -> str
 
Return a capitalized version of S, i.e. make the first character
have upper case and the rest lower case.
casefold(...)
S.casefold() -> str
 
Return a version of S suitable for caseless comparisons.
center(...)
S.center(width[, fillchar]) -> str
 
Return S centered in a string of length width. Padding is
done using the specified fill character (default is a space)
count(...)
S.count(sub[, start[, end]]) -> int
 
Return the number of non-overlapping occurrences of substring sub in
string S[start:end].  Optional arguments start and end are
interpreted as in slice notation.
encode(...)
S.encode(encoding='utf-8', errors='strict') -> bytes
 
Encode S using the codec registered for encoding. Default encoding
is 'utf-8'. errors may be given to set a different error
handling scheme. Default is 'strict' meaning that encoding errors raise
a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
'xmlcharrefreplace' as well as any other name registered with
codecs.register_error that can handle UnicodeEncodeErrors.
endswith(...)
S.endswith(suffix[, start[, end]]) -> bool
 
Return True if S ends with the specified suffix, False otherwise.
With optional start, test S beginning at that position.
With optional end, stop comparing S at that position.
suffix can also be a tuple of strings to try.
expandtabs(...)
S.expandtabs(tabsize=8) -> str
 
Return a copy of S where all tab characters are expanded using spaces.
If tabsize is not given, a tab size of 8 characters is assumed.
find(...)
S.find(sub[, start[, end]]) -> int
 
Return the lowest index in S where substring sub is found,
such that sub is contained within S[start:end].  Optional
arguments start and end are interpreted as in slice notation.
 
Return -1 on failure.
format(...)
S.format(*args, **kwargs) -> str
 
Return a formatted version of S, using substitutions from args and kwargs.
The substitutions are identified by braces ('{' and '}').
format_map(...)
S.format_map(mapping) -> str
 
Return a formatted version of S, using substitutions from mapping.
The substitutions are identified by braces ('{' and '}').
index(...)
S.index(sub[, start[, end]]) -> int
 
Like S.find() but raise ValueError when the substring is not found.
isalnum(...)
S.isalnum() -> bool
 
Return True if all characters in S are alphanumeric
and there is at least one character in S, False otherwise.
isalpha(...)
S.isalpha() -> bool
 
Return True if all characters in S are alphabetic
and there is at least one character in S, False otherwise.
isdecimal(...)
S.isdecimal() -> bool
 
Return True if there are only decimal characters in S,
False otherwise.
isdigit(...)
S.isdigit() -> bool
 
Return True if all characters in S are digits
and there is at least one character in S, False otherwise.
isidentifier(...)
S.isidentifier() -> bool
 
Return True if S is a valid identifier according
to the language definition.
 
Use keyword.iskeyword() to test for reserved identifiers
such as "def" and "class".
islower(...)
S.islower() -> bool
 
Return True if all cased characters in S are lowercase and there is
at least one cased character in S, False otherwise.
isnumeric(...)
S.isnumeric() -> bool
 
Return True if there are only numeric characters in S,
False otherwise.
isprintable(...)
S.isprintable() -> bool
 
Return True if all characters in S are considered
printable in repr() or S is empty, False otherwise.
isspace(...)
S.isspace() -> bool
 
Return True if all characters in S are whitespace
and there is at least one character in S, False otherwise.
istitle(...)
S.istitle() -> bool
 
Return True if S is a titlecased string and there is at least one
character in S, i.e. upper- and titlecase characters may only
follow uncased characters and lowercase characters only cased ones.
Return False otherwise.
isupper(...)
S.isupper() -> bool
 
Return True if all cased characters in S are uppercase and there is
at least one cased character in S, False otherwise.
join(...)
S.join(iterable) -> str
 
Return a string which is the concatenation of the strings in the
iterable.  The separator between elements is S.
ljust(...)
S.ljust(width[, fillchar]) -> str
 
Return S left-justified in a Unicode string of length width. Padding is
done using the specified fill character (default is a space).
lower(...)
S.lower() -> str
 
Return a copy of the string S converted to lowercase.
lstrip(...)
S.lstrip([chars]) -> str
 
Return a copy of the string S with leading whitespace removed.
If chars is given and not None, remove characters in chars instead.
partition(...)
S.partition(sep) -> (head, sep, tail)
 
Search for the separator sep in S, and return the part before it,
the separator itself, and the part after it.  If the separator is not
found, return S and two empty strings.
replace(...)
S.replace(old, new[, count]) -> str
 
Return a copy of S with all occurrences of substring
old replaced by new.  If the optional argument count is
given, only the first count occurrences are replaced.
rfind(...)
S.rfind(sub[, start[, end]]) -> int
 
Return the highest index in S where substring sub is found,
such that sub is contained within S[start:end].  Optional
arguments start and end are interpreted as in slice notation.
 
Return -1 on failure.
rindex(...)
S.rindex(sub[, start[, end]]) -> int
 
Like S.rfind() but raise ValueError when the substring is not found.
rjust(...)
S.rjust(width[, fillchar]) -> str
 
Return S right-justified in a string of length width. Padding is
done using the specified fill character (default is a space).
rpartition(...)
S.rpartition(sep) -> (head, sep, tail)
 
Search for the separator sep in S, starting at the end of S, and return
the part before it, the separator itself, and the part after it.  If the
separator is not found, return two empty strings and S.
rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings
 
Return a list of the words in S, using sep as the
delimiter string, starting at the end of the string and
working to the front.  If maxsplit is given, at most maxsplit
splits are done. If sep is not specified, any whitespace string
is a separator.
rstrip(...)
S.rstrip([chars]) -> str
 
Return a copy of the string S with trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
split(...)
S.split(sep=None, maxsplit=-1) -> list of strings
 
Return a list of the words in S, using sep as the
delimiter string.  If maxsplit is given, at most maxsplit
splits are done. If sep is not specified or is None, any
whitespace string is a separator and empty strings are
removed from the result.
splitlines(...)
S.splitlines([keepends]) -> list of strings
 
Return a list of the lines in S, breaking at line boundaries.
Line breaks are not included in the resulting list unless keepends
is given and true.
startswith(...)
S.startswith(prefix[, start[, end]]) -> bool
 
Return True if S starts with the specified prefix, False otherwise.
With optional start, test S beginning at that position.
With optional end, stop comparing S at that position.
prefix can also be a tuple of strings to try.
strip(...)
S.strip([chars]) -> str
 
Return a copy of the string S with leading and trailing
whitespace removed.
If chars is given and not None, remove characters in chars instead.
swapcase(...)
S.swapcase() -> str
 
Return a copy of S with uppercase characters converted to lowercase
and vice versa.
title(...)
S.title() -> str
 
Return a titlecased version of S, i.e. words start with title case
characters, all remaining cased characters have lower case.
translate(...)
S.translate(table) -> str
 
Return a copy of the string S in which each character has been mapped
through the given translation table. The table must implement
lookup/indexing via __getitem__, for instance a dictionary or list,
mapping Unicode ordinals to Unicode ordinals, strings, or None. If
this operation raises LookupError, the character is left untouched.
Characters mapped to None are deleted.
upper(...)
S.upper() -> str
 
Return a copy of S converted to uppercase.
zfill(...)
S.zfill(width) -> str
 
Pad a numeric string S with zeros on the left, to fill a field
of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:
maketrans(x, y=None, z=None, /)
Return a translation table usable for str.translate().
 
If there is only one argument, it must be a dictionary mapping Unicode
ordinals (integers) or characters to Unicode ordinals, strings or None.
Character keys will be then converted to ordinals.
If there are two arguments, they must be strings of equal length, and
in the resulting dictionary, each character in x will be mapped to the
character at the same position in y. If there is a third argument, it
must be a string, whose characters will be mapped to None in the result.

 
Functions
       
cmp_version(version1, version2)
cmp_version - Compare two strings which contain versions, checking which one represents a "newer" (greater) release.
 
Note that even if two version strings are not equal string-wise, they may still be equal version-wise (e.x. 1.0.0 is the same version as 1.0)
 
@param version1 <str> - A string containing a version
@param version2 <str> - A string containing a version
 
@return <int>
    -1  if version1 is older/less than version2
    0   if version1 is equal to version2
    1   if version1 is newer/greater than version2
 
So for example,
 
    cmp_version('1.0.5b', '1.0.5a') would return 1 because 1.0.5b comes after 1.0.5a

 
Data
        __all__ = ('cmp_version', 'VersionString')
__version_tuple__ = (2, 1, 1)