semantic-link-labs 0.10.1__py3-none-any.whl → 0.11.1__py3-none-any.whl

sempy_labs/_gateways.py

@@ -47,6 +47,7 @@ def list_gateways() -> pd.DataFrame:
         request="/v1/gateways", client="fabric_sp", uses_pagination=True
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("value", []):
             new_data = {
@@ -62,13 +63,16 @@ def list_gateways() -> pd.DataFrame:
                 "Allow Custom Connectors": v.get("allowCustomConnectors"),
             }
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
 
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
+@log
 def _resolve_gateway_id(gateway: str | UUID) -> UUID:
 
     dfG = list_gateways()
@@ -83,6 +87,7 @@ def _resolve_gateway_id(gateway: str | UUID) -> UUID:
     return dfG_filt["Gateway Id"].iloc[0]
 
 
+@log
 def delete_gateway(gateway: str | UUID):
     """
     Deletes a gateway.
@@ -102,6 +107,7 @@ def delete_gateway(gateway: str | UUID):
     print(f"{icons.green_dot} The '{gateway}' gateway has been deleted.")
 
 
+@log
 def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
     """
     Returns a list of gateway role assignments.
@@ -135,6 +141,7 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
         uses_pagination=True,
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("value", []):
             new_data = {
@@ -144,11 +151,15 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
                 "Role": v.get("role"),
             }
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     return df
 
 
+@log
 def delete_gateway_role_assignment(gateway: str | UUID, role_assignment_id: UUID):
     """
     Delete the specified role assignment for the gateway.
@@ -177,6 +188,7 @@ def delete_gateway_role_assignment(gateway: str | UUID, role_assignment_id: UUID
     )
 
 
+@log
 def _resolve_gateway_member_id(gateway: str | UUID, gateway_member: str | UUID) -> UUID:
 
     gateway_id = _resolve_gateway_id(gateway)
@@ -194,6 +206,7 @@ def _resolve_gateway_member_id(gateway: str | UUID, gateway_member: str | UUID)
     return dfM_filt["Member Id"].iloc[0]
 
 
+@log
 def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
     """
     Delete gateway member of an on-premises gateway.
@@ -225,6 +238,7 @@ def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
     )
 
 
+@log
 def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
     """
     Lists gateway members of an on-premises gateway.
@@ -260,6 +274,7 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
         request=f"/v1/gateways/{gateway_id}/members", client="fabric_sp"
     )
 
+    dfs = []
     for v in response.json().get("value", []):
         new_data = {
             "Member Id": v.get("id"),
@@ -270,13 +285,16 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
             "Enabled": v.get("enabled"),
         }
 
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+        dfs.append(pd.DataFrame(new_data, index=[0]))
 
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
+@log
 def create_vnet_gateway(
     name: str,
     capacity: str | UUID,
@@ -342,6 +360,7 @@ def create_vnet_gateway(
     )
 
 
+@log
 def update_on_premises_gateway(
     gateway: str | UUID,
     allow_cloud_connection_refresh: Optional[bool] = None,
@@ -395,6 +414,7 @@ def update_on_premises_gateway(
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
 
+@log
 def update_vnet_gateway(
     gateway: str | UUID,
     capacity: str | UUID,
@@ -448,6 +468,7 @@ def update_vnet_gateway(
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
 
+@log
 def bind_semantic_model_to_gateway(
     dataset: str | UUID, gateway: str | UUID, workspace: Optional[str | UUID] = None
 ):

sempy_labs/_git.py

@@ -7,8 +7,10 @@ from sempy_labs._helper_functions import (
     _create_dataframe,
 )
 from uuid import UUID
+from sempy._utils._log import log
 
 
+@log
 def connect_workspace_to_azure_dev_ops(
     organization_name: str,
     project_name: str,
@@ -64,6 +66,7 @@ def connect_workspace_to_azure_dev_ops(
     )
 
 
+@log
 def connect_workspace_to_github(
     owner_name: str,
     repository_name: str,
@@ -125,6 +128,7 @@ def connect_workspace_to_github(
     )
 
 
+@log
 def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
     """
     Disconnects a workspace from a git repository.
@@ -148,6 +152,7 @@ def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
     )
 
 
+@log
 def get_git_status(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Obtains the Git status of items in the workspace, that can be committed to Git.
@@ -209,6 +214,7 @@ def get_git_status(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
+@log
 def get_git_connection(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Obtains the Git status of items in the workspace, that can be committed to Git.
@@ -265,6 +271,7 @@ def get_git_connection(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
+@log
 def initialize_git_connection(workspace: Optional[str | UUID] = None) -> str:
     """
     Initializes a connection for a workspace that is connected to Git.
@@ -300,6 +307,7 @@ def initialize_git_connection(workspace: Optional[str | UUID] = None) -> str:
     return response_json.get("remoteCommitHash")
 
 
+@log
 def commit_to_git(
     comment: str,
     item_ids: UUID | List[UUID] = None,
@@ -368,6 +376,7 @@ def commit_to_git(
         )
 
 
+@log
 def update_from_git(
     remote_commit_hash: str,
     conflict_resolution_policy: str,
@@ -435,6 +444,7 @@ def update_from_git(
     )
 
 
+@log
 def get_my_git_credentials(
     workspace: Optional[str | UUID] = None,
 ) -> pd.DataFrame:
@@ -476,6 +486,7 @@ def get_my_git_credentials(
     return df
 
 
+@log
 def update_my_git_credentials(
     source: str,
     connection_id: Optional[UUID] = None,

sempy_labs/_graphQL.py

@@ -4,11 +4,13 @@ from typing import Optional
 from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
-    resolve_workspace_name_and_id,
+    resolve_workspace_id,
     create_item,
 )
+from sempy._utils._log import log
 
 
+@log
 def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
     """
     Shows the Graph QL APIs within a workspace.
@@ -37,7 +39,7 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
     }
     df = _create_dataframe(columns=columns)
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
 
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/GraphQLApis",
@@ -45,6 +47,7 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
         client="fabric_sp",
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("value", []):
             new_data = {
@@ -52,11 +55,15 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
                 "GraphQL API Id": v.get("id"),
                 "Description": v.get("description"),
             }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     return df
 
 
+@log
 def create_graphql_api(
     name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
 ):

sempy_labs/_helper_functions.py

@@ -19,6 +19,7 @@ import requests
 import sempy_labs._authentication as auth
 from jsonpath_ng.ext import parse
 from jsonpath_ng.jsonpath import Fields, Index
+from sempy._utils._log import log
 
 
 def _build_url(url: str, params: dict) -> str:
@@ -37,6 +38,7 @@ def _encode_user(user: str) -> str:
     return urllib.parse.quote(user, safe="@")
 
 
+@log
 def create_abfss_path(
     lakehouse_id: UUID,
     lakehouse_workspace_id: UUID,
@@ -76,6 +78,7 @@ def create_abfss_path(
     return path
 
 
+@log
 def create_abfss_path_from_path(
     lakehouse_id: UUID, workspace_id: UUID, file_path: str
 ) -> str:
@@ -103,6 +106,7 @@ def _split_abfss_path(path: str) -> Tuple[UUID, UUID, str]:
     return workspace_id, item_id, delta_table_name
 
 
+@log
 def format_dax_object_name(table: str, column: str) -> str:
     """
     Formats a table/column combination to the 'Table Name'[Column Name] format.
@@ -123,6 +127,7 @@ def format_dax_object_name(table: str, column: str) -> str:
     return "'" + table + "'[" + column + "]"
 
 
+@log
 def create_relationship_name(
     from_table: str, from_column: str, to_table: str, to_column: str
 ) -> str:
@@ -153,6 +158,7 @@ def create_relationship_name(
     )
 
 
+@log
 def resolve_report_id(
     report: str | UUID, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -177,6 +183,7 @@ def resolve_report_id(
     return resolve_item_id(item=report, type="Report", workspace=workspace)
 
 
+@log
 def resolve_report_name(report_id: UUID, workspace: Optional[str | UUID] = None) -> str:
     """
     Obtains the name of the Power BI report.
@@ -199,6 +206,7 @@ def resolve_report_name(report_id: UUID, workspace: Optional[str | UUID] = None)
     return resolve_item_name(item_id=report_id, workspace=workspace)
 
 
+@log
 def delete_item(
     item: str | UUID, type: str, workspace: Optional[str | UUID] = None
 ) -> None:
@@ -230,6 +238,7 @@ def delete_item(
     )
 
 
+@log
 def create_item(
     name: str,
     type: str,
@@ -281,6 +290,7 @@ def create_item(
     )
 
 
+@log
 def get_item_definition(
     item: str | UUID,
     type: str,
@@ -319,6 +329,7 @@ def get_item_definition(
         return value
 
 
+@log
 def resolve_lakehouse_name_and_id(
     lakehouse: Optional[str | UUID] = None, workspace: Optional[str | UUID] = None
 ) -> Tuple[str, UUID]:
@@ -344,6 +355,7 @@ def resolve_lakehouse_name_and_id(
     return lakehouse_name, lakehouse_id
 
 
+@log
 def resolve_dataset_name_and_id(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> Tuple[str, UUID]:
@@ -355,6 +367,7 @@ def resolve_dataset_name_and_id(
     return dataset_name, dataset_id
 
 
+@log
 def resolve_dataset_id(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -379,6 +392,7 @@ def resolve_dataset_id(
     return resolve_item_id(item=dataset, type="SemanticModel", workspace=workspace)
 
 
+@log
 def resolve_dataset_name(
     dataset_id: UUID, workspace: Optional[str | UUID] = None
 ) -> str:
@@ -403,6 +417,7 @@ def resolve_dataset_name(
     return resolve_item_name(item_id=dataset_id, workspace=workspace)
 
 
+@log
 def resolve_lakehouse_name(
     lakehouse_id: Optional[UUID] = None, workspace: Optional[str | UUID] = None
 ) -> str:
@@ -435,6 +450,7 @@ def resolve_lakehouse_name(
     return resolve_item_name(item_id=lakehouse_id, workspace=workspace)
 
 
+@log
 def resolve_lakehouse_id(
     lakehouse: Optional[str | UUID] = None, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -470,6 +486,7 @@ def resolve_lakehouse_id(
     return lakehouse_id
 
 
+@log
 def get_direct_lake_sql_endpoint(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -517,6 +534,7 @@ def get_direct_lake_sql_endpoint(
         return sqlEndpointId
 
 
+@log
 def generate_embedded_filter(filter: str) -> str:
     """
     Converts the filter expression to a filter expression which can be used by a Power BI embedded URL.
@@ -582,6 +600,7 @@ def generate_embedded_filter(filter: str) -> str:
     return revised_filter
 
 
+@log
 def save_as_delta_table(
     dataframe,
     delta_table_name: str,
@@ -735,6 +754,7 @@ def save_as_delta_table(
     )
 
 
+@log
 def language_validate(language: str):
     """
     Validateds that the language specified exists within the supported langauges.
@@ -771,6 +791,7 @@ def language_validate(language: str):
     return lang
 
 
+@log
 def resolve_workspace_id(
     workspace: Optional[str | UUID] = None,
 ) -> UUID:
@@ -803,6 +824,7 @@ def resolve_workspace_id(
     return workspace_id
 
 
+@log
 def resolve_workspace_name(workspace_id: Optional[UUID] = None) -> str:
 
     if workspace_id is None:
@@ -820,6 +842,7 @@ def resolve_workspace_name(workspace_id: Optional[UUID] = None) -> str:
     return response.get("displayName")
 
 
+@log
 def resolve_workspace_name_and_id(
     workspace: Optional[str | UUID] = None,
 ) -> Tuple[str, str]:
@@ -865,6 +888,7 @@ def resolve_workspace_name_and_id(
     return workspace_name, workspace_id
 
 
+@log
 def resolve_item_id(
     item: str | UUID, type: Optional[str] = None, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -909,6 +933,7 @@ def resolve_item_id(
     return item_id
 
 
+@log
 def resolve_item_name_and_id(
     item: str | UUID, type: Optional[str] = None, workspace: Optional[str | UUID] = None
 ) -> Tuple[str, UUID]:
@@ -926,6 +951,7 @@ def resolve_item_name_and_id(
     return item_name, item_id
 
 
+@log
 def resolve_item_name(item_id: UUID, workspace: Optional[str | UUID] = None) -> str:
 
     workspace_id = resolve_workspace_id(workspace)
@@ -946,6 +972,7 @@ def resolve_item_name(item_id: UUID, workspace: Optional[str | UUID] = None) ->
     return item_name
 
 
+@log
 def _extract_json(dataframe: pd.DataFrame) -> dict:
 
     payload = dataframe["payload"].iloc[0]
@@ -954,19 +981,21 @@ def _extract_json(dataframe: pd.DataFrame) -> dict:
     return json.loads(json_file)
 
 
-def _conv_b64(file):
+@log
+def _conv_b64(file, json_dumps: bool = True):
 
-    loadJson = json.dumps(file)
-    f = base64.b64encode(loadJson.encode("utf-8")).decode("utf-8")
-
-    return f
+    if json_dumps:
+        file = json.dumps(file)
+    return base64.b64encode(file.encode("utf-8")).decode("utf-8")
 
 
+@log
 def _decode_b64(file, format: Optional[str] = "utf-8"):
 
     return base64.b64decode(file).decode(format)
 
 
+@log
 def is_default_semantic_model(
     dataset: str, workspace: Optional[str | UUID] = None
 ) -> bool:
@@ -1000,6 +1029,7 @@ def is_default_semantic_model(
     return dataset in default_semantic_models
 
 
+@log
 def resolve_item_type(item_id: UUID, workspace: Optional[str | UUID] = None) -> str:
     """
     Obtains the item type for a given Fabric Item Id within a Fabric workspace.
@@ -1030,6 +1060,7 @@ def resolve_item_type(item_id: UUID, workspace: Optional[str | UUID] = None) ->
     return dfI_filt["Type"].iloc[0]
 
 
+@log
 def resolve_dataset_from_report(
     report: str | UUID, workspace: Optional[str | UUID] = None
 ) -> Tuple[UUID, str, UUID, str]:
@@ -1071,6 +1102,7 @@ def _add_part(target_dict, path, payload):
     target_dict["definition"]["parts"].append(part)
 
 
+@log
 def resolve_workspace_capacity(
     workspace: Optional[str | UUID] = None,
 ) -> Tuple[UUID, str]:
@@ -1105,6 +1137,7 @@ def resolve_workspace_capacity(
     return capacity_id, capacity_name
 
 
+@log
 def get_capacity_id(workspace: Optional[str | UUID] = None) -> UUID:
     """
     Obtains the Capacity Id for a given workspace.
@@ -1136,6 +1169,7 @@ def get_capacity_id(workspace: Optional[str | UUID] = None) -> UUID:
     return capacity_id
 
 
+@log
 def get_capacity_name(workspace: Optional[str | UUID] = None) -> str:
     """
     Obtains the capacity name for a given workspace.
@@ -1166,6 +1200,7 @@ def get_capacity_name(workspace: Optional[str | UUID] = None) -> str:
     return dfC_filt["Display Name"].iloc[0]
 
 
+@log
 def resolve_capacity_name(capacity_id: Optional[UUID] = None) -> str:
     """
     Obtains the capacity name for a given capacity Id.
@@ -1198,6 +1233,7 @@ def resolve_capacity_name(capacity_id: Optional[UUID] = None) -> str:
     return dfC_filt["Display Name"].iloc[0]
 
 
+@log
 def resolve_capacity_id(capacity: Optional[str | UUID] = None, **kwargs) -> UUID:
     """
     Obtains the capacity Id for a given capacity name.
@@ -1381,6 +1417,7 @@ def _get_blob_client(workspace_id: UUID, item_id: UUID):
     return BlobServiceClient(url, credential=FabricTokenCredential())
 
 
+@log
 def resolve_warehouse_id(
     warehouse: str | UUID, workspace: Optional[str | UUID]
 ) -> UUID:
@@ -1461,6 +1498,7 @@ def convert_to_alphanumeric_lowercase(input_string):
     return cleaned_string
 
 
+@log
 def resolve_environment_id(
     environment: str | UUID, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -1490,6 +1528,7 @@ def _make_clickable(val):
     return f'<a target="_blank" href="{val}">{val}</a>'
 
 
+@log
 def convert_to_friendly_case(text: str) -> str:
     """
     Converts a string of pascal/camel/snake case to business-friendly case.
@@ -1514,6 +1553,7 @@ def convert_to_friendly_case(text: str) -> str:
     return text
 
 
+@log
 def resolve_notebook_id(
     notebook: str | UUID, workspace: Optional[str | UUID] = None
 ) -> UUID:
@@ -1543,6 +1583,7 @@ def generate_guid():
     return str(uuid.uuid4())
 
 
+@log
 def _get_column_aggregate(
     table_name: str,
     column_name: str | List[str] = "RunId",
@@ -1643,6 +1684,14 @@ def _get_column_aggregate(
     return result
 
 
+def _validate_weight(weight: float):
+
+    if weight is not None and (weight <= 0 or weight >= 1):
+        raise ValueError(
+            f"{icons.red_dot} Invalid weight parameter. Weight must be a value between 0 and 1."
+        )
+
+
 def _create_spark_dataframe(df: pd.DataFrame):
 
     spark = _create_spark_session()
@@ -1858,7 +1907,7 @@ def _get_fabric_context_setting(name: str):
 
 def get_tenant_id():
 
-    _get_fabric_context_setting(name="trident.tenant.id")
+    return _get_fabric_context_setting(name="trident.tenant.id")
 
 
 def _base_api(
@@ -2082,7 +2131,9 @@ def _run_spark_sql_query(query):
 
 
 def _mount(
-    lakehouse: Optional[str | UUID] = None, workspace: Optional[str | UUID] = None
+    lakehouse: Optional[str | UUID] = None,
+    workspace: Optional[str | UUID] = None,
+    verbose: bool = False,
 ) -> str:
     """
     Mounts a lakehouse to a notebook if it is not already mounted. Returns the local path to the lakehouse.
@@ -2111,9 +2162,10 @@ def _mount(
     if not any(i.get("source") == lake_path for i in mounts):
         # Mount lakehouse if not mounted
         notebookutils.fs.mount(lake_path, mount_point)
-        print(
-            f"{icons.green_dot} Mounted the '{lakehouse_name}' lakehouse within the '{workspace_name}' to the notebook."
-        )
+        if verbose:
+            print(
+                f"{icons.green_dot} Mounted the '{lakehouse_name}' lakehouse within the '{workspace_name}' to the notebook."
+            )
 
     mounts = notebookutils.fs.mounts()