updated unit tests

Martin Eastwood · Martin Eastwood · commit 892d0da5de1d · 2024-12-12T20:44:45.000Z
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -7,7 +7,7 @@ Version Numbering
 `penaltyblog` follows the SemVer versioning guidelines. For more information,
 see `semver.org <http://semver.org/>`_
 
-v0.9.0 (xxxx-xx-xx)
+v1.0.0 (xxxx-xx-xx)
 ^^^^^^^^^^^^^^
 - Removed pymc as a dependency
 - Updated all other dependency versions
@@ -19,13 +19,15 @@ v0.9.0 (xxxx-xx-xx)
 - Removed obsolete sofifa and espn scrapers
 - Optimised RPS calculation
 - Optimised ELO code
-- Refactored Kelly Criterion code
+- Optimised Kelly Criterion code
 - Updated `FootballProbabilityGrid` to store its internal matrix as a numpy array
 - Updated all example notebooks
 - Increased unit test coverage
 - Added CI/CD
 - Removed Poetry from build step
 - Updated documentation
+- Added type hinting to `Colley` class
+- Added type hinting to `Massey` class
 
 v0.8.1 (2023-09-31)
 ^^^^^^^^^^^^^^
diff --git a/penaltyblog/models/bayesian_bivariate.py b/penaltyblog/models/bayesian_bivariate.py
@@ -62,7 +62,7 @@ def __init__(
         goals_away: Union[Sequence[int], NDArray],
         teams_home: Union[Sequence[int], NDArray],
         teams_away: Union[Sequence[int], NDArray],
-        weights: Union[float, Sequence[float], NDArray],
+        weights: Union[float, Sequence[float], NDArray] = 1.0,
     ):
         """
         Initializes the BayesianBivariateGoalModel instance with the provided match data.
diff --git a/penaltyblog/models/bayesian_hierarchical.py b/penaltyblog/models/bayesian_hierarchical.py
@@ -71,7 +71,7 @@ def __init__(
         goals_away: Union[Sequence[int], NDArray],
         teams_home: Union[Sequence[int], NDArray],
         teams_away: Union[Sequence[int], NDArray],
-        weights: Union[float, Sequence[float], NDArray],
+        weights: Union[float, Sequence[float], NDArray] = 1.0,
     ):
         self.fixtures = pd.DataFrame(
             {
diff --git a/penaltyblog/models/bayesian_random_intercept.py b/penaltyblog/models/bayesian_random_intercept.py
@@ -81,7 +81,7 @@ def __init__(
         goals_away: Union[Sequence[int], NDArray],
         teams_home: Union[Sequence[int], NDArray],
         teams_away: Union[Sequence[int], NDArray],
-        weights: Union[float, Sequence[float], NDArray],
+        weights: Union[float, Sequence[float], NDArray] = 1.0,
     ):
         self.fixtures = pd.DataFrame(
             {
@@ -214,7 +214,7 @@ def fit(self, draws: int = 5000, warmup: int = 2000):
             tmp.flush()
             self.model = cmdstanpy.CmdStanModel(stan_file=tmp.name)
             self.fit_result = self.model.sample(
-                data=data, iter_sampling=draws, warmup=2000
+                data=data, iter_sampling=draws, iter_warmup=warmup
             )
 
         self.fitted = True
diff --git a/penaltyblog/models/bayesian_skellam.py b/penaltyblog/models/bayesian_skellam.py
@@ -60,7 +60,7 @@ def __init__(
         goals_away: Union[Sequence[int], NDArray],
         teams_home: Union[Sequence[int], NDArray],
         teams_away: Union[Sequence[int], NDArray],
-        weights: Union[float, Sequence[float], NDArray],
+        weights: Union[float, Sequence[float], NDArray] = 1.0,
     ):
         self.fixtures = pd.DataFrame(
             {
diff --git a/penaltyblog/models/football_probability_grid.py b/penaltyblog/models/football_probability_grid.py
@@ -1,6 +1,7 @@
 from typing import Callable, List
 
 import numpy as np
+from numpy.typing import NDArray
 
 
 class FootballProbabilityGrid:
@@ -10,7 +11,7 @@ class FootballProbabilityGrid:
 
     def __init__(
         self,
-        goal_matrix: List[List[float]],
+        goal_matrix: NDArray,
         home_goal_expectation: float,
         away_goal_expectation: float,
     ):
diff --git a/penaltyblog/ratings/colley.py b/penaltyblog/ratings/colley.py
@@ -1,5 +1,8 @@
+from typing import Sequence, Union
+
 import numpy as np
 import pandas as pd
+from numpy.typing import NDArray
 
 
 class Colley:
@@ -8,16 +11,16 @@ class Colley:
 
     Parameters
     ----------
-    goals_home : list
+    goals_home : array-like
         List of goals scored by the home teams
 
-    goals_away : list
+    goals_away : array-like
         List of goals scored by the away teams
 
-    teams_home : list
+    teams_home : array-like
         List of names of the home teams
 
-    teams_away : list
+    teams_away : array-like
         List of names of the away teams
 
     include_draws : bool
@@ -31,12 +34,12 @@ class Colley:
 
     def __init__(
         self,
-        goals_home,
-        goals_away,
-        teams_home,
-        teams_away,
-        include_draws=True,
-        draw_weight=0.5,
+        goals_home: Union[Sequence[int], NDArray],
+        goals_away: Union[Sequence[int], NDArray],
+        teams_home: Sequence[str],
+        teams_away: Sequence[str],
+        include_draws: bool = True,
+        draw_weight: float = 0.5,
     ):
         self.goals_home = goals_home
         self.goals_away = goals_away
diff --git a/penaltyblog/ratings/massey.py b/penaltyblog/ratings/massey.py
@@ -1,5 +1,8 @@
+from typing import Sequence, Union
+
 import numpy as np
 import pandas as pd
+from numpy.typing import NDArray
 
 
 class Massey:
@@ -8,25 +11,25 @@ class Massey:
 
     Parameters
     ----------
-    goals_home : list
+    goals_home : array-like
         List of goals scored by the home teams
 
-    goals_away : list
+    goals_away : array-like
         List of goals scored by the away teams
 
-    teams_home : list
+    teams_home : array-like
         List of names of the home teams
 
-    teams_away : list
+    teams_away : array-like
         List of names of the away teams
     """
 
     def __init__(
         self,
-        goals_home,
-        goals_away,
-        teams_home,
-        teams_away,
+        goals_home: Union[Sequence[int], NDArray],
+        goals_away: Union[Sequence[int], NDArray],
+        teams_home: Sequence[str],
+        teams_away: Sequence[str],
     ):
         self.goals_home = goals_home
         self.goals_away = goals_away
diff --git a/penaltyblog/version.py b/penaltyblog/version.py
@@ -1 +1 @@
-__version__ = "0.9.0"  # noqa
+__version__ = "1.0.0"  # noqa
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "penaltyblog"
-version = "0.9.0"
+version = "1.0.0"
 description = "Library from http://pena.lt/y/blog for scraping and modelling football (soccer) data"
 authors = [{ name = "Martin Eastwood", email = "martin.eastwood@gmx.com" }]
 readme = "README.md"
diff --git a/test/test_football_probability_grid.py b/test/test_football_probability_grid.py
@@ -1,30 +1,31 @@
+import numpy as np
 import pytest
 
 import penaltyblog as pb
 
 
 def test_grid():
-    m = [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3], [0.1, 0.2, 0.3]]
+    m = np.array([[0.1, 0.2, 0.3], [0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
     fpg = pb.models.FootballProbabilityGrid(m, 1, 1)
-    assert type(fpg.home_win) == float
-    assert type(fpg.draw) == float
-    assert type(fpg.away_win) == float
-    assert type(fpg.both_teams_to_score) == float
+    assert type(fpg.home_win) == np.float64
+    assert type(fpg.draw) == np.float64
+    assert type(fpg.away_win) == np.float64
+    assert type(fpg.both_teams_to_score) == np.float64
     assert type(fpg.home_draw_away) == list
-    assert type(fpg.total_goals("over", 1.5)) == float
-    assert type(fpg.total_goals("under", 1.5)) == float
-    assert type(fpg.asian_handicap("home", 1.5)) == float
-    assert type(fpg.asian_handicap("away", 1.5)) == float
+    assert type(fpg.total_goals("over", 1.5)) == np.float64
+    assert type(fpg.total_goals("under", 1.5)) == np.float64
+    assert type(fpg.asian_handicap("home", 1.5)) == np.float64
+    assert type(fpg.asian_handicap("away", 1.5)) == np.float64
 
     with pytest.raises(ValueError):
-        type(fpg.total_goals("wrong", 1.5)) == float
+        type(fpg.total_goals("wrong", 1.5)) == np.float64
 
     with pytest.raises(ValueError):
-        type(fpg.asian_handicap("wrong", 1.5)) == float
+        type(fpg.asian_handicap("wrong", 1.5)) == np.float64
 
 
 def test_str():
-    m = [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3], [0.1, 0.2, 0.3]]
+    m = np.array([[0.1, 0.2, 0.3], [0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
     fpg = pb.models.FootballProbabilityGrid(m, 1, 2)
     assert type(str(fpg)) == str
     assert "Class: FootballProbabilityGrid" in str(fpg)
diff --git a/test/test_model_bayesian_skellam.py b/test/test_model_bayesian_skellam.py
@@ -0,0 +1,49 @@
+import pytest
+
+import penaltyblog as pb
+
+
+def test_model():
+    fb = pb.scrapers.FootballData("ENG Premier League", "2019-2020")
+    df = fb.get_fixtures()
+
+    clf = pb.models.BayesianSkellamGoalModel(
+        df["goals_home"], df["goals_away"], df["team_home"], df["team_away"]
+    )
+    clf.fit()
+    probs = clf.predict("Liverpool", "Wolves")
+    assert type(probs) == pb.models.FootballProbabilityGrid
+    assert type(probs.home_draw_away) == list
+    assert len(probs.home_draw_away) == 3
+    assert 0.0 < probs.total_goals("over", 1.5) < 1.0
+    assert 0.0 < probs.asian_handicap("home", 1.5) < 1.0
+    assert 0.0 < probs.both_teams_to_score < 1.0
+    assert clf._get_team_index("Arsenal") == 0
+
+    params = clf.get_params()
+    assert 0.1 < params["home_advantage"] < 0.3
+
+
+def test_unfitted_raises_error():
+    fb = pb.scrapers.FootballData("ENG Premier League", "2019-2020")
+    df = fb.get_fixtures()
+    clf = pb.models.BayesianBivariateGoalModel(
+        df["goals_home"], df["goals_away"], df["team_home"], df["team_away"]
+    )
+
+    with pytest.raises(ValueError):
+        clf.predict("Liverpool", "Wolves")
+
+    with pytest.raises(ValueError):
+        clf.get_params()
+
+
+def test_unfitted_repr():
+    fb = pb.scrapers.FootballData("ENG Premier League", "2019-2020")
+    df = fb.get_fixtures()
+    clf = pb.models.BayesianSkellamGoalModel(
+        df["goals_home"], df["goals_away"], df["team_home"], df["team_away"]
+    )
+
+    repr = str(clf)
+    assert "Status: Model not fitted" in repr

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ def __init__(`
`71`	`71`	`goals_away: Union[Sequence[int], NDArray],`
`72`	`72`	`teams_home: Union[Sequence[int], NDArray],`
`73`	`73`	`teams_away: Union[Sequence[int], NDArray],`
`74`		`- weights: Union[float, Sequence[float], NDArray],`
	`74`	`+ weights: Union[float, Sequence[float], NDArray] = 1.0,`
`75`	`75`	`):`
`76`	`76`	`self.fixtures = pd.DataFrame(`
`77`	`77`	`{`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ def __init__(`
`60`	`60`	`goals_away: Union[Sequence[int], NDArray],`
`61`	`61`	`teams_home: Union[Sequence[int], NDArray],`
`62`	`62`	`teams_away: Union[Sequence[int], NDArray],`
`63`		`- weights: Union[float, Sequence[float], NDArray],`
	`63`	`+ weights: Union[float, Sequence[float], NDArray] = 1.0,`
`64`	`64`	`):`
`65`	`65`	`self.fixtures = pd.DataFrame(`
`66`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.9.0" # noqa`
	`1`	`+__version__ = "1.0.0" # noqa`