Skip to content

Vehicle

Vehicle Class Documentation

Represents a racing vehicle with details such as number, manufacturer, chassis, engine, tire, and associated team.

Attributes:

Name Type Description
vehicle_json dict

JSON data containing vehicle details.
espn_instance

An instance of the ESPN API client.
number str or None

The vehicle's number.
manufacturer str or None

The vehicle's manufacturer.
chassis str or None

The vehicle's chassis type.
engine str or None

The engine used in the vehicle.
tire str or None

The tire manufacturer.
team str or None

The team associated with the vehicle.

Methods:

Name Description
_set_vehicle_data

Extracts and sets vehicle details from the JSON data.
Source code in pyespn/classes/vehicle.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@validate_json("vehicle_json")
class Vehicle:
    """
    Represents a racing vehicle with details such as number, manufacturer,
    chassis, engine, tire, and associated team.

    Attributes:
        vehicle_json (dict): JSON data containing vehicle details.
        espn_instance: An instance of the ESPN API client.
        number (str or None): The vehicle's number.
        manufacturer (str or None): The vehicle's manufacturer.
        chassis (str or None): The vehicle's chassis type.
        engine (str or None): The engine used in the vehicle.
        tire (str or None): The tire manufacturer.
        team (str or None): The team associated with the vehicle.

    Methods:
        _set_vehicle_data(): Extracts and sets vehicle details from the JSON data.
    """

    def __init__(self, vehicle_json, espn_instance):
        """
        Initializes a Vehicle instance.

        Args:
            vehicle_json (dict): JSON data containing vehicle details.
            espn_instance (PYESPN): An instance of the ESPN API client.
        """
        self.vehicle_json = vehicle_json
        self._espn_instance = espn_instance
        self._set_vehicle_data()

    def __repr__(self) -> str:
        """
        Returns a string representation of the Vehicle instance.

        Returns:
            str: A formatted string with the Vehicles name.
        """
        return f"<Vehicle | {self.team}, {self.manufacturer} ({self.number})>"

    def _set_vehicle_data(self):
        """
        Extracts and assigns vehicle details from the provided JSON data.
        """
        self.number = self.vehicle_json.get('number')
        self.manufacturer = self.vehicle_json.get('manufacturer')
        self.chassis = self.vehicle_json.get('chassis')
        self.engine = self.vehicle_json.get('engine')
        self.tire = self.vehicle_json.get('tire')
        self.team = self.vehicle_json.get('team')

    @property
    def espn_instance(self):
        """
            PYESPN: the espn client instance associated with the class
        """
        return self._espn_instance

    def to_dict(self) -> dict:
        """
        Converts the Vehicle instance to its original JSON dictionary.

        Returns:
            dict: The vehicle's raw JSON data.
        """
        return self.vehicle_json

espn_instance property

PYESPN: the espn client instance associated with the class

__init__(vehicle_json, espn_instance)

Initializes a Vehicle instance.

Parameters:

Name Type Description Default
vehicle_json dict

JSON data containing vehicle details.

 required
espn_instance PYESPN

An instance of the ESPN API client.

 required
Source code in pyespn/classes/vehicle.py 
24
25
26
27
28
29
30
31
32
33
34
def __init__(self, vehicle_json, espn_instance):
    """
    Initializes a Vehicle instance.

    Args:
        vehicle_json (dict): JSON data containing vehicle details.
        espn_instance (PYESPN): An instance of the ESPN API client.
    """
    self.vehicle_json = vehicle_json
    self._espn_instance = espn_instance
    self._set_vehicle_data()

__repr__()

Returns a string representation of the Vehicle instance.

Returns:

Name Type Description
str str

A formatted string with the Vehicles name.
Source code in pyespn/classes/vehicle.py 
36
37
38
39
40
41
42
43
def __repr__(self) -> str:
    """
    Returns a string representation of the Vehicle instance.

    Returns:
        str: A formatted string with the Vehicles name.
    """
    return f"<Vehicle | {self.team}, {self.manufacturer} ({self.number})>"

to_dict()

Converts the Vehicle instance to its original JSON dictionary.

Returns:

Name Type Description
dict dict

The vehicle's raw JSON data.
Source code in pyespn/classes/vehicle.py 
63
64
65
66
67
68
69
70
def to_dict(self) -> dict:
    """
    Converts the Vehicle instance to its original JSON dictionary.

    Returns:
        dict: The vehicle's raw JSON data.
    """
    return self.vehicle_json