Types

Internal types

Script exposing auxiliary global variables, functions and types to provide a minimal typed structure to items.

AirlineLocation

Item that is location attribute of an airline

Source code in src/rmlab/_data/types.py

class AirlineLocation:
    """Item that is location attribute of an airline"""

    pass

BoundedItem

Bases: Item

Item whose elements are bounded. The amount of unbounded items grows with the size/space of the underlying scenario

Source code in src/rmlab/_data/types.py

class BoundedItem(Item):
    """Item whose elements are bounded. The amount of unbounded items grows with the size/space of the underlying scenario"""

    pass

CoreItem

Item initialized from direct data upload

Source code in src/rmlab/_data/types.py

class CoreItem:
    """Item initialized from direct data upload"""

    pass

CustomersModelHolder dataclass

Item associated with specific customers models

Source code in src/rmlab/_data/types.py

@dataclass
class CustomersModelHolder:
    """Item associated with specific customers models"""

    crequest_id: str
    cchoice_id: str

DerivedItem

Item initialized from other item categories

Source code in src/rmlab/_data/types.py

class DerivedItem:
    """Item initialized from other item categories"""

    pass

Item dataclass

Base class for all Item classes

Source code in src/rmlab/_data/types.py

@dataclass
class Item:
    """Base class for all Item classes"""

    id: str

PricingModelHolder dataclass

Item associated with specific pricing models

Source code in src/rmlab/_data/types.py

@dataclass
class PricingModelHolder:
    """Item associated with specific pricing models"""

    prange_id: str
    pbehavior_id: str
    poptimizer_id: str

UnboundedItem

Bases: Item

Item whose elements are unbounded. The amount of unbounded items grows with the time period of the underlying scenario, which is in general unlimited

Source code in src/rmlab/_data/types.py

class UnboundedItem(Item):
    """Item whose elements are unbounded. The amount of unbounded items grows with the time period of the underlying scenario, which is in general unlimited"""

    pass

fields_of_dataclass(category)

Return the fields of a dataclass as a list of strings.

Parameters:

Name	Type	Description	Default
category	type	Class of any category	required

Returns:

Type	Description
List[str]	List of fields as strings

Source code in src/rmlab/_data/types.py

def fields_of_dataclass(category: type) -> List[str]:
    """Return the fields of a dataclass as a list of strings.

    Args:
        category (type): Class of any category

    Returns:
        List of fields as strings
    """

    flds = set()

    for base_class in inspect.getmro(category):
        if is_dataclass(base_class):
            flds.update({f.name for f in fields(base_class)})

    return list(flds)