yfpy.models.RosterPosition

class RosterPosition(extracted_data)

Bases: YahooFantasyObject

Model class for “roster_position” data key.

Instantiate the RosterPosition child class of YahooFantasyObject.

Parameters:

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

abbreviation

The abbreviated position string.

Type:

str

count

The number of roster slots available for this position.

Type:

int

display_name

The unabbreviated position string.

Type:

str

is_bench

Numeric boolean (0 or 1) representing if the roster position is the bench position.

Type:

int

is_starting_position

Numeric boolean (0 or 1) representing if the roster position is in the starting lineup and scores points.

Type:

int

position

The abbreviated position string.

Type:

str

position_type

The position type (“O” for offense, etc.)

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