Adding get_constructors()

README.md

@@ -43,6 +43,7 @@ The package currently contains nine functions
 | fp.pit_stops(year, round, stop_number)           	| Returns the pit stop info for a specific race/pit stop 	                      | Pandas DataFrame  	|
 | fp.finishing_status(year,race_round)  | Returns the finishing status of races in a year (or a particular race if specified)     | Pandas DataFrame  |
 |fp.get_drivers(year, race_round) | Returns information on drivers in a given year (or a particular race if specified) | Pandas DataFrame |
+|fp.get_constructors(year) | Returns information on constructors in a given year | Pandas DataFrame |
 |fp.sprint_results(year,race_round) | Returns the sprint qualifying results for a specific race | Pandas DataFrame|
 
 

f1pystats/__init__.py

@@ -11,4 +11,5 @@
                         pit_stops,
                         get_drivers,
                         finishing_status,
+                        get_constructors,
                         sprint_results)

f1pystats/constructor_info.py

@@ -0,0 +1,15 @@
+"""Contains all the functions used by get_constructors()"""
+
+
+class ConstructorInfo:
+    """This is the class which stores all the functions for get_constructors"""
+    def __init__(self, info):
+        self.info = info
+
+    def get_constructors_names(self):
+        """Returns the list of constructor names"""
+        return [i["name"] for i in self.info]
+
+    def get_constructors_nationality(self):
+        """Returns the list constructor nationalities"""
+        return [i["nationality"] for i in self.info]

f1pystats/f1pystats.py

@@ -21,6 +21,8 @@
 
 from .driver_info import DriverInfo
 
+from .constructor_info import ConstructorInfo
+
 
 def get_drivers(year: int, round_num: int = None):
     """Returns a list of drivers for a specified year"""
@@ -239,6 +241,26 @@ def sprint_results(year: int, race_round: int):
         ]
     )
 
+def get_constructors(year: int = None):
+    """Returns a list of constructors for a specified year"""
+
+    if year is None:
+        url = "http://ergast.com/api/f1/constructors.json"
+    else:
+        url = f"http://ergast.com/api/f1/{year}/constructors.json"
+
+    json_data = _get_json_content_from_url(url)
+
+    constructors_info = ConstructorInfo(json_data["MRData"]["ConstructorTable"]["Constructors"])
+
+    constructors_names = constructors_info.get_constructors_names()
+    constructors_nationalities = constructors_info.get_constructors_nationality()
+
+    return pd.DataFrame(
+        zip(constructors_names, constructors_nationalities),
+        columns=["Constructor", "Nationality"],
+    )
+
 def _get_json_content_from_url(url, *args, timeout: int = 15, **kwargs):
     """Returns JSON content from requestsm URL"""
     return requests.get(url, *args, timeout=timeout, **kwargs).json()

tests/test_constructor_info.py

@@ -0,0 +1,29 @@
+"""This module is responsible for testing the methods in constructor_info.py"""
+
+import json
+from f1pystats.constructor_info import ConstructorInfo
+
+
+class TestConstructorInfo:
+    """Contains functions for testing the methods in ConstructorInfo"""
+
+    data = ""
+    with open("tests/test_data/sample_constructor_info_2010.json", encoding="utf-8") as f:
+        data = json.load(f)
+        f.close()
+
+    constructor = ConstructorInfo(data)
+
+    def test_constructors_names(self):
+        """Test for the get_constructors_names methods of ConstructorInfo"""
+        assert self.constructor.get_constructors_names() == ['Ferrari',
+                                                             'Force India',
+                                                             'HRT',
+                                                             'Lotus']
+
+    def test_constructors_nationalities(self):
+        """Test for the get_constructors_nationality method of ConstructorInfo"""
+        assert self.constructor.get_constructors_nationality() == ['Italian',
+                                                                   'Indian',
+                                                                   'Spanish',
+                                                                   'Malaysian']

tests/test_data/sample_constructor_info_2010.json

@@ -0,0 +1,26 @@
+[
+  {
+    "constructorId": "ferrari",
+    "url": "http:\/\/en.wikipedia.org\/wiki\/Scuderia_Ferrari",
+    "name": "Ferrari",
+    "nationality": "Italian"
+  },
+  {
+    "constructorId": "force_india",
+    "url": "http:\/\/en.wikipedia.org\/wiki\/Racing_Point_Force_India",
+    "name": "Force India",
+    "nationality": "Indian"
+  },
+  {
+    "constructorId": "hrt",
+    "url": "http:\/\/en.wikipedia.org\/wiki\/Hispania_Racing",
+    "name": "HRT",
+    "nationality": "Spanish"
+  },
+  {
+    "constructorId": "lotus_racing",
+    "url": "http:\/\/en.wikipedia.org\/wiki\/Lotus_Racing",
+    "name": "Lotus",
+    "nationality": "Malaysian"
+  }
+]