1fabfc59ee
Description: - Added data types to function arguments and return values. - Added blank lines between summary and description in docstrings to match style guidelines. - Removed extra blank lines after docstrings. - Added a missing import for SSHConnection in sma_keywords.py. - Capitalized the first word in each docstring to comply with style guide rules. - Improved docstring for PTP4LStatusObject constructor with detailed attribute descriptions Change-Id: Idada0b0b0c3f895a16f4b439beaaaf071597a16a Change-Id: I8e7756d32eb56a2aa85b277a91b26cc6280d1c56 Signed-off-by: aabhinav <ayyapasetti.abhinav@windriver.com>
90 lines
2.5 KiB
Python
90 lines
2.5 KiB
Python
class ProductVersion:
|
|
"""
|
|
This class models a ProductVersion as an object.
|
|
|
|
ProductVersions have names and can also be compared chronologically.
|
|
"""
|
|
|
|
def __init__(self, version_name: str, version_id: int):
|
|
"""
|
|
Constructor
|
|
|
|
Args:
|
|
version_name (str): The String name of the Product Version
|
|
version_id (int): Integers assigned for comparing release order
|
|
"""
|
|
self.version_name = version_name
|
|
self.version_id = version_id
|
|
|
|
def __str__(self) -> str:
|
|
"""
|
|
Returns the string representation of the product version.
|
|
|
|
Returns:
|
|
str: The version name.
|
|
"""
|
|
return self.version_name
|
|
|
|
def __hash__(self) -> int:
|
|
"""
|
|
Returns the hash of the product version based on its name.
|
|
|
|
Returns:
|
|
int: Hash value.
|
|
"""
|
|
return hash(self.version_name)
|
|
|
|
def __eq__(self, other: object) -> bool:
|
|
"""
|
|
Checks if two ProductVersion objects are equal based on their name and id.
|
|
|
|
Args:
|
|
other (object): The other ProductVersion to compare with.
|
|
|
|
Returns:
|
|
bool: True if both ProductVersion objects have the same name and id, False otherwise.
|
|
"""
|
|
return hash(self) == hash(other)
|
|
|
|
def get_name(self) -> str:
|
|
"""
|
|
Getter for the name of this version
|
|
|
|
Returns:
|
|
str: The name of the version
|
|
"""
|
|
return self.version_name
|
|
|
|
def get_id(self) -> int:
|
|
"""
|
|
Getter for the id of this version
|
|
|
|
Returns:
|
|
int: The id of the version
|
|
"""
|
|
return self.version_id
|
|
|
|
def is_before_or_equal_to(self, other_product_version: "ProductVersion") -> bool:
|
|
"""
|
|
Returns true if SELF <= other_product_version based on their id.
|
|
|
|
Args:
|
|
other_product_version (ProductVersion): The version of comparison
|
|
|
|
Returns:
|
|
bool: SELF <= other_product_version based on their id.
|
|
"""
|
|
return self.version_id <= other_product_version.version_id
|
|
|
|
def is_after_or_equal_to(self, other_product_version: "ProductVersion") -> bool:
|
|
"""
|
|
Returns true if SELF >= other_product_version based on their id.
|
|
|
|
Args:
|
|
other_product_version (ProductVersion): The version of comparison
|
|
|
|
Returns:
|
|
bool: SELF >= other_product_version based on their id.
|
|
"""
|
|
return self.version_id >= other_product_version.version_id
|