yfpy.models.RosterAdds

class RosterAdds(extracted_data)[source]

Bases: yfpy.models.YahooFantasyObject

Model class for “roster_adds” data key.

Instantiate the RosterAdds child class of YahooFantasyObject.

Parameters

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

coverage_type

The timeframe for the selected roster (“week”, “date”, “season”, etc.).

Type

str

coverage_value

The value of the coverage type (week number, for instance).

Type

int

value

The number of roster adds within the coverage timeframe.

Type

int

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