msfabricpysdkcore 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

msfabricpysdkcore/__init__.py

@@ -1,2 +1,5 @@
 from .coreapi import FabricClientCore
-from .adminapi import FabricClientAdmin
+from .adminapi import FabricClientAdmin
+from .fabric_azure_client import FabricAzureClient
+
+__all__ = ["FabricClientCore", "FabricClientAdmin", "FabricAzureClient"]

msfabricpysdkcore/admin_item.py

@@ -74,7 +74,7 @@ class AdminItem:
             description = item_dict.get('description', None),
             last_updated_date = item_dict['lastUpdatedDate'],
             capacity_id = item_dict['capacityId'],
-            creator_principal = item_dict['creatorPrincipal'],
+            creator_principal = item_dict.get('creatorPrincipal', None),
             admin_client = admin_client
         )
             

msfabricpysdkcore/adminapi.py

@@ -2,6 +2,7 @@ import requests
 import json
 import os
 from time import sleep
+from warnings import warn
 
 from msfabricpysdkcore.client import FabricClient
 
@@ -10,12 +11,14 @@ class FabricClientAdmin(FabricClient):
 
     def __init__(self, tenant_id = None, client_id = None, client_secret = None) -> None:
         """Initialize FabricClientAdmin object"""
-        super().__init__(tenant_id, client_id, client_secret)
+        super().__init__(scope="https://api.fabric.microsoft.com/.default", 
+                         tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
+
 
     def long_running_operation(self, response_headers):
         """Check the status of a long running operation"""
         from msfabricpysdkcore.coreapi import FabricClientCore
-        fc = FabricClientCore(tenant_id=self.tenant_id, client_id=self.client_id, client_secret=self.client_secret, silent=True)
+        fc = FabricClientCore(tenant_id=self.tenant_id, client_id=self.client_id, client_secret=self.client_secret)
 
         return fc.long_running_operation(response_headers)
 
@@ -169,7 +172,7 @@ class FabricClientAdmin(FabricClient):
 
         if workspace_objects:
             from msfabricpysdkcore import FabricClientCore
-            fc = FabricClientCore(tenant_id=self.tenant_id, client_id=self.client_id, client_secret=self.client_secret, silent=True)
+            fc = FabricClientCore(tenant_id=self.tenant_id, client_id=self.client_id, client_secret=self.client_secret)
             workspaces = [fc.get_workspace_by_id(workspace["id"]) for workspace in workspaces]
 
         return workspaces
@@ -298,9 +301,13 @@ class FabricClientAdmin(FabricClient):
                                              return_format="json")
   
         if return_item == "Default":
-            print("""Warning: Updating a domain currently will make invoke an additional API call to get the domain object.
-                  This default behaviour will change in newer versions of the SDK.
-                  To keep this behaviour, set return_item=True in the function call.""")
+            warn(
+                message="Updating a domain currently will make invoke an additional API call to get the domain "
+                        "object. This default behaviour will change in newer versions of the SDK. To keep this "
+                        "behaviour, set return_item=True in the function call.",
+                category=FutureWarning,
+                stacklevel=2
+            )
         if return_item:
             return self.get_domain_by_id(domain_id)
         return response_json

msfabricpysdkcore/auth.py

@@ -1,6 +1,10 @@
+from warnings import warn
+
 import requests
 from abc import abstractmethod
 from azure.identity import AzureCliCredential
+from msfabricpysdkcore.util import logger
+import logging
 try:
     from notebookutils import mssparkutils
 except ImportError:
@@ -8,6 +12,13 @@ except ImportError:
 class FabricAuth():
     """FabricAuth class to interact with Entra ID"""
 
+    _logger: logging.Logger
+
+    def __init__(self, scope):
+        """Initialize FabricAuth object"""
+        self._logger = logger.getChild(__name__)
+        self.scope = scope
+
     @abstractmethod
     def get_token(self):
         """Get token from Azure AD"""
@@ -26,28 +37,33 @@ class FabricAuth():
 class FabricAuthClient(FabricAuth):
     """FabricAuthClient class to interact with Entra ID"""
 
-    def __init__(self, silent = False):
-        if not silent:
-            print("Using Azure CLI for authentication")
+    def __init__(self, scope, silent = None):
+        super().__init__(scope)
+        self._logger.info("Using Azure CLI for authentication")
         self.auth = AzureCliCredential()
 
+        if silent is not None:
+            warn("The 'silent' parameter is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
+
     def get_token(self):
         """Get token from Azure AD"""
-        token = self.auth.get_token("https://api.fabric.microsoft.com/.default")
+        token = self.auth.get_token(self.scope)
         return token.token
 
 class FabricServicePrincipal(FabricAuth):
     """FabricServicePrincipal class to interact with Entra ID"""
 
-    def __init__(self, tenant_id, client_id, client_secret, silent = False):
-        if not silent:
-            print("Using Service Principal for authentication")
+    def __init__(self, tenant_id, client_id, client_secret, scope, silent = None):
+        super().__init__(scope)
+
+        self._logger.info("Using Service Principal for authentication")
 
         self.tenant_id = tenant_id
         self.client_id = client_id
         self.client_secret = client_secret
 
-        self.scope = "https://api.fabric.microsoft.com/.default"
+        if silent is not None:
+            warn("The 'silent' parameter is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
 
     
     def get_token(self):
@@ -67,10 +83,14 @@ class FabricServicePrincipal(FabricAuth):
 class FabricSparkUtilsAuthentication(FabricAuth):
     """FabricSparkUtilsAuthentication class to interact with Entra ID"""
 
-    def __init__(self, silent = False):
+    def __init__(self, scope, silent=None):
+        # super().__init__(scope)
+
         mssparkutils.credentials.getToken("pbi")
-        if not silent:
-            print("Using Synapse Spark Utils for authentication")
+        self._logger.info("Using Synapse Spark Utils for authentication")
+
+        if silent is not None:
+            warn("The 'silent' parameter is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
 
     def get_token(self):
         """Get token from Azure AD"""

msfabricpysdkcore/client.py

@@ -1,34 +1,48 @@
+import logging
 from abc import abstractmethod
 import os
+from warnings import warn
 from time import sleep
 import requests
 import json
 
 from msfabricpysdkcore.auth import FabricAuthClient, FabricServicePrincipal, FabricSparkUtilsAuthentication
+from msfabricpysdkcore.util import logger
 
 class FabricClient():
     """FabricClient class to interact with Fabric API"""
 
-    def __init__(self, tenant_id = None, client_id = None, client_secret = None, silent=False) -> None:
+    _logger: logging.Logger
+
+    def __init__(self, scope, tenant_id = None, client_id = None, client_secret = None, silent=None) -> None:
         """Initialize FabricClient object"""
+
+        self._logger = logger.getChild(__name__)
+
         self.tenant_id = tenant_id if tenant_id else os.getenv("FABRIC_TENANT_ID")
         self.client_id = client_id if client_id else os.getenv("FABRIC_CLIENT_ID")
         self.client_secret = client_secret if client_secret else os.getenv("FABRIC_CLIENT_SECRET")
-
-        self.scope = "https://api.fabric.microsoft.com/.default"
+        self.scope = scope
+        #self.scope = "https://api.fabric.microsoft.com/.default"
 
         if self.client_id is None or self.client_secret is None or self.tenant_id is None:
             try:
-                self.auth = FabricSparkUtilsAuthentication(silent=silent)
+                self.auth = FabricSparkUtilsAuthentication(self.scope)
             except:
-                self.auth = FabricAuthClient(silent=silent)
+                self.auth = FabricAuthClient(self.scope)
         else:
-            self.auth = FabricServicePrincipal(tenant_id = self.tenant_id,
+            self.auth = FabricServicePrincipal(scope= self.scope,
+                                               tenant_id = self.tenant_id,
                                                client_id = self.client_id, 
-                                               client_secret = self.client_secret,
-                                               silent=silent)
-            
+                                               client_secret = self.client_secret)
+
+        if silent is not None:
+            warn("The 'silent' parameter is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
 
+            
+    def get_token(self):
+        """Get token from Entra"""
+        return self.auth.get_token()
 
     def calling_routine(self, url, operation, body = None, headers=None, file_path = None, response_codes = [200], error_message = "Error",
                         continue_on_error_code = False, return_format = "value_json", paging = False,
@@ -88,7 +102,7 @@ class FabricClient():
             else:
                 raise ValueError("Invalid operation")
             if response.status_code == 429:
-                print("Too many requests, waiting 10 seconds")
+                self._logger.info("Too many requests, waiting 10 seconds")
                 sleep(10)
                 continue
             elif response.status_code == 202:

msfabricpysdkcore/coreapi.py

@@ -1,14 +1,22 @@
 import json
 from time import sleep
+from warnings import warn
 
 from msfabricpysdkcore.client import FabricClient
+from msfabricpysdkcore.util import logger
+
 
 class FabricClientCore(FabricClient):
     """FabricClientCore class to interact with Fabric Core APIs"""
 
-    def __init__(self, tenant_id = None, client_id = None, client_secret = None, silent=False) -> None:
+    def __init__(self, tenant_id = None, client_id = None, client_secret = None, silent=None) -> None:
         """Initialize FabricClientCore object"""
-        super().__init__(tenant_id, client_id, client_secret, silent=silent)
+        super().__init__(scope="https://api.fabric.microsoft.com/.default", 
+                         tenant_id=tenant_id,
+                         client_id=client_id,
+                         client_secret=client_secret)
+        if silent is not None:
+            warn("The 'silent' parameter is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
 
     def long_running_operation(self, response_headers):
         """Check the status of a long running operation"""
@@ -107,7 +115,7 @@ class FabricClientCore(FabricClient):
         return DeploymentPipeline.from_dict(result_json, self)
     
     def get_deployment_pipeline_stages_items(self, pipeline_id, stage_id = None, stage_name = None):
-        print("DEPRECATED: Use list_deployment_pipeline_stages_items instead")
+        warn("DEPRECATED: get_deployment_pipeline_stages_items. get_deployment_pipeline_stages_items. Use list_deployment_pipeline_stages_items instead", DeprecationWarning, stacklevel=2)
         return self.list_deployment_pipeline_stages_items(pipeline_id, stage_id, stage_name)
 
     def list_deployment_pipeline_stages_items(self, deployment_pipeline_id, stage_id = None, stage_name = None):
@@ -136,7 +144,7 @@ class FabricClientCore(FabricClient):
                                      error_message="Error getting deployment pipeline stage items", return_format="value_json", paging=True)
 
         return items
-    
+
     def get_deployment_pipeline_stages(self, pipeline_id):
         """Get the stages of a deployment pipeline
         Args:
@@ -144,9 +152,9 @@ class FabricClientCore(FabricClient):
         Returns:
             list: List of DeploymentPipelineStage objects
         """
-        print("DEPRECATED: Use list_deployment_pipeline_stages instead")
+        warn("DEPRECATED: get_deployment_pipeline_stages. Use list_deployment_pipeline_stages instead", DeprecationWarning, stacklevel=2)
         return self.list_deployment_pipeline_stages(pipeline_id)
-    
+
     def list_deployment_pipeline_stages(self, deployment_pipeline_id):
         """Get the stages of a deployment pipeline
         Args:
@@ -525,7 +533,7 @@ class FabricClientCore(FabricClient):
 
 
         if item_dict is None or "no_operation_result" in item_dict:
-            print("Item not returned by API, trying to get it by name")
+            self._logger.debug("Item not returned by API, trying to get it by name")
             item = None
             i = 0
 
@@ -550,11 +558,11 @@ class FabricClientCore(FabricClient):
                 item = self.get_item_by_name(workspace_id, display_name, type)
                 if item is not None:
                     return item
-                print("Item not found, waiting 5 seconds")
+                self._logger.debug("Item not found, waiting 5 seconds")
                 sleep(5)
                 i += 1
 
-            print("Item not found after 1 minute, returning None")
+            self._logger.info("Item not found after 1 minute, returning None")
             return None
                 
         return self.get_item_specific(workspace_id, item_dict)
@@ -706,9 +714,13 @@ class FabricClientCore(FabricClient):
                                          response_codes=[200, 429], error_message="Error updating item",
                                          return_format="json")
         if return_item == "Default":
-            print("""Warning: Updating an item currently will make invoke an additional API call to get the item object.
-                  This default behaviour will change in newer versions of the SDK.
-                  To keep this behaviour, set return_item=True in the function call.""")
+            warn(
+                message="Updating an item currently will make invoke an additional API call to get the item object. "
+                        "The default behaviour of returning the item object will change in newer versions of the SDK. "
+                        "To keep this behaviour, set return_item=True in the function call.",
+                category=FutureWarning,
+                stacklevel=2
+            )
         if return_item:
             return self.get_item_specific(workspace_id, resp_dict)
         return resp_dict
@@ -2010,16 +2022,18 @@ class FabricClientCore(FabricClient):
         response = self.calling_routine(url, operation="POST", body=body, response_codes=[202, 429],
                                         error_message="Error loading table", return_format="response",
                                         wait_for_completion=False)
-        
+
         if wait_for_completion:
             success = self.check_if_table_is_created(workspace_id = workspace_id,
                                                      lakehouse_id = lakehouse_id,
                                                      table_name = table_name)
-            
+        else:
+            success = None
+
         if not success:
-            print("Warning: Table not created after 3 minutes")
+            self._logger.warning("Table not created after 3 minutes")
         else:
-            print("Table created")
+            self._logger.info("Table created")
         return response.status_code
 
     # mlExperiments
@@ -2558,9 +2572,13 @@ class FabricClientCore(FabricClient):
                                              error_message="Error updating workspace custom pool", return_format="json")
 
         if return_item == "Default":
-            print("""Warning: Updating an item currently will make invoke an additional API call to get the item object.
-                  This default behaviour will change in newer versions of the SDK.
-                  To keep this behaviour, set return_item=True in the function call.""")
+            warn(
+                message="Warning: Updating an item currently will make invoke an additional API call to get the item "
+                        "object. This default behaviour will change in newer versions of the SDK. To keep this "
+                        "behaviour, set return_item=True in the function call.",
+                category=FutureWarning,
+                stacklevel=2
+            )
         if return_item:
             return self.get_workspace_custom_pool(workspace_id, pool_id)
         return response_json

msfabricpysdkcore/deployment_pipeline.py

@@ -1,4 +1,5 @@
 import json
+from warnings import warn
 
 from msfabricpysdkcore.coreapi import FabricClientCore
 
@@ -46,7 +47,7 @@ class DeploymentPipeline:
 
 
     def get_stages(self):
-        print("DEPRECATED: Use list_stages() instead")
+        warn("DEPRECATED: Use list_stages() instead", DeprecationWarning, stacklevel=2)
         return self.list_stages(self)
     
     def list_stages(self):
@@ -54,13 +55,14 @@ class DeploymentPipeline:
 
 
     def get_deployment_pipeline_stages_items(self, stage_id = None, stage_name = None):
-        print("DEPRECATED: Use list_deployment_pipeline_stages_items() instead")
+        warn("DEPRECATED: get_deployment_pipeline_stages_items. Use list_deployment_pipeline_stages_items() instead", DeprecationWarning, stacklevel=2)
         return self.list_deployment_pipeline_stages_items(stage_id=stage_id, stage_name=stage_name)
 
 
     def list_deployment_pipeline_stages_items(self, stage_id = None, stage_name = None):
         return self.core_client.list_deployment_pipeline_stages_items(deployment_pipeline_id=self.id, stage_id=stage_id, stage_name=stage_name)
 
+
 class Deployment_Pipeline_Stage():
 
     """Class to represent a deployment pipeline stage in Microsoft Fabric"""
@@ -120,7 +122,7 @@ class Deployment_Pipeline_Stage():
         return self.__str__()
     
     def get_items(self):
-        print("DEPRECATED: Use list_items() instead")
+        warn("DEPRECATED: get_items. Use list_items() instead", DeprecationWarning, stacklevel=2)
         return self.list_items()
     
     def list_items(self):

msfabricpysdkcore/fabric_azure_capacity.py

@@ -0,0 +1,77 @@
+import json 
+
+from msfabricpysdkcore.fabric_azure_client import FabricAzureClient
+
+class FabricAzureCapacity:
+    """Class to represent a item in Microsoft Fabric"""
+
+    def __init__(self, id, name, subscription_id, resource_group_name, type, location, properties, sku, azure_client: FabricAzureClient, tags=None) -> None:
+        
+        self.id = id
+        self.name = name
+        self.subscription_id = subscription_id
+        self.resource_group_name = resource_group_name
+        self.type = type
+        self.location = location
+        self.properties = properties
+        self.sku = sku
+        self.tags = tags
+
+        self.azure_client = azure_client
+
+    def __str__(self) -> str:
+        """Return a string representation of the fabric azure capacity object"""
+        dict_ = {
+            'id': self.id,
+            'name': self.name,
+            'subscription_id': self.subscription_id,
+            'resource_group_name': self.resource_group_name,
+            'type': self.type,
+            'location': self.location,
+            'properties': self.properties,
+            'sku': self.sku,
+            'tags': self.tags
+        }
+        return json.dumps(dict_, indent=2)
+    
+    def __repr__(self) -> str:
+        return self.__str__()
+    
+    def from_dict(dict, azure_client):
+        """Create FabricAzureCapacity object from dictionary"""
+            
+        return FabricAzureCapacity(id=dict['id'], name=dict['name'], subscription_id=dict['subscription_id'],
+                                   resource_group_name=dict['resource_group_name'],
+                                   type=dict['type'],
+                                   location=dict['location'],
+                                   properties=dict['properties'], sku=dict['sku'],
+                                   tags=dict.get('tags', None), azure_client=azure_client)
+    
+    # Delete
+
+    def delete(self):
+        """Delete the capacity"""
+
+        return self.azure_client.delete_capacity(self.subscription_id, self.resource_group_name, self.name)
+    
+    # Resume
+
+    def resume(self):
+        """Resume the capacity"""
+
+        return self.azure_client.resume_capacity(self.subscription_id, self.resource_group_name, self.name)
+    
+    # Suspend
+
+    def suspend(self):
+        """Suspend the capacity"""
+
+        return self.azure_client.suspend_capacity(self.subscription_id, self.resource_group_name, self.name)
+    
+    # Update
+
+    def update(self, properties_administration=None, sku=None, tags=None):
+        """Update the capacity"""
+
+        return self.azure_client.update_capacity(self.subscription_id, self.resource_group_name, self.name, properties_administration=properties_administration, sku=sku, tags=tags)
+