Add response_format parameter to get_item_info function

Author: vvaezian

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.5.2
+### Changed
+- Add `response_format` parameter to `get_item_info` function 
+
+## 3.5.1
+### Changed
+- Add timeout argument for the async client
+
 ## 3.5
 ### Added
 - Asynchronous API support using `httpx`

metabase_api/_helper_methods.py

@@ -2,7 +2,7 @@
 def get_item_info(self, item_type
                 , item_id=None, item_name=None
                 , collection_id=None, collection_name=None
-                , params=None):
+                , params=None, response_mode=None):
     '''
     Return the info for the given item.
     Use 'params' for providing arguments. E.g. to include tables in the result for databases, use: params={'include':'tables'}
@@ -18,11 +18,15 @@ def get_item_info(self, item_type
             raise ValueError('Either the name or id of the {} must be provided.'.format(item_type))
         item_id = self.get_item_id(item_type, item_name, collection_id=collection_id, collection_name=collection_name)
 
-    res = self.get("/api/{}/{}".format(item_type, item_id), params=params)
-    if res:
+    if response_mode == 'raw':
+        res = self.get("/api/{}/{}".format(item_type, item_id), 'raw', params=params)
         return res
     else:
-        raise ValueError('There is no {} with the id "{}"'.format(item_type, item_id))
+        res = self.get("/api/{}/{}".format(item_type, item_id), params=params)
+        if res:
+            return res
+        else:
+            raise ValueError('There is no {} with the id "{}"'.format(item_type, item_id))
 
 
 

metabase_api/_helper_methods_async.py

@@ -1,7 +1,7 @@
 
 async def get_item_info(self, item_type, item_id=None, item_name=None,
                             collection_id=None, collection_name=None,
-                            params=None):
+                            params=None, response_mode=None):
     """Async version of get_item_info"""
     assert item_type in ['database', 'table', 'card', 'collection', 'dashboard', 'pulse', 'segment']
 
@@ -13,11 +13,15 @@ async def get_item_info(self, item_type, item_id=None, item_name=None,
             raise ValueError(f'Either the name or id of the {item_type} must be provided.')
         item_id = await self.get_item_id(item_type, item_name, collection_id=collection_id, collection_name=collection_name)
 
-    res = await self.get(f"/api/{item_type}/{item_id}", params=params)
-    if res:
+    if response_mode == 'raw':
+        res = await self.get(f"/api/{item_type}/{item_id}", 'raw', params=params)
         return res
     else:
-        raise ValueError(f'There is no {item_type} with the id "{item_id}"')
+        res = await self.get(f"/api/{item_type}/{item_id}", params=params)
+        if res:
+            return res
+        else:
+            raise ValueError(f'There is no {item_type} with the id "{item_id}"')
 
 
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="metabase-api",
-    version="3.5.1", 
+    version="3.5.2", 
     author="Vahid Vaezian",
     author_email="vahid.vaezian@gmail.com",
     description="A Python Wrapper for Metabase API",