lsst.dax.apdb.versionTuple.VersionTuple Class Reference
Inheritance diagram for lsst.dax.apdb.versionTuple.VersionTuple:
Public Member Functions | |
| VersionTuple | fromString (cls, str versionStr) |
| bool | checkCompatibility (self, VersionTuple database_version) |
| str | __str__ (self) |
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 116 of file versionTuple.py.
116 def __str__(self) -> str:
117 """Transform version tuple into a canonical string form."""
118 return f"{self.major}.{self.minor}.{self.patch}"
◆ checkCompatibility()
| bool lsst.dax.apdb.versionTuple.VersionTuple.checkCompatibility | ( | self, | |
| VersionTuple | database_version ) |
Compare implementation schema version with schema version in
database.
Parameters
----------
database_version : `VersionTuple`
Version of the database schema.
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 and write schema made by older version; 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) -> 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
92 Returns
93 -------
94 compatible : `bool`
95 True if schema versions are compatible.
96
97 Notes
98 -----
99 This method implements default rules for checking schema compatibility:
100
101 - if major numbers differ, schemas are not compatible;
102 - otherwise, if minor versions are different then newer version can
103 read and write schema made by older version; older version can
104 neither read nor write into newer schema;
105 - otherwise, different patch versions are totally compatible.
106 """
107 if self.major != database_version.major:
108 # different major versions are not compatible at all
109 return False
110 if self.minor != database_version.minor:
111 # Different minor versions are backward compatible.
112 return self.minor > database_version.minor
113 # patch difference does not matter
114 return True
115
◆ 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
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/dax_apdb/gb88ae4c679+7dec8f19df/python/lsst/dax/apdb/versionTuple.py
Generated on Thu Nov 27 2025 09:15:10 for LSST Applications by
1.13.2