Inheritance diagram for lsst.dax.apdb.versionTuple.VersionTuple:
Public Member Functions | |
| VersionTuple | fromString (cls, str versionStr) |
| bool | checkCompatibility (self, VersionTuple database_version, bool update) |
| str | __str__ (self) |
Static Public Attributes | |
| int | major |
| int | minor |
| int | patch |
Detailed Description
Class representing a version number.
Parameters
----------
major, minor, patch : `int`
Version number components
Definition at line 42 of file versionTuple.py.
Member Function Documentation
◆ __str__()
| str lsst.dax.apdb.versionTuple.VersionTuple.__str__ | ( | self | ) |
Transform version tuple into a canonical string form.
Definition at line 119 of file versionTuple.py.
119 def __str__(self) -> str:
120 """Transform version tuple into a canonical string form."""
121 return f"{self.major}.{self.minor}.{self.patch}"
◆ checkCompatibility()
| bool lsst.dax.apdb.versionTuple.VersionTuple.checkCompatibility | ( | self, | |
| VersionTuple | database_version, | ||
| bool | update ) |
Compare implementation schema version with schema version in
database.
Parameters
----------
database_version : `VersionTuple`
Version of the database schema.
update : `bool`
If True then read-write access is expected.
Returns
-------
compatible : `bool`
True if schema versions are compatible.
Notes
-----
This method implements default rules for checking schema compatibility:
- if major numbers differ, schemas are not compatible;
- otherwise, if minor versions are different then newer version can
read schema made by older version, but cannot write into it;
older version can neither read nor write into newer schema;
- otherwise, different patch versions are totally compatible.
Definition at line 83 of file versionTuple.py.
83 def checkCompatibility(self, database_version: VersionTuple, update: bool) -> bool:
84 """Compare implementation schema version with schema version in
85 database.
86
87 Parameters
88 ----------
89 database_version : `VersionTuple`
90 Version of the database schema.
91 update : `bool`
92 If True then read-write access is expected.
93
94 Returns
95 -------
96 compatible : `bool`
97 True if schema versions are compatible.
98
99 Notes
100 -----
101 This method implements default rules for checking schema compatibility:
102
103 - if major numbers differ, schemas are not compatible;
104 - otherwise, if minor versions are different then newer version can
105 read schema made by older version, but cannot write into it;
106 older version can neither read nor write into newer schema;
107 - otherwise, different patch versions are totally compatible.
108 """
109 if self.major != database_version.major:
110 # different major versions are not compatible at all
111 return False
112 if self.minor != database_version.minor:
113 # different minor versions are backward compatible for read
114 # access only
115 return self.minor > database_version.minor and not update
116 # patch difference does not matter
117 return True
118
◆ fromString()
| VersionTuple lsst.dax.apdb.versionTuple.VersionTuple.fromString | ( | cls, | |
| str | versionStr ) |
Extract version number from a string.
Parameters
----------
versionStr : `str`
Version number in string form "X.Y.Z", all components must be
present.
Returns
-------
version : `VersionTuple`
Parsed version tuple.
Raises
------
ValueError
Raised if string has an invalid format.
Definition at line 56 of file versionTuple.py.
56 def fromString(cls, versionStr: str) -> VersionTuple:
57 """Extract version number from a string.
58
59 Parameters
60 ----------
61 versionStr : `str`
62 Version number in string form "X.Y.Z", all components must be
63 present.
64
65 Returns
66 -------
67 version : `VersionTuple`
68 Parsed version tuple.
69
70 Raises
71 ------
72 ValueError
73 Raised if string has an invalid format.
74 """
75 try:
76 version = tuple(int(v) for v in versionStr.split("."))
77 except ValueError as exc:
78 raise ValueError(f"Invalid version string '{versionStr}'") from exc
79 if len(version) != 3:
80 raise ValueError(f"Invalid version string '{versionStr}', must consist of three numbers")
81 return cls(*version)
82
Member Data Documentation
◆ major
|
static |
Definition at line 51 of file versionTuple.py.
◆ minor
|
static |
Definition at line 52 of file versionTuple.py.
◆ patch
|
static |
Definition at line 53 of file versionTuple.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g295015adf3+81dd352a9d/python/lsst/dax/apdb/versionTuple.py
