Firmware

Firmware dataclass

Firmware(version: str, date: date)

Represents a firmware <version> sub-element in an equipment register.

Parameters:

Name	Type	Description	Default
version	str	Firmware version number.	required
date	date	The date that the firmware was initially at or changed to version.	required

date instance-attribute

date: date

The date that the firmware was initially at or changed to version.

version instance-attribute

version: str

Firmware version number.

from_xml classmethod

from_xml(element: Element[str]) -> Firmware

Convert an XML element into a Firmware instance.

Parameters:

Name	Type	Description	Default
element	Element[str]	A firmware <version> XML sub-element from an equipment register.	required

Returns:

Type	Description
Firmware	The Firmware instance.

Source code in src/msl/equipment/schema.py

@classmethod
def from_xml(cls, element: Element[str]) -> Firmware:
    """Convert an XML element into a [Firmware][msl.equipment.schema.Firmware] instance.

    Args:
        element: A [firmware][type_firmware] `<version>` XML sub-element
            from an equipment register.

    Returns:
        The [Firmware][msl.equipment.schema.Firmware] instance.
    """
    return cls(version=element.text or "", date=_date.fromisoformat(element.attrib["date"]))

to_xml

to_xml() -> Element[str]

Convert the Firmware class into a <version> XML element.

Returns:

Type	Description
Element[str]	The Firmware as a <version> XML element.

Source code in src/msl/equipment/schema.py

def to_xml(self) -> Element[str]:
    """Convert the [Firmware][msl.equipment.schema.Firmware] class into a `<version>` XML element.

    Returns:
        The [Firmware][msl.equipment.schema.Firmware] as a `<version>` XML element.
    """
    e = Element("version", attrib={"date": self.date.isoformat()})
    e.text = self.version
    return e