`Models`¶

YFPY module containing Python object models representing all currently known Yahoo Fantasy Sports REST API data.

This module is built to abstract away the intricacies of parsing the complex and oftentimes messy data returned by the Yahoo Fantasy Sports REST API, and instead provide the user with a collection of custom classes making it easy and intuitive to access the data content.

Attributes:	`logger` (`Logger`) – Module level logger for usage and debugging.

YahooFantasyObject ¶

Bases: object

Base Yahoo Fantasy Sports data object from which all model classes inherit their methods and attributes.

Source code in yfpy/models.py

class YahooFantasyObject(object):
    """Base Yahoo Fantasy Sports data object from which all model classes inherit their methods and attributes.
    """

    def __init__(self, extracted_data: Dict):
        """Instantiate a Yahoo Fantasy Object.

        Args:
            extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

        Attributes:
            extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

        """
        self._extracted_data: Dict = extracted_data
        self._index: int = 0
        if isinstance(extracted_data, dict):
            self._keys: List = list(self._extracted_data.keys())

    def __str__(self):
        """Override __str__ to display YahooFantasyObject attribute values as JSON.
        """
        return f"{self.__class__.__name__}({self.to_json()})"

    def __repr__(self):
        """Override __repr__ to display YahooFantasyObject attribute values as JSON.
        """
        return f"{self.__class__.__name__}({self.to_json()})"

    def __getattribute__(self, attribute_name: str):
        """Override __getattribute__ to flatten lists of single-key dictionaries with objects as values to lists of
        objects.
        """
        attribute = object.__getattribute__(self, attribute_name)

        # skip builtin attributes that start with underscores and check if attribute is a list or dict
        if not attribute_name.startswith("_") and isinstance(attribute, (list, dict)):
            if attribute:
                # extract singular key from parent plural key
                attribute_element_name = None
                if attribute_name == "bonuses":
                    attribute_element_name = "bonus"
                elif attribute_name.endswith("s"):
                    attribute_element_name = attribute_name[:-1]

                if attribute_element_name:
                    if isinstance(attribute, list):
                        # flatten list of single-key dictionaries with object values to list of object values
                        return [el[attribute_element_name] if isinstance(el, dict) else el for el in attribute]
                    elif isinstance(attribute, dict):
                        # flatten single-key dictionary with object value to list of object
                        return [attribute[attribute_element_name]]
                    else:
                        return attribute
                else:
                    return attribute
            else:
                return attribute
        else:
            return attribute

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return NotImplemented
        return self._equality_field_dict() == other._equality_field_dict()

    def __len__(self):
        return len(self._extracted_data)

    def __iter__(self):
        return self

    def __next__(self):
        try:
            if isinstance(self._extracted_data, dict):
                result = self._extracted_data.get(self._keys[self._index])
            else:
                result = self._extracted_data[self._index]
        except IndexError:
            raise StopIteration
        self._index += 1
        return result

    def __reversed__(self):
        return reversed(self._keys)

    def __del__(self):
        if os.environ.get("CHECK_FOR_MISSING_YAHOO_DATA", None):
            self._check_for_missing_fields()

    def _check_for_missing_fields(self) -> List[str]:

        unknown_extracted_data_keys = list(
            set(self._keys)
            - set([att for att in (set(dir(self)) - set(dir(YahooFantasyObject))) if not att.startswith("_")])
        )
        unknown_extracted_data_key_count = len(unknown_extracted_data_keys)

        if unknown_extracted_data_key_count > 0:
            logger.debug(
                f"The Yahoo Fantasy Sports API includes {unknown_extracted_data_key_count} additional data "
                f"fields for {self.__class__.__name__} that are not included in "
                f"YFPY: {unknown_extracted_data_keys}"
            )

        return unknown_extracted_data_keys

    @staticmethod
    def _get_nested_value(obj: object, value_parents: Union[str, List], value_default: Any = None,
                          value_as: Type = None) -> Any:

        if isinstance(value_parents, str):
            value_parents = [value_parents]

        try:
            for ref in value_parents:
                if isinstance(obj, dict):
                    obj = getitem(obj, ref)
                else:
                    obj = getattr(obj, ref)
        except KeyError:
            return value_default
        except AttributeError:
            return value_default

        if obj is not None:
            if value_as is not None:
                try:
                    return value_as(obj)
                except ValueError:
                    return value_default
            else:
                return obj
        else:
            return value_default

    def _convert_to_string(self, extracted_data_key: str) -> str:
        return str(self._extracted_data.get(extracted_data_key, ""))

    def _equality_field_dict(self) -> Dict:
        return {k: v for k, v in self.__dict__.items() if k not in ["_extracted_data", "_index", "_keys"]}

    def subclass_dict(self) -> Dict:
        """Derive snake case dictionary keys from custom object type camel case class names.

        Returns:
            dict: Dictionary with snake case strings of all subclasses of YahooFantasyObject as keys and subclasses as
            values.

        """
        return {snakecase(cls.__name__): cls for cls in self.__class__.__mro__[-2].__subclasses__()}

    def clean_data_dict(self) -> Dict:
        """Recursive method to un-type custom class type objects for serialization.

        Returns:
            dict: Dictionary that extracts serializable data from custom objects.

        """
        clean_dict = {}
        for k, v in self.__dict__.items():
            if k in self._keys:
                clean_dict[k] = v.clean_data_dict() if type(v) in self.subclass_dict().values() else v
        return clean_dict

    def serialized(self) -> Dict:
        """Pack up all object content into nested dictionaries for JSON serialization.

        Returns:
            dict: Serializable dictionary.

        """
        serializable_dict = dict()
        for a, v in self.clean_data_dict().items():
            if hasattr(v, "serialized"):
                serializable_dict[a] = v.serialized()
            else:
                serializable_dict[a] = v
        return serializable_dict

    def to_json(self) -> str:
        """Serialize the class object to JSON.

        Returns:
            str: JSON string derived from the serializable version of the class object.

        """
        return jsonify_data(self.serialized())

    @classmethod
    def from_json(cls, json_data: Dict) -> object:
        """Deserialize JSON to a class object.

        Returns:
            object: Class object derived from JSON data.

        """
        return cls(json_data)

init ¶

__init__(extracted_data)

Instantiate a Yahoo Fantasy Object.

Parameters:	`extracted_data` (`dict`) – Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

Attributes:	`extracted_data` (`dict`) – Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

Source code in yfpy/models.py

def __init__(self, extracted_data: Dict):
    """Instantiate a Yahoo Fantasy Object.

    Args:
        extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

    Attributes:
        extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.

    """
    self._extracted_data: Dict = extracted_data
    self._index: int = 0
    if isinstance(extracted_data, dict):
        self._keys: List = list(self._extracted_data.keys())

str ¶

__str__()

Override str to display YahooFantasyObject attribute values as JSON.

Source code in yfpy/models.py

def __str__(self):
    """Override __str__ to display YahooFantasyObject attribute values as JSON.
    """
    return f"{self.__class__.__name__}({self.to_json()})"

repr ¶

__repr__()

Override repr to display YahooFantasyObject attribute values as JSON.

Source code in yfpy/models.py

def __repr__(self):
    """Override __repr__ to display YahooFantasyObject attribute values as JSON.
    """
    return f"{self.__class__.__name__}({self.to_json()})"

getattribute ¶

__getattribute__(attribute_name)

Override getattribute to flatten lists of single-key dictionaries with objects as values to lists of objects.

Source code in yfpy/models.py

def __getattribute__(self, attribute_name: str):
    """Override __getattribute__ to flatten lists of single-key dictionaries with objects as values to lists of
    objects.
    """
    attribute = object.__getattribute__(self, attribute_name)

    # skip builtin attributes that start with underscores and check if attribute is a list or dict
    if not attribute_name.startswith("_") and isinstance(attribute, (list, dict)):
        if attribute:
            # extract singular key from parent plural key
            attribute_element_name = None
            if attribute_name == "bonuses":
                attribute_element_name = "bonus"
            elif attribute_name.endswith("s"):
                attribute_element_name = attribute_name[:-1]

            if attribute_element_name:
                if isinstance(attribute, list):
                    # flatten list of single-key dictionaries with object values to list of object values
                    return [el[attribute_element_name] if isinstance(el, dict) else el for el in attribute]
                elif isinstance(attribute, dict):
                    # flatten single-key dictionary with object value to list of object
                    return [attribute[attribute_element_name]]
                else:
                    return attribute
            else:
                return attribute
        else:
            return attribute
    else:
        return attribute

subclass_dict ¶

subclass_dict()

Derive snake case dictionary keys from custom object type camel case class names.

Returns:	`dict`( `Dict` ) – Dictionary with snake case strings of all subclasses of YahooFantasyObject as keys and subclasses as `Dict` – values.

Source code in yfpy/models.py

def subclass_dict(self) -> Dict:
    """Derive snake case dictionary keys from custom object type camel case class names.

    Returns:
        dict: Dictionary with snake case strings of all subclasses of YahooFantasyObject as keys and subclasses as
        values.

    """
    return {snakecase(cls.__name__): cls for cls in self.__class__.__mro__[-2].__subclasses__()}

clean_data_dict ¶

clean_data_dict()

Recursive method to un-type custom class type objects for serialization.

Returns:	`dict`( `Dict` ) – Dictionary that extracts serializable data from custom objects.

Source code in yfpy/models.py

def clean_data_dict(self) -> Dict:
    """Recursive method to un-type custom class type objects for serialization.

    Returns:
        dict: Dictionary that extracts serializable data from custom objects.

    """
    clean_dict = {}
    for k, v in self.__dict__.items():
        if k in self._keys:
            clean_dict[k] = v.clean_data_dict() if type(v) in self.subclass_dict().values() else v
    return clean_dict

serialized ¶

serialized()

Pack up all object content into nested dictionaries for JSON serialization.

Returns:	`dict`( `Dict` ) – Serializable dictionary.

Source code in yfpy/models.py

def serialized(self) -> Dict:
    """Pack up all object content into nested dictionaries for JSON serialization.

    Returns:
        dict: Serializable dictionary.

    """
    serializable_dict = dict()
    for a, v in self.clean_data_dict().items():
        if hasattr(v, "serialized"):
            serializable_dict[a] = v.serialized()
        else:
            serializable_dict[a] = v
    return serializable_dict

to_json ¶

to_json()

Serialize the class object to JSON.

Returns:	`str`( `str` ) – JSON string derived from the serializable version of the class object.

Source code in yfpy/models.py

def to_json(self) -> str:
    """Serialize the class object to JSON.

    Returns:
        str: JSON string derived from the serializable version of the class object.

    """
    return jsonify_data(self.serialized())

from_json `classmethod` ¶

from_json(json_data)

Deserialize JSON to a class object.

Returns:	`object`( `object` ) – Class object derived from JSON data.

Source code in yfpy/models.py

@classmethod
def from_json(cls, json_data: Dict) -> object:
    """Deserialize JSON to a class object.

    Returns:
        object: Class object derived from JSON data.

    """
    return cls(json_data)

Models¶

YahooFantasyObject ¶

__init__ ¶

__str__ ¶

__repr__ ¶

__getattribute__ ¶

subclass_dict ¶

clean_data_dict ¶

serialized ¶

to_json ¶

from_json classmethod ¶

User ¶

__init__ ¶

Game ¶

__init__ ¶

GameWeek ¶

__init__ ¶

PositionType ¶

__init__ ¶

League ¶

__init__ ¶

Team ¶

__init__ ¶

DraftResult ¶

__init__ ¶

Standings ¶

__init__ ¶

Transaction ¶

__init__ ¶

Pick ¶

__init__ ¶

Manager ¶

__init__ ¶

Roster ¶

__init__ ¶

RosterAdds ¶

__init__ ¶

TeamLogo ¶

__init__ ¶

TeamPoints ¶

__init__ ¶

TeamProjectedPoints ¶

__init__ ¶

TeamStandings ¶

__init__ ¶

DivisionalOutcomeTotals ¶

__init__ ¶

OutcomeTotals ¶

__init__ ¶

Streak ¶

__init__ ¶

Scoreboard ¶

__init__ ¶

Settings ¶

__init__ ¶

Division ¶

__init__ ¶

RosterPosition ¶

__init__ ¶

StatCategories ¶

__init__ ¶

Group ¶

__init__ ¶

StatModifiers ¶

__init__ ¶

Stat ¶

__init__ ¶

StatPositionType ¶

__init__ ¶

Bonus ¶

__init__ ¶

Matchup ¶

__init__ ¶

MatchupGrade ¶

__init__ ¶

Player ¶

__init__ ¶

ByeWeeks ¶

__init__ ¶

DraftAnalysis ¶

`Models`¶

init ¶

str ¶

repr ¶

getattribute ¶

from_json `classmethod` ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶

init ¶