yfpy.models.Stat

class Stat(extracted_data)[source]

Bases: YahooFantasyObject

Model class for “stat” data key.

Instantiate the Stat child class of YahooFantasyObject.

Parameters:

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

abbr

The abbreviated display name of the stat.

Type:

str

bonuses

A list of YFPY Bonus instances available for this stat category.

Type:

list[Bonus]

display_name

The display name of the stat.

Type:

str

enabled

Numeric boolean (0 or 1) representing if this stat is enabled for league scoring.

Type:

int

group

The stat category (“misc”, “yds_allow”, “return”, “receiving”, “rushing”, “passing”, etc.)

Type:

str

is_excluded_from_display

Numeric boolean (0 or 1) representing if this stat is not displayed.

Type:

int

is_only_display_stat

Numeric boolean (0 or 1) representing if this stat is only for display.

Type:

int

name

The full name of the stat.

Type:

str

position_type

The player position type eligible for the stat.

Type:

str

position_types

A list of YFPY PositionType instances.

Type:

list[PositionType

sort_order

Numeric boolean (0 or 1) representing if the stat is sorted highest to lowest (1) or lowest to highest (0).

Type:

int

stat_id

The unique stat ID number in the league.

Type:

int

stat_position_types

A list of YFPY PositionType instances.

Type:

list[PositionType]

value

The value of the stat (if applicable).

Type:

float

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