yfpy.models.Ownership

class Ownership(extracted_data)[source]

Bases: YahooFantasyObject

Model class for “ownership” data key.

Instantiate the Ownership child class of YahooFantasyObject.

Parameters:

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

display_date

The week number the player went on waivers (when applicable).

Type:

int

ownership_type

The current location of the player in the league (“team”, “waivers”, etc.).

Type:

str

owner_team_key

The Yahoo team key for the team that owns the player.

Type:

str

owner_team_name

The team name for the team that owns the player.

Type:

str

teams

A list of YFPY Team instances.

Type:

list[Team]

waiver_date

The date the player went on waivers (when applicable).

Type:

str

Methods

clean_data_dict

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

from_json

Deserialize JSON to a class object.

serialized

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

subclass_dict

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

to_json

Serialize the class object to JSON.

clean_data_dict()

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

Returns:

Dictionary that extracts serializable data from custom objects.

Return type:

dict

classmethod from_json(json_data)

Deserialize JSON to a class object.

Returns:

Class object derived from JSON data.

Return type:

object

serialized()

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

Returns:

Serializable dictionary.

Return type:

dict

subclass_dict()

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

Returns:

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

Return type:

dict

to_json()

Serialize the class object to JSON.

Returns:

JSON string derived from the serializable version of the class object.

Return type:

str