gemini-webapi 1.17.0__tar.gz → 1.17.2__tar.gz

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/.github/workflows/github-release.yml

@@ -11,7 +11,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: ncipollo/release-action@v1
         with:
           body: ${{ github.event.head_commit.message }}

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/.github/workflows/pypi-publish.yml

@@ -24,7 +24,7 @@ jobs:
     name: Build package
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
@@ -36,7 +36,7 @@ jobs:
       - name: Build package
         run: python -m build
       - name: Archive production artifacts
-        uses: actions/upload-artifact@v4.6.2
+        uses: actions/upload-artifact@v5.0.0
         with:
           name: dist
           path: dist
@@ -52,7 +52,7 @@ jobs:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
       - name: Retrieve built artifacts
-        uses: actions/download-artifact@v5.0.0
+        uses: actions/download-artifact@v6.0.0
         with:
           name: dist
           path: dist

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gemini-webapi
-Version: 1.17.0
+Version: 1.17.2
 Summary: ✨ An elegant async Python wrapper for Google Gemini web app
 Author: UZQueen
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -783,11 +783,11 @@ pip install -U browser-cookie3
 
 ```yaml
 services:
-  main:
-    environment:
-      GEMINI_COOKIE_PATH: /tmp/gemini_webapi
-    volumes:
-      - ./gemini_cookies:/tmp/gemini_webapi
+    main:
+        environment:
+            GEMINI_COOKIE_PATH: /tmp/gemini_webapi
+        volumes:
+            - ./gemini_cookies:/tmp/gemini_webapi
 ```
 
 > [!NOTE]
@@ -929,6 +929,23 @@ async def main():
 asyncio.run(main())
 ```
 
+You can also pass custom model header strings directly to access models which are not listed above.
+
+```python
+# "model_name" and "model_header" keys must be present
+custom_model = {
+    "model_name": "xxx",
+    "model_header": {
+        "x-goog-ext-525001261-jspb": "[1,null,null,null,'e6fa609c3fa255c0',null,null,null,[4]]"
+    },
+}
+
+response = await client.generate_content(
+    "What's your model version?",
+    model=custom_model
+)
+```
+
 ### Apply system prompt with Gemini Gems
 
 System prompt can be applied to conversations via [Gemini Gems](https://gemini.google.com/gems/view). To use a gem, you can pass `gem` argument to `GeminiClient.generate_content` or `GeminiClient.start_chat`. `gem` can be either a string of gem id or a `gemini_webapi.Gem` object. Only one gem can be applied to a single conversation.

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/README.md

@@ -99,11 +99,11 @@ pip install -U browser-cookie3
 
 ```yaml
 services:
-  main:
-    environment:
-      GEMINI_COOKIE_PATH: /tmp/gemini_webapi
-    volumes:
-      - ./gemini_cookies:/tmp/gemini_webapi
+    main:
+        environment:
+            GEMINI_COOKIE_PATH: /tmp/gemini_webapi
+        volumes:
+            - ./gemini_cookies:/tmp/gemini_webapi
 ```
 
 > [!NOTE]
@@ -245,6 +245,23 @@ async def main():
 asyncio.run(main())
 ```
 
+You can also pass custom model header strings directly to access models which are not listed above.
+
+```python
+# "model_name" and "model_header" keys must be present
+custom_model = {
+    "model_name": "xxx",
+    "model_header": {
+        "x-goog-ext-525001261-jspb": "[1,null,null,null,'e6fa609c3fa255c0',null,null,null,[4]]"
+    },
+}
+
+response = await client.generate_content(
+    "What's your model version?",
+    model=custom_model
+)
+```
+
 ### Apply system prompt with Gemini Gems
 
 System prompt can be applied to conversations via [Gemini Gems](https://gemini.google.com/gems/view). To use a gem, you can pass `gem` argument to `GeminiClient.generate_content` or `GeminiClient.start_chat`. `gem` can be either a string of gem id or a `gemini_webapi.Gem` object. Only one gem can be applied to a single conversation.

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi/client.py

@@ -68,7 +68,7 @@ class GeminiClient(GemMixin):
     __slots__ = [
         "cookies",
         "proxy",
-        "running",
+        "_running",
         "client",
         "access_token",
         "timeout",
@@ -91,7 +91,7 @@ class GeminiClient(GemMixin):
         super().__init__()
         self.cookies = {}
         self.proxy = proxy
-        self.running: bool = False
+        self._running: bool = False
         self.client: AsyncClient | None = None
         self.access_token: str | None = None
         self.timeout: float = 300
@@ -152,7 +152,7 @@ class GeminiClient(GemMixin):
             )
             self.access_token = access_token
             self.cookies = valid_cookies
-            self.running = True
+            self._running = True
 
             self.timeout = timeout
             self.auto_close = auto_close
@@ -188,7 +188,7 @@ class GeminiClient(GemMixin):
         if delay:
             await asyncio.sleep(delay)
 
-        self.running = False
+        self._running = False
 
         if self.close_task:
             self.close_task.cancel()
@@ -229,7 +229,7 @@ class GeminiClient(GemMixin):
 
             if new_1psidts:
                 self.cookies["__Secure-1PSIDTS"] = new_1psidts
-                if self.running:
+                if self._running:
                     self.client.cookies.set("__Secure-1PSIDTS", new_1psidts)
                 logger.debug("Cookies refreshed. New __Secure-1PSIDTS applied.")
 
@@ -240,7 +240,7 @@ class GeminiClient(GemMixin):
         self,
         prompt: str,
         files: list[str | Path] | None = None,
-        model: Model | str = Model.UNSPECIFIED,
+        model: Model | str | dict = Model.UNSPECIFIED,
         gem: Gem | str | None = None,
         chat: Optional["ChatSession"] = None,
         **kwargs,
@@ -254,9 +254,10 @@ class GeminiClient(GemMixin):
             Prompt provided by user.
         files: `list[str | Path]`, optional
             List of file paths to be attached.
-        model: `Model` | `str`, optional
+        model: `Model | str | dict`, optional
             Specify the model to use for generation.
-            Pass either a `gemini_webapi.constants.Model` enum or a model name string.
+            Pass either a `gemini_webapi.constants.Model` enum or a model name string to use predefined models.
+            Pass a dictionary to use custom model header strings ("model_name" and "model_header" keys must be provided).
         gem: `Gem | str`, optional
             Specify a gem to use as system prompt for the chat session.
             Pass either a `gemini_webapi.types.Gem` object or a gem id string.
@@ -287,8 +288,15 @@ class GeminiClient(GemMixin):
 
         assert prompt, "Prompt cannot be empty."
 
-        if not isinstance(model, Model):
+        if isinstance(model, str):
             model = Model.from_name(model)
+        elif isinstance(model, dict):
+            model = Model.from_dict(model)
+        elif not isinstance(model, Model):
+            raise TypeError(
+                f"'model' must be a `gemini_webapi.constants.Model` instance, "
+                f"string, or dictionary; got `{type(model).__name__}`"
+            )
 
         if isinstance(gem, Gem):
             gem_id = gem.id
@@ -362,7 +370,7 @@ class GeminiClient(GemMixin):
                         if get_nested_value(part_json, [4]):
                             body_index, body = part_index, part_json
                             break
-                    except (TypeError, ValueError):
+                    except json.JSONDecodeError:
                         continue
 
                 if not body:
@@ -372,7 +380,7 @@ class GeminiClient(GemMixin):
 
                 try:
                     error_code = get_nested_value(response_json, [0, 5, 2, 0, 1, 0], -1)
-                    match ErrorCode(error_code):
+                    match error_code:
                         case ErrorCode.USAGE_LIMIT_EXCEEDED:
                             raise UsageLimitExceeded(
                                 f"Failed to generate contents. Usage limit of {model.model_name} model has exceeded. Please try switching to another model."
@@ -443,13 +451,17 @@ class GeminiClient(GemMixin):
                             if img_part_index < body_index:
                                 continue
                             try:
-                                img_part = json.loads(part[2])
+                                img_part_body = get_nested_value(part, [2])
+                                if not img_part_body:
+                                    continue
+
+                                img_part_json = json.loads(img_part_body)
                                 if get_nested_value(
-                                    img_part, [4, candidate_index, 12, 7, 0]
+                                    img_part_json, [4, candidate_index, 12, 7, 0]
                                 ):
-                                    img_body = img_part
+                                    img_body = img_part_json
                                     break
-                            except (IndexError, TypeError, ValueError):
+                            except json.JSONDecodeError:
                                 continue
 
                         if not img_body:
@@ -614,9 +626,10 @@ class ChatSession:
         Reply id, if provided together with metadata, will override the second value in it.
     rcid: `str`, optional
         Reply candidate id, if provided together with metadata, will override the third value in it.
-    model: `Model` | `str`, optional
+    model: `Model | str | dict`, optional
         Specify the model to use for generation.
-        Pass either a `gemini_webapi.constants.Model` enum or a model name string.
+        Pass either a `gemini_webapi.constants.Model` enum or a model name string to use predefined models.
+        Pass a dictionary to use custom model header strings ("model_name" and "model_header" keys must be provided).
     gem: `Gem | str`, optional
         Specify a gem to use as system prompt for the chat session.
         Pass either a `gemini_webapi.types.Gem` object or a gem id string.
@@ -637,13 +650,13 @@ class ChatSession:
         cid: str | None = None,  # chat id
         rid: str | None = None,  # reply id
         rcid: str | None = None,  # reply candidate id
-        model: Model | str = Model.UNSPECIFIED,
+        model: Model | str | dict = Model.UNSPECIFIED,
         gem: Gem | str | None = None,
     ):
         self.__metadata: list[str | None] = [None, None, None]
         self.geminiclient: GeminiClient = geminiclient
         self.last_output: ModelOutput | None = None
-        self.model: Model | str = model
+        self.model: Model | str | dict = model
         self.gem: Gem | str | None = gem
 
         if metadata:

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi/constants.py

@@ -45,17 +45,23 @@ class Model(Enum):
     UNSPECIFIED = ("unspecified", {}, False)
     G_3_0_PRO = (
         "gemini-3.0-pro",
-        {"x-goog-ext-525001261-jspb": '[1,null,null,null,"9d8ca3786ebdfbea",null,null,null,[4]]'},
-        False,
-    )
-    G_2_5_FLASH = (
-        "gemini-2.5-flash",
-        {"x-goog-ext-525001261-jspb": '[1,null,null,null,"9ec249fc9ad08861",null,null,0,[4]]'},
+        {
+            "x-goog-ext-525001261-jspb": '[1,null,null,null,"9d8ca3786ebdfbea",null,null,0,[4]]'
+        },
         False,
     )
     G_2_5_PRO = (
         "gemini-2.5-pro",
-        {"x-goog-ext-525001261-jspb": '[1,null,null,null,"4af6c7f5da75d65d",null,null,0,[4]]'},
+        {
+            "x-goog-ext-525001261-jspb": '[1,null,null,null,"4af6c7f5da75d65d",null,null,0,[4]]'
+        },
+        False,
+    )
+    G_2_5_FLASH = (
+        "gemini-2.5-flash",
+        {
+            "x-goog-ext-525001261-jspb": '[1,null,null,null,"9ec249fc9ad08861",null,null,0,[4]]'
+        },
         False,
     )
 
@@ -69,10 +75,28 @@ class Model(Enum):
         for model in cls:
             if model.model_name == name:
                 return model
+
         raise ValueError(
             f"Unknown model name: {name}. Available models: {', '.join([model.model_name for model in cls])}"
         )
 
+    @classmethod
+    def from_dict(cls, model_dict: dict):
+        if "model_name" not in model_dict or "model_header" not in model_dict:
+            raise ValueError(
+                "When passing a custom model as a dictionary, 'model_name' and 'model_header' keys must be provided."
+            )
+
+        if not isinstance(model_dict["model_header"], dict):
+            raise ValueError(
+                "When passing a custom model as a dictionary, 'model_header' must be a dictionary containing valid header strings."
+            )
+
+        custom_model = cls.UNSPECIFIED
+        custom_model.model_name = model_dict["model_name"]
+        custom_model.model_header = model_dict["model_header"]
+        return custom_model
+
 
 class ErrorCode(IntEnum):
     """

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi/types/image.py

@@ -71,9 +71,10 @@ class Image(BaseModel):
         """
 
         filename = filename or self.url.split("/")[-1].split("?")[0]
-        try:
-            filename = re.search(r"^(.*\.\w+)", filename).group()
-        except AttributeError:
+        match = re.search(r"^(.*\.\w+)", filename)
+        if match:
+            filename = match.group()
+        else:
             if verbose:
                 logger.warning(f"Invalid filename: {filename}")
             if skip_invalid_filename:
@@ -137,19 +138,33 @@ class GeneratedImage(Image):
         return v
 
     # @override
-    async def save(self, full_size=True, **kwargs) -> str | None:
+    async def save(
+        self,
+        path: str = "temp",
+        filename: str | None = None,
+        cookies: dict | None = None,
+        verbose: bool = False,
+        skip_invalid_filename: bool = False,
+        full_size: bool = True,
+    ) -> str | None:
         """
         Save the image to disk.
 
         Parameters
         ----------
+        path: `str`, optional
+            Path to save the image, by default will save to "./temp".
         filename: `str`, optional
             Filename to save the image, generated images are always in .png format, but file extension will not be included in the URL.
             And since the URL ends with a long hash, by default will use timestamp + end of the hash as the filename.
+        cookies: `dict`, optional
+            Cookies used for requesting the content of the image. If not provided, will use the cookies from the GeneratedImage instance.
+        verbose : `bool`, optional
+            If True, will print the path of the saved file or warning for invalid file name, by default False.
+        skip_invalid_filename: `bool`, optional
+            If True, will only save the image if the file name and extension are valid, by default False.
         full_size: `bool`, optional
-            If True, will modify the default preview (512*512) URL to get the full size image.
-        kwargs: `dict`, optional
-            Other arguments to pass to `Image.save`.
+            If True, will modify the default preview (512*512) URL to get the full size image, by default True.
 
         Returns
         -------
@@ -161,8 +176,10 @@ class GeneratedImage(Image):
             self.url += "=s2048"
 
         return await super().save(
-            filename=kwargs.pop("filename", None)
+            path=path,
+            filename=filename
             or f"{datetime.now().strftime('%Y%m%d%H%M%S')}_{self.url[-10:]}.png",
-            cookies=self.cookies,
-            **kwargs,
+            cookies=cookies or self.cookies,
+            verbose=verbose,
+            skip_invalid_filename=skip_invalid_filename,
         )

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi/utils/decorators.py

@@ -1,10 +1,11 @@
 import asyncio
 import functools
+from collections.abc import Callable
 
 from ..exceptions import APIError, ImageGenerationError
 
 
-def running(retry: int = 0) -> callable:
+def running(retry: int = 0) -> Callable:
     """
     Decorator to check if GeminiClient is running before making a request.
 
@@ -18,7 +19,7 @@ def running(retry: int = 0) -> callable:
         @functools.wraps(func)
         async def wrapper(client, *args, retry=retry, **kwargs):
             try:
-                if not client.running:
+                if not client._running:
                     await client.init(
                         timeout=client.timeout,
                         auto_close=client.auto_close,
@@ -27,7 +28,7 @@ def running(retry: int = 0) -> callable:
                         refresh_interval=client.refresh_interval,
                         verbose=False,
                     )
-                    if client.running:
+                    if client._running:
                         return await func(client, *args, **kwargs)
 
                     # Should not reach here

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi/utils/parsing.py

@@ -30,8 +30,8 @@ def get_nested_value(data: list, path: list[int], default: Any = None) -> Any:
                 current_repr = f"{current_repr[:197]}..."
 
             logger.debug(
-                f"{type(e).__name__}: parsing failed at path {path} (index {i}, key '{key}') "
-                f"while attempting to get value from `{current_repr}`"
+                f"Safe navigation: path {path} ended at index {i} (key '{key}'), "
+                f"returning default. <Debug: {type(e).__name__}; Context: {current_repr}>"
             )
             return default
 

{gemini_webapi-1.17.0 → gemini_webapi-1.17.2}/src/gemini_webapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gemini-webapi
-Version: 1.17.0
+Version: 1.17.2
 Summary: ✨ An elegant async Python wrapper for Google Gemini web app
 Author: UZQueen
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -783,11 +783,11 @@ pip install -U browser-cookie3
 
 ```yaml
 services:
-  main:
-    environment:
-      GEMINI_COOKIE_PATH: /tmp/gemini_webapi
-    volumes:
-      - ./gemini_cookies:/tmp/gemini_webapi
+    main:
+        environment:
+            GEMINI_COOKIE_PATH: /tmp/gemini_webapi
+        volumes:
+            - ./gemini_cookies:/tmp/gemini_webapi
 ```
 
 > [!NOTE]
@@ -929,6 +929,23 @@ async def main():
 asyncio.run(main())
 ```
 
+You can also pass custom model header strings directly to access models which are not listed above.
+
+```python
+# "model_name" and "model_header" keys must be present
+custom_model = {
+    "model_name": "xxx",
+    "model_header": {
+        "x-goog-ext-525001261-jspb": "[1,null,null,null,'e6fa609c3fa255c0',null,null,null,[4]]"
+    },
+}
+
+response = await client.generate_content(
+    "What's your model version?",
+    model=custom_model
+)
+```
+
 ### Apply system prompt with Gemini Gems
 
 System prompt can be applied to conversations via [Gemini Gems](https://gemini.google.com/gems/view). To use a gem, you can pass `gem` argument to `GeminiClient.generate_content` or `GeminiClient.start_chat`. `gem` can be either a string of gem id or a `gemini_webapi.Gem` object. Only one gem can be applied to a single conversation.