semantic-link-labs 0.9.1__py3-none-any.whl → 0.9.3__py3-none-any.whl

sempy_labs/_git.py

@@ -1,12 +1,10 @@
-import sempy.fabric as fabric
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional, List
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
+    _base_api,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -43,7 +41,7 @@ def connect_workspace_to_azure_dev_ops(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {
+    payload = {
         "gitProviderDetails": {
             "organizationName": organization_name,
             "projectName": project_name,
@@ -54,12 +52,11 @@ def connect_workspace_to_azure_dev_ops(
         }
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/connect", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/connect",
+        payload=payload,
+        method="post",
     )
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been connected to the '{project_name}' Git project in Azure DevOps within the '{repository_name}' repository."
@@ -102,7 +99,7 @@ def connect_workspace_to_github(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {
+    payload = {
         "gitProviderDetails": {
             "ownerName": owner_name,
             "gitProviderType": "GitHub",
@@ -116,12 +113,11 @@ def connect_workspace_to_github(
         },
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/connect", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/connect",
+        payload=payload,
+        method="post",
     )
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been connected to the '{repository_name}' GitHub repository."
@@ -144,10 +140,7 @@ def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.post(f"/v1/workspaces/{workspace_id}/git/disconnect")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    _base_api(request=f"/v1/workspaces/{workspace_id}/git/disconnect", method="post")
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been disconnected from Git."
@@ -189,13 +182,11 @@ def get_git_status(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         ]
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/git/status")
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    result = lro(client, response).json()
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/status",
+        lro_return_json=True,
+        status_codes=None,
+    )
 
     for changes in result.get("changes", []):
         item_metadata = changes.get("itemMetadata", {})
@@ -252,11 +243,7 @@ def get_git_connection(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         ]
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/git/connection")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    response = _base_api(request=f"/v1/workspaces/{workspace_id}/git/connection")
 
     r = response.json()
     provider_details = r.get("gitProviderDetails", {})
@@ -298,19 +285,18 @@ def initialize_git_connection(workspace: Optional[str | UUID] = None) -> str:
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.post(f"/v1/workspaces/{workspace_id}/git/initializeConnection")
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    lro(client, response)
+    response_json = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/initializeConnection",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
+    )
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace git connection has been initialized."
     )
 
-    return response.json().get("remoteCommitHash")
+    return response_json.get("remoteCommitHash")
 
 
 def commit_to_git(
@@ -350,26 +336,23 @@ def commit_to_git(
         if isinstance(item_ids, str):
             item_ids = [item_ids]
 
-        request_body = {
+        payload = {
             "mode": commit_mode,
             "workspaceHead": workspace_head,
             "comment": comment,
         }
 
         if item_ids is not None:
-            request_body["items"] = [{"objectId": item_id} for item_id in item_ids]
-
-        client = fabric.FabricRestClient()
-        response = client.post(
-            f"/v1/workspaces/{workspace_id}/git/commitToGit",
-            json=request_body,
+            payload["items"] = [{"objectId": item_id} for item_id in item_ids]
+
+        _base_api(
+            request=f"/v1/workspaces/{workspace_id}/git/commitToGit",
+            method="post",
+            payload=payload,
+            lro_return_status_code=True,
+            status_codes=None,
         )
 
-        if response.status_code not in [200, 202]:
-            raise FabricHTTPException(response)
-
-        lro(client=client, response=response, return_status_code=True)
-
         if commit_mode == "All":
             print(
                 f"{icons.green_dot} All items within the '{workspace_name}' workspace have been committed to Git."
@@ -426,29 +409,26 @@ def update_from_git(
             f"{icons.red_dot} Invalid conflict resolution policy. Valid options: {conflict_resolution_policies}."
         )
 
-    request_body = {}
-    request_body["remoteCommitHash"] = remote_commit_hash
-    request_body["conflictResolution"] = {
+    payload = {}
+    payload["remoteCommitHash"] = remote_commit_hash
+    payload["conflictResolution"] = {
         "conflictResolutionType": "Workspace",
         "conflictResolutionPolicy": conflict_resolution_policy,
     }
 
     if workspace_head is not None:
-        request_body["workspaceHead"] = workspace_head
+        payload["workspaceHead"] = workspace_head
     if allow_override is not None:
-        request_body["options"] = {"allowOverrideItems": allow_override}
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/updateFromGit",
-        json=request_body,
+        payload["options"] = {"allowOverrideItems": allow_override}
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/updateFromGit",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    lro(client, response, return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been updated with commits pushed to the connected branch."
     )

sempy_labs/_graphQL.py

@@ -0,0 +1,95 @@
+import pandas as pd
+from uuid import UUID
+from typing import Optional
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    resolve_workspace_name_and_id,
+    _print_success,
+)
+
+
+def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
+    """
+    Shows the Graph QL APIs within a workspace.
+
+    This is a wrapper function for the following API: `Items - List GraphQLApis <https://learn.microsoft.com/rest/api/fabric/graphqlapi/items/list-graphqlapi-s>`_.
+
+    Parameters
+    ----------
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the GraphQL APIs within a workspace.
+    """
+
+    columns = {
+        "GraphQL API Name": "string",
+        "GraphQL API Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/GraphQLApis", uses_pagination=True
+    )
+
+    for r in responses:
+        for v in r.get("value", []):
+            new_data = {
+                "GraphQL API Name": v.get("displayName"),
+                "GraphQL API Id": v.get("id"),
+                "Description": v.get("description"),
+            }
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def create_graphql_api(
+    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
+):
+    """
+    Creates a GraphQL API.
+
+    This is a wrapper function for the following API: `Items - Create GraphQLApi <https://learn.microsoft.com/rest/api/fabric/graphqlapi/items/create-graphqlapi>`_.
+
+    Parameters
+    ----------
+    name: str
+        Name of the GraphQL API.
+    description : str, default=None
+        A description of the GraphQL API.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    payload = {"displayName": name}
+
+    if description:
+        payload["description"] = description
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/GraphQLApis",
+        method="post",
+        status_codes=[201, 202],
+        payload=payload,
+        lro_return_status_code=True,
+    )
+    _print_success(
+        item_name=name,
+        item_type="GraphQL API",
+        workspace_name=workspace_name,
+        action="created",
+    )