athena-intelligence 0.1.88__py3-none-any.whl → 0.1.90__py3-none-any.whl

athena/client.py

@@ -21,42 +21,103 @@ T = TypeVar("T")
 U = TypeVar('U')
 
 
-def _inherit_signature(f: typing.Callable[P, T]) -> typing.Callable[..., typing.Callable[P, U]]:
-    return lambda x: x
+def _inherit_signature_and_doc(
+    f: typing.Callable[P, T],
+    replace_in_doc: typing.Dict[str, str]
+) -> typing.Callable[..., typing.Callable[P, U]]:
+    def decorator(decorated):
+        for old, new in replace_in_doc.items():
+            assert old in f.__doc__
+            decorated.__doc__ = f.__doc__.replace(old, new)
+        return decorated
+    return decorator
 
 
 class WrappedToolsClient(ToolsClient):
 
     def get_file(self, document_id: str) -> io.BytesIO:
+        """
+        Parameters
+        ----------
+        document_id : str
+
+        Returns
+        -------
+        io.BytesIO
+
+        Examples
+        --------
+        import polars as pl
+        from athena.client import Athena
+
+        client = Athena(api_key="YOUR_API_KEY")
+        file_io = client.tools.get_file(document_id="document_id")
+        pl.read_csv(file_io)
+        """
         file_bytes = b''.join(self.raw_data(document_id=document_id))
         bytes_io = io.BytesIO(file_bytes)
         return bytes_io
 
-    @_inherit_signature(ToolsClient.data_frame)
+    @_inherit_signature_and_doc(ToolsClient.data_frame, {'DataFrameRequestOut': 'pd.DataFrame'})
     def data_frame(self, *, document_id: str, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         model = super().data_frame(document_id=document_id, **kwargs)
         return _read_json_frame(model)
 
     def read_data_frame(self, document_id: str, *args, **kwargs) -> 'pd.DataFrame':
+        """
+        Parameters
+        ----------
+        document_id : str
+
+        **kwargs : dict
+          keyword arguments passed to pandas `read_csv` or `read_excel` function,
+          depending on the file type of the document identified by `document_id`.
+
+        Returns
+        -------
+        pd.DataFrame
+
+        Examples
+        --------
+        from athena.client import Athena
+
+        client = Athena(api_key="YOUR_API_KEY")
+        client.tools.read_data_frame(document_id="document_id")
+        """
         _check_pandas_installed()
         file_bytes = self.get_file(document_id)
         return _to_pandas_df(file_bytes, *args, **kwargs)
 
 
+def _add_docs_for_async_variant(obj):
+    def decorator(decorated):
+        doc = obj.__doc__
+        name = obj.__name__
+        decorated.__doc__ = (
+            doc
+            .replace('client = Athena', 'client = AsyncAthena')
+            .replace(f'client.tools.{name}', f'await client.tools.{name}')
+        )
+        return decorated
+    return decorator
+
+
 class WrappedAsyncToolsClient(AsyncToolsClient):
 
+    @_add_docs_for_async_variant(WrappedToolsClient.get_file)
     async def get_file(self, document_id: str) -> io.BytesIO:
         file_bytes = b''.join([gen async for gen in self.raw_data(document_id=document_id)])
         bytes_io = io.BytesIO(file_bytes)
         return bytes_io
 
-    @_inherit_signature(ToolsClient.data_frame)
+    @_inherit_signature_and_doc(AsyncToolsClient.data_frame, {'DataFrameRequestOut': 'pd.DataFrame'})
     async def data_frame(self, *, document_id: str, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         model = await super().data_frame(document_id=document_id, **kwargs)
         return _read_json_frame(model)
 
+    @_add_docs_for_async_variant(WrappedToolsClient.read_data_frame)
     async def read_data_frame(self, document_id: str, *args, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         file_bytes = await self.get_file(document_id)
@@ -83,7 +144,7 @@ class Athena(BaseAthena):
 
     api_key: typing.Optional[str].  The API key. Required when used outside of the athena notebook environment.
     timeout : typing.Optional[float]
-        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
     httpx_client : typing.Optional[httpx.Client]
         The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
@@ -97,6 +158,8 @@ class Athena(BaseAthena):
     )
     """
 
+    tools: WrappedToolsClient
+
     def __init__(
         self,
         *,
@@ -147,7 +210,7 @@ class AsyncAthena(AsyncBaseAthena):
 
     api_key: typing.Optional[str].  The API key. Required when used outside of the athena notebook environment.
     timeout : typing.Optional[float]
-        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
     httpx_client : typing.Optional[httpx.AsyncClient]
         The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
@@ -161,6 +224,8 @@ class AsyncAthena(AsyncBaseAthena):
     )
     """
 
+    tools: WrappedAsyncToolsClient
+
     def __init__(
         self,
         *,

athena/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "athena-intelligence",
-            "X-Fern-SDK-Version": "0.1.88",
+            "X-Fern-SDK-Version": "0.1.90",
         }
         headers["X-API-KEY"] = self.api_key
         return headers

{athena_intelligence-0.1.88.dist-info → athena_intelligence-0.1.90.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: athena-intelligence
-Version: 0.1.88
+Version: 0.1.90
 Summary: Athena Intelligence Python Library
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{athena_intelligence-0.1.88.dist-info → athena_intelligence-0.1.90.dist-info}/RECORD

@@ -2,10 +2,10 @@ athena/__init__.py,sha256=vS1F7G3hdiHGM-q24LBoKf77EHpaDBrb3ZzM_sgXoGY,2801
 athena/base_client.py,sha256=yP2dIc8ja04pFizBx5xF4qhkeOPJ3V9DMfqYcW5HIGg,7119
 athena/chain/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 athena/chain/client.py,sha256=5YJJsXnXLFbPN1y0Qe__QWoQ2QOMp6zK_is_obk7Gg8,11105
-athena/client.py,sha256=evktoequsijpv_bKJP4IPLog2E7VhgDL1AgOgJ2tq_0,7833
+athena/client.py,sha256=piHOo-a8KiuQnBCsJ509zSRahXd6DCaxkzaqqTbNWME,9680
 athena/core/__init__.py,sha256=UFXpYzcGxWQUucU1TkjOQ9mGWN3A5JohluOIWVYKU4I,973
 athena/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-athena/core/client_wrapper.py,sha256=8dklUiRaBWUyJzo_CO2DsA6Syg_QwA5TK65GlyOeOTA,1805
+athena/core/client_wrapper.py,sha256=ADV3_Uf4JxBw9Vczm9GQW32We6mpjtI9ahr081hxo6g,1805
 athena/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 athena/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
 athena/core/http_client.py,sha256=Z4NuAsJD-51yqmoME17O5sxwx5orSp1wsnd6bPyKcgA,17768
@@ -87,6 +87,6 @@ athena/upload/client.py,sha256=Z44mBN3Vg_HG4uOqrzBkkNhCGETjsAlbU1RA50KDxkQ,3897
 athena/version.py,sha256=8aYAOJtVLaJLpRp6mTiEIhnl8gXA7yE0aDtZ-3mKQ4k,87
 athena/workflow/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 athena/workflow/client.py,sha256=1WGH4MCnwae5Wgb7pGfiyZRr--HscVpdHxeouNSyPe0,4023
-athena_intelligence-0.1.88.dist-info/METADATA,sha256=6GXX6FETmic5jhaAoWrnqS7zmrLk0LVu9eqL6yR4B_I,5273
-athena_intelligence-0.1.88.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-athena_intelligence-0.1.88.dist-info/RECORD,,
+athena_intelligence-0.1.90.dist-info/METADATA,sha256=0GdM4W4QOMBcDGBM97xrlEDacHScr7tDV2WgXEcwVFc,5273
+athena_intelligence-0.1.90.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+athena_intelligence-0.1.90.dist-info/RECORD,,