gemini-webapi 1.14.2__tar.gz → 1.14.3__tar.gz

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gemini-webapi
-Version: 1.14.2
+Version: 1.14.3
 Summary: ✨ An elegant async Python wrapper for Google Gemini web app
 Author: UZQueen
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -931,10 +931,14 @@ asyncio.run(main())
 
 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.
 
+> [!TIP]
+>
+> There are some system predefined gems that by default are not shown to users (and therefore may not work properly). Use `client.fetch_gems(include_hidden=True)` to include them in the fetch result.
+
 ```python
 async def main():
     # Fetch all gems for the current account, including both predefined and user-created ones
-    await client.fetch_gems()
+    await client.fetch_gems(include_hidden=False)
 
     # Once fetched, gems will be cached in `GeminiClient.gems`
     gems = client.gems

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/README.md

@@ -247,10 +247,14 @@ asyncio.run(main())
 
 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.
 
+> [!TIP]
+>
+> There are some system predefined gems that by default are not shown to users (and therefore may not work properly). Use `client.fetch_gems(include_hidden=True)` to include them in the fetch result.
+
 ```python
 async def main():
     # Fetch all gems for the current account, including both predefined and user-created ones
-    await client.fetch_gems()
+    await client.fetch_gems(include_hidden=False)
 
     # Once fetched, gems will be cached in `GeminiClient.gems`
     gems = client.gems

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/src/gemini_webapi/client.py

@@ -7,9 +7,9 @@ from pathlib import Path
 from typing import Any, Optional
 
 import orjson as json
-from httpx import AsyncClient, ReadTimeout
+from httpx import AsyncClient, ReadTimeout, Response
 
-from .constants import Endpoint, ErrorCode, Headers, Model
+from .constants import Endpoint, ErrorCode, Headers, Model, GRPC
 from .exceptions import (
     AuthError,
     APIError,
@@ -20,7 +20,15 @@ from .exceptions import (
     ModelInvalid,
     TemporarilyBlocked,
 )
-from .types import WebImage, GeneratedImage, Candidate, ModelOutput, Gem, GemJar
+from .types import (
+    WebImage,
+    GeneratedImage,
+    Candidate,
+    ModelOutput,
+    Gem,
+    GemJar,
+    RPCData,
+)
 from .utils import (
     upload_file,
     parse_file_name,
@@ -301,67 +309,61 @@ class GeminiClient:
 
         return self._gems
 
-    @running(retry=2)
-    async def fetch_gems(self, **kwargs) -> GemJar:
+    async def fetch_gems(self, include_hidden: bool = False, **kwargs) -> GemJar:
         """
         Get a list of available gems from gemini, including system predefined gems and user-created custom gems.
 
         Note that network request will be sent every time this method is called.
         Once the gems are fetched, they will be cached and accessible via `GeminiClient.gems` property.
 
+        Parameters
+        ----------
+        include_hidden: `bool`, optional
+            There are some predefined gems that by default are not shown to users (and therefore may not work properly).
+            Set this parameter to `True` to include them in the fetched gem list.
+
         Returns
         -------
         :class:`GemJar`
             Refer to `gemini_webapi.types.GemJar`.
         """
 
-        try:
-            response = await self.client.post(
-                Endpoint.BATCH_EXEC,
-                data={
-                    "at": self.access_token,
-                    "f.req": json.dumps(
-                        [
-                            [
-                                ["CNgdBe", '[2,["en"],0]', None, "custom"],
-                                ["CNgdBe", '[3,["en"],0]', None, "system"],
-                            ]
-                        ]
-                    ).decode(),
-                },
-                **kwargs,
-            )
-        except ReadTimeout:
-            raise TimeoutError(
-                "Fetch gems request timed out, please try again. If the problem persists, "
-                "consider setting a higher `timeout` value when initializing GeminiClient."
-            )
+        response = await self._batch_execute(
+            [
+                RPCData(
+                    rpcid=GRPC.LIST_GEMS,
+                    payload="[4]" if include_hidden else "[3]",
+                    identifier="system",
+                ),
+                RPCData(
+                    rpcid=GRPC.LIST_GEMS,
+                    payload="[2]",
+                    identifier="custom",
+                ),
+            ],
+            **kwargs,
+        )
 
-        if response.status_code != 200:
-            raise APIError(
-                f"Failed to fetch gems. Request failed with status code {response.status_code}"
-            )
-        else:
-            try:
-                response_json = json.loads(response.text.split("\n")[2])
+        try:
+            response_json = json.loads(response.text.split("\n")[2])
 
-                predefined_gems, custom_gems = [], []
+            predefined_gems, custom_gems = [], []
 
-                for part in response_json:
-                    if part[-1] == "system":
-                        predefined_gems = json.loads(part[2])[2]
-                    elif part[-1] == "custom":
-                        if custom_gems_container := json.loads(part[2]):
-                            custom_gems = custom_gems_container[2]
+            for part in response_json:
+                if part[-1] == "system":
+                    predefined_gems = json.loads(part[2])[2]
+                elif part[-1] == "custom":
+                    if custom_gems_container := json.loads(part[2]):
+                        custom_gems = custom_gems_container[2]
 
-                if not predefined_gems and not custom_gems:
-                    raise Exception
-            except Exception:
-                await self.close()
-                logger.debug(f"Invalid response: {response.text}")
-                raise APIError(
-                    "Failed to fetch gems. Invalid response data received. Client will try to re-initialize on next request."
-                )
+            if not predefined_gems and not custom_gems:
+                raise Exception
+        except Exception:
+            await self.close()
+            logger.debug(f"Invalid response: {response.text}")
+            raise APIError(
+                "Failed to fetch gems. Invalid response data received. Client will try to re-initialize on next request."
+            )
 
         self._gems = GemJar(
             itertools.chain(
@@ -665,6 +667,54 @@ class GeminiClient:
 
         return ChatSession(geminiclient=self, **kwargs)
 
+    @running(retry=2)
+    async def _batch_execute(self, payloads: list[RPCData], **kwargs) -> Response:
+        """
+        Execute a batch of requests to Gemini API.
+
+        Parameters
+        ----------
+        payloads: `list[GRPC]`
+            List of `gemini_webapi.types.GRPC` objects to be executed.
+        kwargs: `dict`, optional
+            Additional arguments which will be passed to the post request.
+            Refer to `httpx.AsyncClient.request` for more information.
+
+        Returns
+        -------
+        :class:`httpx.Response`
+            Response object containing the result of the batch execution.
+        """
+
+        try:
+            response = await self.client.post(
+                Endpoint.BATCH_EXEC,
+                data={
+                    "at": self.access_token,
+                    "f.req": json.dumps(
+                        [[payload.serialize() for payload in payloads]]
+                    ).decode(),
+                },
+                **kwargs,
+            )
+        except ReadTimeout:
+            raise TimeoutError(
+                "Batch execute request timed out, please try again. If the problem persists, "
+                "consider setting a higher `timeout` value when initializing GeminiClient."
+            )
+
+        if response.status_code != 200:
+            logger.debug(
+                f"Batch execution failed with status code {response.status_code}. "
+                f"RPC: {', '.join({payload.rpcid.name for payload in payloads})}; "
+                f"Invalid response: {response.text}"
+            )
+            raise APIError(
+                f"Batch execution failed with status code {response.status_code}"
+            )
+
+        return response
+
 
 class ChatSession:
     """

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/src/gemini_webapi/constants.py

@@ -10,6 +10,18 @@ class Endpoint(StrEnum):
     BATCH_EXEC = "https://gemini.google.com/_/BardChatUi/data/batchexecute"
 
 
+class GRPC(StrEnum):
+    """
+    Google RPC ids used in Gemini API.
+    """
+
+    # Chat methods
+    READ_CHAT = "hNvQHb"
+
+    # Gem methods
+    LIST_GEMS = "CNgdBe"
+
+
 class Headers(Enum):
     GEMINI = {
         "Content-Type": "application/x-www-form-urlencoded;charset=utf-8",

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/src/gemini_webapi/types/__init__.py

@@ -2,5 +2,6 @@
 
 from .candidate import Candidate
 from .gem import Gem, GemJar
+from .grpc import RPCData
 from .image import Image, WebImage, GeneratedImage
 from .modeloutput import ModelOutput

gemini_webapi-1.14.3/src/gemini_webapi/types/grpc.py

@@ -0,0 +1,34 @@
+from pydantic import BaseModel
+
+from ..constants import GRPC
+
+
+class RPCData(BaseModel):
+    """
+    Helper class containing necessary data for Google RPC calls.
+
+    Parameters
+    ----------
+    rpcid : GRPC
+        Google RPC ID.
+    payload : str
+        Payload for the RPC call.
+    identifier : str, optional
+        Identifier/order for the RPC call, defaults to "generic".
+        Makes sense if there are multiple RPC calls in a batch, where this identifier
+        can be used to distinguish between responses.
+    """
+
+    rpcid: GRPC
+    payload: str
+    identifier: str = "generic"
+
+    def __repr__(self):
+        return f"GRPC(rpcid='{self.rpcid}', payload='{self.payload}', identifier='{self.identifier}')"
+
+    def serialize(self) -> list:
+        """
+        Serializes object into formatted payload ready for RPC call.
+        """
+
+        return [self.rpcid, self.payload, None, self.identifier]

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/src/gemini_webapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gemini-webapi
-Version: 1.14.2
+Version: 1.14.3
 Summary: ✨ An elegant async Python wrapper for Google Gemini web app
 Author: UZQueen
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -931,10 +931,14 @@ asyncio.run(main())
 
 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.
 
+> [!TIP]
+>
+> There are some system predefined gems that by default are not shown to users (and therefore may not work properly). Use `client.fetch_gems(include_hidden=True)` to include them in the fetch result.
+
 ```python
 async def main():
     # Fetch all gems for the current account, including both predefined and user-created ones
-    await client.fetch_gems()
+    await client.fetch_gems(include_hidden=False)
 
     # Once fetched, gems will be cached in `GeminiClient.gems`
     gems = client.gems

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/src/gemini_webapi.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ src/gemini_webapi.egg-info/top_level.txt
 src/gemini_webapi/types/__init__.py
 src/gemini_webapi/types/candidate.py
 src/gemini_webapi/types/gem.py
+src/gemini_webapi/types/grpc.py
 src/gemini_webapi/types/image.py
 src/gemini_webapi/types/modeloutput.py
 src/gemini_webapi/utils/__init__.py

{gemini_webapi-1.14.2 → gemini_webapi-1.14.3}/tests/test_client_features.py

@@ -97,7 +97,7 @@ class TestGeminiClient(unittest.IsolatedAsyncioTestCase):
 
     @logger.catch(reraise=True)
     async def test_fetch_gems(self):
-        await self.geminiclient.fetch_gems()
+        await self.geminiclient.fetch_gems(include_hidden=True)
         gems = self.geminiclient.gems
         self.assertTrue(len(gems.filter(predefined=True)) > 0)
         for gem in gems: