Merge pull request #96 from NodeJSmith/feature/add_state_dunder_methods

Feature/add state dunder methods to allow pickling

Author: NodeJSmith

.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "0.13.3"
+current_version = "0.14.0"
 
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(?:-(?P<rc_l>rc)(?P<rc>0|[1-9]\\d*))?"
 

.gitignore

@@ -167,3 +167,4 @@ cython_debug/
 model_generator.py
 scratch*.py
 docs/reference/
+.vscode

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "otf-api"
-version = "0.13.3"
+version = "0.14.0"
 description = "Python OrangeTheory Fitness API Client"
 authors = [{ name = "Jessica Smith", email = "[email protected]" }]
 requires-python = ">=3.11"
@@ -39,7 +39,6 @@ Documentation = "https://otf-api.readthedocs.io/en/stable/"
 dev = [
     "build==1.2.1",
     "bump-my-version>=0.23.0,<0.24",
-    "mypy==1.10.0",
     "mypy-boto3-cognito-identity>=1.38.0",
     "mypy-boto3-cognito-idp>=1.35.93,<2",
     "pre-commit==3.7.1",
@@ -51,7 +50,7 @@ dev = [
 docs = [
     "autodoc-pydantic>=2.2.0",
     "furo>=2024.8.6",
-    "sphinx==8.3.0",
+    "sphinx>=8.3.0",
     "sphinx-autobuild==2024.10.3",
     "sphinx-autodoc-typehints==3.2.0",
     "sphinx-autodoc2==0.5.0",
@@ -72,5 +71,5 @@ default-groups = ["dev"]
 pythonpath = ["src"]
 
 [build-system]
-requires = ["setuptools >= 61.0"]
+requires = ["setuptools >= 80.0"]
 build-backend = "setuptools.build_meta"

source/conf.py

@@ -14,7 +14,7 @@
 project = "OrangeTheory API"
 copyright = "2025, Jessica Smith"
 author = "Jessica Smith"
-release = "0.13.3"
+release = "0.14.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

src/otf_api/__init__.py

@@ -36,7 +36,7 @@ def _setup_logging() -> None:
 
 _setup_logging()
 
-__version__ = "0.13.3"
+__version__ = "0.14.0"
 
 
 __all__ = ["Otf", "OtfUser", "models"]

src/otf_api/api/client.py

@@ -49,6 +49,21 @@ def __init__(self, user: OtfUser | None = None):
         )
         atexit.register(self.session.close)
 
+    def __getstate__(self):
+        """Get the state of the OtfClient instance for serialization."""
+        state = self.__dict__.copy()
+        # Remove circular references
+        state.pop("session", None)
+        return state
+
+    def __setstate__(self, state):  # noqa
+        """Set the state of the OtfClient instance from serialized data."""
+        self.__dict__.update(state)
+        self.session = httpx.Client(
+            headers=HEADERS, auth=self.user.httpx_auth, timeout=httpx.Timeout(20.0, connect=60.0)
+        )
+        atexit.register(self.session.close)
+
     def _build_request(
         self,
         method: str,

src/otf_api/api/members/member_client.py

@@ -14,7 +14,7 @@ def __init__(self, client: OtfClient):
         self.client = client
         self.member_uuid = client.member_uuid
 
-    @CACHE.memoize(expire=600, tag="member_detail", ignore=(0,))
+    @CACHE.memoize(expire=600, tag="member_detail")
     def get_member_detail(self) -> dict:
         """Retrieve raw member details."""
         return self.client.default_request(

src/otf_api/api/studios/studio_client.py

@@ -15,7 +15,7 @@ def __init__(self, client: OtfClient):
         self.client = client
         self.member_uuid = client.member_uuid
 
-    @CACHE.memoize(expire=600, tag="studio_detail", ignore=(0,))
+    @CACHE.memoize(expire=600, tag="studio_detail")
     def get_studio_detail(self, studio_uuid: str) -> dict:
         """Retrieve raw studio details."""
         return self.client.default_request("GET", f"/mobile/v1/studios/{studio_uuid}")["data"]

src/otf_api/api/workouts/workout_client.py

@@ -43,7 +43,7 @@ def get_performance_summaries(self, limit: int | None = None) -> dict:
         params = {"limit": limit} if limit else {}
         return self.performance_summary_request("GET", "/v1/performance-summaries", params=params)
 
-    @CACHE.memoize(expire=600, tag="performance_summary", ignore=(0,))
+    @CACHE.memoize(expire=600, tag="performance_summary")
     def get_performance_summary(self, performance_summary_id: str) -> dict:
         """Retrieve raw performance summary data."""
         return self.performance_summary_request("GET", f"/v1/performance-summaries/{performance_summary_id}")
@@ -54,7 +54,7 @@ def get_hr_history_raw(self) -> dict:
             "history"
         ]
 
-    @CACHE.memoize(expire=600, tag="telemetry", ignore=(0,))
+    @CACHE.memoize(expire=600, tag="telemetry")
     def get_telemetry(self, performance_summary_id: str, max_data_points: int = 150) -> dict:
         """Retrieve raw telemetry data."""
         return self.telemetry_request(

src/otf_api/auth/auth.py

@@ -340,6 +340,20 @@ def _set_tokens(self, tokens: "InitiateAuthResponseTypeDef") -> None:
         self.device_group_key = device_metadata.get("DeviceGroupKey", self.device_group_key)
         CACHE.write_device_data_to_cache(self.device_metadata)
 
+    def __getstate__(self):
+        """Get the state of the object for pickling."""
+        state = self.__dict__.copy()
+        del state["idp_client"]
+        del state["id_client"]
+        return state
+
+    def __setstate__(self, state):  # noqa
+        """Set the state of the object from a pickled state."""
+        self.__dict__.update(state)
+        self.idp_client = Session().client("cognito-idp", config=BOTO_CONFIG, region_name=REGION)  # type: ignore
+
+        self.id_client = Session().client("cognito-identity", config=BOTO_CONFIG, region_name=REGION)  # type: ignore
+
 
 class HttpxCognitoAuth(httpx.Auth):
     http_header: str = "Authorization"