#42 - Change stderr prints to warnings

* Also create new category, tiktokapipy.TikTokAPIWarning

README.md

@@ -80,6 +80,16 @@ async with AsyncTikTokAPI() as api:
 More examples, including how to download videos and slideshows, can be found in the
 [documentation](https://tiktokpy.readthedocs.io/en/latest/users/usage.html#examples).
 
+Warnings can be ignored as follows:
+
+```py
+import warnings
+
+from tiktokapipy import TikTokAPIWarning
+
+warnings.filterwarnings("ignore", category=TikTokAPIWarning)
+```
+
 ## Documentation
 
 You can view the full documentation on [Read the Docs](https://tiktokpy.readthedocs.io/en/latest/).

docs/source/conf.py

@@ -21,7 +21,7 @@
 project = "TikTokPy"
 copyright = "2023, Russell Newton"
 author = "Russell Newton"
-release = "0.1.13"
+release = "0.1.13.post1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tiktokapipy"
-version = "0.1.13"
+version = "0.1.13.post1"
 authors = [
     { name="Russell Newton", email="[email protected]" },
 ]

src/tiktokapipy/__init__.py

@@ -2,3 +2,7 @@ class TikTokAPIError(Exception):
     """Raised when the API encounters an error"""
 
     pass
+
+
+class TikTokAPIWarning(RuntimeWarning):
+    pass

src/tiktokapipy/api.py

@@ -5,7 +5,6 @@
 from __future__ import annotations
 
 import json
-import sys
 import traceback
 import warnings
 from abc import ABC, abstractmethod
@@ -29,7 +28,7 @@
 import playwright.sync_api
 from playwright.sync_api import Page, Route, TimeoutError, sync_playwright
 from pydantic import ValidationError
-from tiktokapipy import TikTokAPIError
+from tiktokapipy import TikTokAPIError, TikTokAPIWarning
 from tiktokapipy.models import DeferredIterator, TikTokDataModel
 from tiktokapipy.models.challenge import Challenge, LightChallenge, challenge_link
 from tiktokapipy.models.raw_data import (
@@ -434,7 +433,11 @@ def capture_api_extras(route: Route):
                 page.close()
                 continue
             except TimeoutError:
-                print("Reached navigation timeout. Retrying...", file=sys.stderr)
+                warnings.warn(
+                    "Reached navigation timeout. Retrying...",
+                    category=TikTokAPIWarning,
+                    stacklevel=2,
+                )
                 page.close()
                 continue
             break
@@ -546,10 +549,11 @@ def _extract_video_from_response(
 
         video.comments = comments
         if not video.comments:
-            print(
+            warnings.warn(
                 "Was unable to collect comments.\n"
                 "A second attempt or setting a nonzero value for scroll_down_time might work.",
-                file=sys.stderr,
+                category=TikTokAPIWarning,
+                stacklevel=2,
             )
         if isinstance(video.author, LightUser):
             video.creator = self._light_user_getter_type(video.author.unique_id, self)

src/tiktokapipy/async_api.py

@@ -5,8 +5,8 @@
 from __future__ import annotations
 
 import json
-import sys
 import traceback
+import warnings
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, Callable, Generic, List, Tuple, Type
 
@@ -16,7 +16,7 @@
 import playwright.async_api
 from playwright.async_api import Page, Route, TimeoutError, async_playwright
 from pydantic import ValidationError
-from tiktokapipy import TikTokAPIError
+from tiktokapipy import TikTokAPIError, TikTokAPIWarning
 from tiktokapipy.api import (
     LightUserGetter,
     TikTokAPI,
@@ -215,7 +215,11 @@ async def capture_api_extras(route: Route):
                 await page.close()
                 continue
             except TimeoutError:
-                print("Reached navigation timeout. Retrying...", file=sys.stderr)
+                warnings.warn(
+                    "Reached navigation timeout. Retrying...",
+                    category=TikTokAPIWarning,
+                    stacklevel=2,
+                )
                 await page.close()
                 continue
             break