Patch release 0.3.1 (#124)

Add Feature/team classification callback
Fix GitPython related error in colab environments

Author: AtomScott

Makefile

@@ -1,5 +1,5 @@
 .ONESHELL:
-.PHONY: clean data lint requirements tests create_environment install_develop develop_tests full_develop_test 
+.PHONY: clean data lint requirements tests create_environment install_develop develop_tests full_develop_test pyupgrade autofix all_checks ruff mypy docstring help
 
 #################################################################################
 # GLOBALS                                                                       #
@@ -28,11 +28,23 @@ mypy:
 	$(CONDA_ACTIVATE) && \
 	mypy $(i)
 
+## Upgrade code to Python 3.10
+pyupgrade:
+	$(CONDA_ACTIVATE) && \
+	pyupgrade --py310-plus $(i)	
+
 ## Check docstrings with pep257
 docstring:
 	$(CONDA_ACTIVATE) && \
 	pep257 $(i)
 
+## Run auto-fix
+autofix:
+	$(CONDA_ACTIVATE) && \
+	find $(i) -name '*.py' -exec pyupgrade --py310-plus {} \; && \
+	ruff check --fix $(i) && \
+	black $(i)
+
 ## Run all checks
 all_checks: lint mypy docstring
 

notebooks/02_user_guide/02_dataframe_visualization.ipynb

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sportslabkit"
-version = "0.3.0"
+version = "0.3.1a3"
 description = "A Python package for sports analytics."
 readme = "README.md"
 authors = ["Atom Scott <[email protected]>"]
@@ -45,7 +45,7 @@ follow_imports = "skip"
 strict_optional = true
 
 [tool.pep257]
-ignore = ["D100", "D101", "D105", "D200", "D202", "D411", "D213", "D413", "D406", "D407"]
+ignore = ["D100", "D101", "D105", "D200", "D202", "D203", "D411", "D213", "D413", "D406", "D407"]
 add_ignore = ["D102", "D103"]
 
 [tool.pytest.ini_options]

notebooks/02_user_guide/wip_09_callbacks.ipynb

@@ -7,7 +7,7 @@
 from vidgear.gears.stabilizer import Stabilizer
 
 from sportslabkit.logger import logger, tqdm
-from sportslabkit.types.types import _pathlike
+from sportslabkit.types.types import PathLike
 from sportslabkit.utils import make_video
 
 
@@ -170,10 +170,10 @@ def calibrate_camera_fisheye(objpoints, imgpoints, dim, balance=1):
 
 
 def find_intrinsic_camera_parameters(
-    media_path: _pathlike,
+    media_path: PathLike,
     fps: int = 1,
     scale: int = 4,
-    save_path: _pathlike | None = None,
+    save_path: PathLike | None = None,
     draw_on_save: bool = False,
     points_to_use: int = 50,
     calibration_method: str = "zhang",
@@ -202,6 +202,7 @@ def find_intrinsic_camera_parameters(
 
     # Support multiple video files
     from sportslabkit.camera import Camera
+
     camera = Camera(media_path)
 
     # Find corners in each video
@@ -236,10 +237,10 @@ def find_intrinsic_camera_parameters(
 
 
 def calibrate_video_from_mappings(
-    media_path: _pathlike,
+    media_path: PathLike,
     mapx: NDArray,
     mapy: NDArray,
-    save_path: _pathlike,
+    save_path: PathLike,
     stabilize: bool = True,
 ):
     """
@@ -260,6 +261,7 @@ def generator():
         stab = Stabilizer()
 
         from sportslabkit.camera import Camera
+
         camera = Camera(media_path)
         for frame in camera:
             stab_frame = stab.stabilize(frame)

pyproject.toml

@@ -2,15 +2,7 @@
 
 from __future__ import annotations
 
-from typing import (
-    Dict,
-    Generator,
-    List,
-    Mapping,
-    Optional,
-    Sequence,
-    Tuple,
-)
+from collections.abc import Generator, Mapping, Sequence
 from xml.etree import ElementTree
 
 import cv2 as cv
@@ -19,24 +11,24 @@
 
 from sportslabkit.camera.calibrate import find_intrinsic_camera_parameters
 from sportslabkit.camera.videoreader import VideoReader
-from sportslabkit.types.types import _pathlike
+from sportslabkit.types.types import PathLike
 from sportslabkit.utils import logger
 
 
 class Camera(VideoReader):
     def __init__(
         self,
-        video_path: _pathlike,
+        video_path: PathLike,
         threaded: bool = False,
         queue_size: int = 10,
-        keypoint_xml: Optional[str] = None,
-        x_range: Optional[Sequence[float]] = (0, 105),
-        y_range: Optional[Sequence[float]] = (0, 68),
-        camera_matrix: Optional[ArrayLike] = None,
-        camera_matrix_path: Optional[str] = None,
-        distortion_coefficients: Optional[str] = None,
-        distortion_coefficients_path: Optional[str] = None,
-        calibration_video_path: Optional[str] = None,
+        keypoint_xml: str | None = None,
+        x_range: Sequence[float] | None = (0, 105),
+        y_range: Sequence[float] | None = (0, 68),
+        camera_matrix: ArrayLike | None = None,
+        camera_matrix_path: str | None = None,
+        distortion_coefficients: str | None = None,
+        distortion_coefficients_path: str | None = None,
+        calibration_video_path: str | None = None,
         calibration_method: str = "zhang",
         label: str = "",
         verbose: int = 0,
@@ -272,7 +264,7 @@ def max(self):
         return 255
 
     @property
-    def keypoint_map(self) -> Dict[Tuple[int, int], Tuple[int, int]]:
+    def keypoint_map(self) -> dict[tuple[int, int], tuple[int, int]]:
         """Get dictionary of pitch keypoints in pitch space to pixel space.
 
         Returns:
@@ -308,7 +300,7 @@ def H(self) -> NDArray[np.float64]:
         return H
 
 
-def read_pitch_keypoints(xmlfile: str, annot_type: str) -> Tuple[NDArray[np.float64], NDArray[np.float64]]:
+def read_pitch_keypoints(xmlfile: str, annot_type: str) -> tuple[NDArray[np.float64], NDArray[np.float64]]:
     """Read pitch keypoints from xml file.
 
     Args:
@@ -352,7 +344,7 @@ def read_pitch_keypoints(xmlfile: str, annot_type: str) -> Tuple[NDArray[np.floa
     return src, dst
 
 
-def load_cameras(camera_info: List[Mapping]) -> List[Camera]:
+def load_cameras(camera_info: list[Mapping]) -> list[Camera]:
     """Load cameras from a list of dictionaries containing camera information.
 
     Args:

sportslabkit/callbacks.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Sequence
+from collections.abc import Sequence
 
 import numpy as np
 

sportslabkit/camera/calibrate.py

@@ -1,6 +1,5 @@
 import os
 from glob import glob
-from typing import Optional
 
 import gdown
 import numpy as np
@@ -87,7 +86,7 @@ def calibrate_from_npz(
         npzfile: str,
         output: str,
         calibration_method: str = "zhang",
-        keypoint_xml: Optional[str] = None,
+        keypoint_xml: str | None = None,
         **kwargs,
     ):
         """Calibrate a video using precomputed calibration parameters
@@ -138,7 +137,7 @@ def calibrate(
         scale: int = 1,
         pts: int = 50,
         calibration_method: str = "zhang",
-        keypoint_xml: Optional[str] = None,
+        keypoint_xml: str | None = None,
     ):
         """Calibrate video from input
 

sportslabkit/camera/camera.py

@@ -0,0 +1,5 @@
+import os
+from pathlib import Path
+
+
+CACHE_DIR = Path(os.path.expanduser("~/.cache/sportslabkit/"))