2025-11-20 release: Version 0.1.13 (#24)

- Add missing dependency on `protobuf` in `pyproject.toml`.
- Fix type for KaggleClient#http_client method
- Allow overriding the user-agent at KaggleClient initialization
- Add a new "TEST" KaggleEnv pointing to a special port on localhost to
avoid conflict between the mock server and kaggleazure server in unit
tests.

http://b/307576378

Author: rosbo

kagglesdk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.12"
+__version__ = "0.1.13"
 
 from kagglesdk.kaggle_client import KaggleClient
 from kagglesdk.kaggle_creds import KaggleCredentials

kagglesdk/benchmarks/types/benchmark_types.py

@@ -182,7 +182,7 @@ class NumericResult(KaggleObject):
       as a +- value.
     uneven_confidence_interval (UnevenConfidenceInterval)
       For asymmetric confidence intervals in which the +/- values differ
-      If set, prioritized over confidence_interval
+      If set, prioritized over confidence_interval (if both are set)
   """
 
   def __init__(self):
@@ -226,7 +226,7 @@ def confidence_interval(self, confidence_interval: Optional[float]):
   def uneven_confidence_interval(self) -> Optional['UnevenConfidenceInterval']:
     r"""
     For asymmetric confidence intervals in which the +/- values differ
-    If set, prioritized over confidence_interval
+    If set, prioritized over confidence_interval (if both are set)
     """
     return self._uneven_confidence_interval or None
 

kagglesdk/competitions/types/competition_api_service.py

@@ -1570,7 +1570,7 @@ class ApiListDataFilesResponse(KaggleObject):
 
   def __init__(self):
     self._files = []
-    self._next_page_token = ""
+    self._next_page_token = None
     self._children_fetch_time_ms = 0
     self._freeze()
 
@@ -1591,10 +1591,10 @@ def files(self, files: Optional[List[Optional['ApiDataFile']]]):
 
   @property
   def next_page_token(self) -> str:
-    return self._next_page_token
+    return self._next_page_token or ""
 
   @next_page_token.setter
-  def next_page_token(self, next_page_token: str):
+  def next_page_token(self, next_page_token: Optional[str]):
     if next_page_token is None:
       del self.next_page_token
       return
@@ -2338,7 +2338,7 @@ def url(self, url: Optional[str]):
 
 ApiListDataFilesResponse._fields = [
   FieldMetadata("files", "files", "_files", ApiDataFile, [], ListSerializer(KaggleObjectSerializer())),
-  FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, "", PredefinedSerializer()),
+  FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, None, PredefinedSerializer(), optional=True),
   FieldMetadata("childrenFetchTimeMs", "children_fetch_time_ms", "_children_fetch_time_ms", int, 0, PredefinedSerializer()),
 ]
 

kagglesdk/discussions/types/search_discussions.py

@@ -20,6 +20,8 @@ class SearchDiscussionsSourceType(enum.Enum):
   SEARCH_DISCUSSIONS_SOURCE_TYPE_MODEL = 7
   SEARCH_DISCUSSIONS_SOURCE_TYPE_WRITE_UP = 8
   SEARCH_DISCUSSIONS_SOURCE_TYPE_LEARN_TRACK = 9
+  SEARCH_DISCUSSIONS_SOURCE_TYPE_BENCHMARK = 10
+  SEARCH_DISCUSSIONS_SOURCE_TYPE_BENCHMARK_TASK = 11
 
 class SearchDiscussionsTopicType(enum.Enum):
   SEARCH_DISCUSSIONS_TOPIC_TYPE_UNSPECIFIED = 0

kagglesdk/kaggle_client.py

@@ -69,8 +69,8 @@ def __init__(self, http_client: KaggleHttpClient):
       self.account_client = AccountClient(http_client)
       self.group_api_client = GroupApiClient(http_client)
 
-  def __init__(self, env: KaggleEnv = None, verbose: bool = False, username: str = None, password: str = None, api_token: str = None):
-    self._http_client = http_client = KaggleHttpClient(env, verbose, username=username, password=password, api_token=api_token)
+  def __init__(self, env: KaggleEnv = None, verbose: bool = False, username: str = None, password: str = None, api_token: str = None, user_agent: str = None):
+    self._http_client = http_client = KaggleHttpClient(env, verbose, username=username, password=password, api_token=api_token, user_agent=user_agent)
     self.admin = KaggleClient.Admin(http_client)
     self.benchmarks = KaggleClient.Benchmarks(http_client)
     self.blobs = KaggleClient.Blobs(http_client)
@@ -87,7 +87,7 @@ def __init__(self, env: KaggleEnv = None, verbose: bool = False, username: str =
     self.password = password
     self.api_token = api_token
 
-  def http_client(self) -> str:
+  def http_client(self) -> KaggleHttpClient:
     return self._http_client
 
   def _renew_iap_token(self) -> str:

kagglesdk/kaggle_env.py

@@ -18,6 +18,7 @@ class KaggleEnv(Enum):
     ADMIN = 2  # admin.kaggle.com
     QA = 3  # qa.kaggle.com
     PROD = 4  # api.kaggle.com
+    TEST = 5 # localhost:7777
 
 
 _env_to_endpoint = {
@@ -26,6 +27,7 @@ class KaggleEnv(Enum):
     KaggleEnv.ADMIN: "https://admin.kaggle.com",
     KaggleEnv.QA: "https://qa.kaggle.com",
     KaggleEnv.PROD: "https://api.kaggle.com",
+    KaggleEnv.TEST: "http://localhost:7777"
 }
 
 
@@ -45,6 +47,8 @@ def get_env():
         return KaggleEnv.STAGING
     if env == "QA":
         return KaggleEnv.QA
+    if env == "TEST":
+        return KaggleEnv.TEST
     raise Exception(f'Unrecognized value in KAGGLE_API_ENVIRONMENT: "{env}"')
 
 

kagglesdk/kaggle_http_client.py

@@ -59,6 +59,7 @@ def __init__(
         username: str = None,
         password: str = None,
         api_token: str = None,
+        user_agent: str = "kaggle-api/v1.7.0", # Was: V2
     ):
         self._env = env or get_env()
         self._signed_in = None
@@ -68,6 +69,7 @@ def __init__(
         self._username = username
         self._password = password
         self._api_token = api_token
+        self._user_agent = user_agent
 
     def call(
         self,
@@ -147,7 +149,7 @@ def _init_session(self):
             return self._session
 
         self._session = requests.Session()
-        self._session.headers.update({"User-Agent": "kaggle-api/v1.7.0", "Content-Type": "application/json"})  # Was: V2
+        self._session.headers.update({"User-Agent": self._user_agent, "Content-Type": "application/json"})
 
         iap_token = self._get_iap_token_if_required()
         if iap_token is not None:

pyproject.toml

@@ -21,12 +21,13 @@ classifiers = [
 keywords = ["Kaggle", "API"]
 requires-python = ">=3.9"
 dependencies = [
-  "requests", 
+  "requests",
+  "protobuf",
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/Kaggle/kagglesdk"
 "Bug Tracker" = "https://github.com/Kaggle/kagglesdk/issues"
 
 [tool.hatch.version]
-path = "kagglesdk/__init__.py"
+path = "kagglesdk/__init__.py"