msfabricpysdkcore 0.0.4__tar.gz → 0.0.5__tar.gz

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.4
+Version: 0.0.5
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/coreapi.py

@@ -203,10 +203,10 @@ class FabricClientCore(FabricClient):
         ws = self.get_workspace_by_id(workspace_id)
         return ws.delete_item(item_id)
 
-    def list_items(self, workspace_id):
+    def list_items(self, workspace_id, with_properties = False):
         """List items in a workspace"""
         ws = self.get_workspace_by_id(workspace_id)
-        return ws.list_items()
+        return ws.list_items(with_properties=with_properties)
     
     def get_item_definition(self, workspace_id, item_id):
         """Get the definition of an item"""

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/item.py

@@ -80,7 +80,9 @@ class Item:
                 sleep(10)
                 continue
             if response.status_code == 202:
-                check_long_running_operation( response.headers, self.auth)
+                operation_result = check_long_running_operation( response.headers, self.auth)
+                self.definition = operation_result['definition']
+                return operation_result
                 
             if response.status_code not in (200, 202, 429):
                 print(response.status_code)
@@ -88,9 +90,9 @@ class Item:
                 raise Exception(f"Error getting item definition: {response.text}")
             break
         
-        print(response.text)
-        print(response.status_code)
-        return json.loads(response.text)
+        resp_dict = json.loads(response.text)
+        self.definition = resp_dict['definition']
+        return resp_dict
     
     def update(self, display_name = None, description = None):
         """Update the item"""

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/job_instance.py

@@ -1,7 +1,6 @@
 import json 
 import requests
 from time import sleep
-from msfabricpysdkcore.long_running_operation import check_long_running_operation
 
 class JobInstance:
     """Class to represent a job instance in Microsoft Fabric"""

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/lakehouse.py

@@ -2,7 +2,6 @@ import json
 import requests
 from time import sleep
 
-from msfabricpysdkcore.long_running_operation import check_long_running_operation
 from msfabricpysdkcore.item import Item
 
 class Lakehouse(Item):

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/long_running_operation.py

@@ -22,13 +22,14 @@ class LongRunningOperation:
                 print("Too many requests, waiting 10 seconds")
                 sleep(10)
                 continue
+            if response.status_code == 400:
+                return None
             if response.status_code not in (200, 429):
                 print(response.status_code)
                 print(response.text)
                 raise Exception(f"Error getting operation results: {response.text}")
             break
 
-        print(json.loads(response.text))
         return json.loads(response.text)
     
     def get_operation_state(self):
@@ -47,7 +48,6 @@ class LongRunningOperation:
                 raise Exception(f"Error getting operation state: {response.text}")
             break
 
-        print(json.loads(response.text))
         return json.loads(response.text)    
     
     def wait_for_completion(self):
@@ -72,10 +72,7 @@ def check_long_running_operation(headers, auth):
     if not operation_id:
         print("Operation initiated, no operation id found")
         return None
-    else:
-        print("Operation initiated, waiting for completion")
-        lro = LongRunningOperation(operation_id=operation_id, auth=auth)
-        lro.wait_for_completion()
-        print("Operation completed")
-    lro = LongRunningOperation(operation_id, auth)
-    return lro.wait_for_completion()
+    lro = LongRunningOperation(operation_id=operation_id, auth=auth)
+    lro.wait_for_completion()
+    
+    return lro.get_operation_results()

msfabricpysdkcore-0.0.5/msfabricpysdkcore/otheritems.py

@@ -0,0 +1,17 @@
+from time import sleep
+
+from msfabricpysdkcore.item import Item
+
+class SparkJobDefinition(Item):
+    """Class to represent a spark job definition in Microsoft Fabric"""
+     
+    def __init__(self, id, display_name, type, workspace_id, auth, properties = None, definition=None, description=""):
+        super().__init__(id, display_name, type, workspace_id, auth, properties, definition, description)
+
+class Warehouse(Item):
+    """Class to represent a warehouse in Microsoft Fabric"""
+     
+    def __init__(self, id, display_name, type, workspace_id, auth, properties = None, definition=None, description=""):
+        super().__init__(id, display_name, type, workspace_id, auth, properties, definition, description)
+
+

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/tests/test_items_incl_lakehouse.py

@@ -47,9 +47,43 @@ class TestFabricClientCore(unittest.TestCase):
 
         self.assertAlmostEqual(status_code, 200)
 
+    def test_item_definition(self):
+
+        sjd = self.fc.get_item(workspace_id=self.workspace_id, item_name="blubb", item_type="SparkJobDefinition")
+        self.assertIsNotNone(sjd.definition)
+        datetime_str = datetime.now().strftime("%Y%m%d%H%M%S")
+        blubb2 = "blubb2" + datetime_str
+        blubb3 = "blubb3" + datetime_str
+        blubb2 = self.fc.create_item(display_name=blubb2, type="SparkJobDefinition", workspace_id=self.workspace_id,
+                                   definition=sjd.definition)
+
+        blubb3 =  self.fc.create_item(display_name=blubb3, type="SparkJobDefinition", workspace_id=self.workspace_id)
+
+        blubb3 = self.fc.update_item_definition(workspace_id=self.workspace_id,
+                                                item_id=blubb3.id, definition=sjd.definition)
+        
+        self.assertEqual(blubb3.definition, sjd.definition)
+        
+        self.assertNotEqual(blubb2.id, sjd.id)
+        self.assertEqual(blubb2.definition, sjd.definition)
+        self.assertNotEqual(blubb2.id, blubb3.id)
+        
+        blubb2.delete()
+        blubb3.delete()
+
+    def test_warehouse(self):
+        warehouse = self.fc.get_item(workspace_id=self.workspace_id, item_name="testitem20240404134030", item_type="Warehouse")
+        self.assertIsNotNone(warehouse.properties)
+
+    def test_spark_job_definition(self):
+        spark_job_definition = self.fc.get_item(workspace_id=self.workspace_id,
+                                                 item_name="blubb", item_type="SparkJobDefinition")
+        self.assertIsNotNone(spark_job_definition.properties)
+
     def test_lakehouse(self):
 
         lakehouse = self.fc.get_item(workspace_id=self.workspace_id, item_name="lakehouse1", item_type="Lakehouse")
+        self.assertIsNotNone(lakehouse.properties)
         item_id = lakehouse.id
         date_str = datetime.now().strftime("%Y%m%d%H%M%S")
         table_name = f"table{date_str}"

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore/workspace.py

@@ -2,7 +2,10 @@ import json
 import requests
 from time import sleep
 from msfabricpysdkcore.item import Item
+from msfabricpysdkcore.lakehouse import Lakehouse
 from msfabricpysdkcore.long_running_operation import check_long_running_operation
+from msfabricpysdkcore.otheritems import SparkJobDefinition
+from msfabricpysdkcore.otheritems import Warehouse
 
 class Workspace:
     """Class to represent a workspace in Microsoft Fabric"""
@@ -247,26 +250,29 @@ class Workspace:
         item_dict = json.loads(response.text)
         if item_dict is None:
             print("Item not returned by API, trying to get it by name")
-            return self.get_item_by_name(display_name, type)        
-        return Item.from_dict(item_dict, auth=self.auth)
+            return self.get_item_by_name(display_name, type)    
+
+        if item_dict["type"] == "Lakehouse":
+            return self.get_lakehouse(item_dict["id"])
+        if item_dict["type"] == "Warehouse":
+            return self.get_warehouse(item_dict["id"])
+        if item_dict["type"] == "SparkJobDefinition":
+            return self.get_spark_job_definition(item_dict["id"])
         
+        item_obj = Item.from_dict(item_dict, auth=self.auth)
+        if item_obj.type in ["Notebook", "Report", "SemanticModel"]:
+            item_obj.get_definition()
+        return item_obj
 
     def get_item_by_name(self, item_name, item_type):
         """Get an item from a workspace by name"""
-        ws_items = self.list_items()
+        ws_items = self.list_items(with_properties=False)
         for item in ws_items:
             if item.display_name == item_name and item.type == item_type:
-                return item    
+                return self.get_item(item.id, item_type)    
 
-    def get_item(self, item_id = None, item_name = None, item_type = None):
-        # GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
-        """Get an item from a workspace"""
-        if item_id is None and item_name is not None and item_type is not None:
-            return self.get_item_by_name(item_name, item_type)
-        elif item_id is None:
-            raise Exception("item_id or the combination item_name + item_type is required")
-        
-        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items/{item_id}"
+
+    def get_item_internal(self, url):
 
         for _ in range(10):
             response = requests.get(url=url, headers=self.auth.get_headers())
@@ -281,14 +287,103 @@ class Workspace:
             break
         
         item_dict = json.loads(response.text)
-        return Item.from_dict(item_dict, auth=self.auth)
+        return item_dict
+
+    def get_lakehouse(self, lakehouse_id = None, lakehouse_name = None):
+        """Get a lakehouse from a workspace"""
+
+        if lakehouse_id is None and lakehouse_name is not None:
+            return self.get_item_by_name(lakehouse_name, "Lakehouse")
+        elif lakehouse_id is None:
+            raise Exception("lakehouse_id or the lakehouse_name is required")
+        
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/lakehouses/{lakehouse_id}"
+
+        item_dict = self.get_item_internal(url)
+        return Lakehouse.from_dict(item_dict, auth=self.auth)
+    
+    def get_warehouse(self, warehouse_id = None, warehouse_name = None):
+        """Get a warehouse from a workspace"""
+        if warehouse_id is None and warehouse_name is not None:
+            return self.get_item_by_name(warehouse_name, "Warehouse")
+        elif warehouse_id is None:
+            raise Exception("warehouse_id or the warehouse_name is required")
+        
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/warehouses/{warehouse_id}"
+
+        item_dict = self.get_item_internal(url)
+        return Warehouse.from_dict(item_dict, auth=self.auth)
+
+    def get_spark_job_definition(self, spark_job_definition_id = None, spark_job_definition_name = None):
+        """Get a spark job definition from a workspace"""
+        if spark_job_definition_id is None and spark_job_definition_name is not None:
+            return self.get_item_by_name(spark_job_definition_name, "SparkJobDefinition")
+        elif spark_job_definition_id is None:
+            raise Exception("spark_job_definition_id or the spark_job_definition_name is required")
+        
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/sparkjobdefinitions/{spark_job_definition_id}"
+
+        item_dict = self.get_item_internal(url)
+        sjd_obj =  SparkJobDefinition.from_dict(item_dict, auth=self.auth)
+        sjd_obj.get_definition()
+        return sjd_obj
+
+    def get_item(self, item_id = None, item_name = None, item_type = None):
+        # GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
+        """Get an item from a workspace"""
+        if item_type:
+            if item_type.lower() == "lakehouse":
+                return self.get_lakehouse(item_id, item_name)
+            if item_type.lower() == "warehouse":
+                return self.get_warehouse(item_id, item_name)
+            if item_type.lower() == "sparkjobdefinition":
+                return self.get_spark_job_definition(item_id, item_name)
+                
+        if item_id is None and item_name is not None and item_type is not None:
+            return self.get_item_by_name(item_name, item_type)
+        elif item_id is None:
+            raise Exception("item_id or the combination item_name + item_type is required")
+        
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items/{item_id}"
+
+        item_dict = self.get_item_internal(url)
+        if item_dict["type"] == "Lakehouse":
+            return self.get_lakehouse(item_dict["id"])
+        if item_dict["type"] == "Warehouse":
+            return self.get_warehouse(item_dict["id"])
+        if item_dict["type"] == "SparkJobDefinition":
+            return self.get_spark_job_definition(item_dict["id"])
+        
+
+        item_obj = Item.from_dict(item_dict, auth=self.auth)
+        if item_obj.type in ["Notebook", "Report", "SemanticModel"]:
+            item_obj.get_definition()
+        return item_obj
+
 
     def delete_item(self, item_id):
         """Delete an item from a workspace"""
         return self.get_item(item_id).delete()
   
 
-    def list_items(self, continuationToken = None):
+    def get_item_object_w_properties(self, item_list):
+
+        new_item_list = []
+        for item in item_list:
+            if item["type"] == "Lakehouse":
+                item = self.get_lakehouse(item["id"])
+            elif item["type"] == "Warehouse":
+                item = self.get_warehouse(item["id"])
+            elif item["type"] == "SparkJobDefinition":
+                item = self.get_spark_job_definition(item["id"])
+            else:
+                item = Item.from_dict(item, auth=self.auth)
+                if item.type in ["Notebook", "Report", "SemanticModel"]:
+                    item.get_definition()
+            new_item_list.append(item)
+        return new_item_list
+
+    def list_items(self, with_properties = False, continuationToken = None):
         """List items in a workspace"""
         url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items"
 
@@ -309,10 +404,14 @@ class Workspace:
         
         resp_dict = json.loads(response.text)
         items = resp_dict["value"]
-        items = [Item.from_dict(item, auth=self.auth) for item in items]
+        if with_properties:
+            items = self.get_item_object_w_properties(items)
+        else:
+            items = [Item.from_dict(item, auth=self.auth) for item in items]
 
         if "continuationToken" in resp_dict:
-            item_list_next = self.list_items(continuationToken=resp_dict["continuationToken"])
+            item_list_next = self.list_items(with_properties=with_properties, 
+                                             continuationToken=resp_dict["continuationToken"])
             items.extend(item_list_next)
 
         return items

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.4
+Version: 0.0.5
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/msfabricpysdkcore.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ msfabricpysdkcore/job_instance.py
 msfabricpysdkcore/lakehouse.py
 msfabricpysdkcore/long_running_operation.py
 msfabricpysdkcore/onelakeshortcut.py
+msfabricpysdkcore/otheritems.py
 msfabricpysdkcore/workspace.py
 msfabricpysdkcore.egg-info/PKG-INFO
 msfabricpysdkcore.egg-info/SOURCES.txt

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "msfabricpysdkcore"
-version = "0.0.4"
+version = "0.0.5"
 dynamic = ["dependencies"]
 authors = [
   { name="Andreas Rederer"},

{msfabricpysdkcore-0.0.4 → msfabricpysdkcore-0.0.5}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='msfabricpysdkcore',
-    version='0.4',
+    version='0.5',
     packages=find_packages(),
     install_requires=[
         'requests>=2.30.0',