semantic-link-labs 0.8.10__py3-none-any.whl → 0.8.11__py3-none-any.whl

sempy_labs/_git.py

@@ -7,19 +7,19 @@ from sempy_labs._helper_functions import (
     lro,
 )
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
-def connect_workspace_to_git(
+def connect_workspace_to_azure_dev_ops(
     organization_name: str,
     project_name: str,
     repository_name: str,
     branch_name: str,
     directory_name: str,
-    git_provider_type: str = "AzureDevOps",
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
-    Connects a workspace to a git repository.
+    Connects a workspace to an Azure DevOps git repository.
 
     This is a wrapper function for the following API: `Git - Connect <https://learn.microsoft.com/rest/api/fabric/core/git/connect>`_.
 
@@ -35,21 +35,19 @@ def connect_workspace_to_git(
         The branch name.
     directory_name : str
         The directory name.
-    git_provider_type : str, default="AzureDevOps"
-        A `Git provider type <https://learn.microsoft.com/rest/api/fabric/core/git/connect?tabs=HTTP#gitprovidertype>`_.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     request_body = {
         "gitProviderDetails": {
             "organizationName": organization_name,
             "projectName": project_name,
-            "gitProviderType": git_provider_type,
+            "gitProviderType": "AzureDevOps",
             "repositoryName": repository_name,
             "branchName": branch_name,
             "directoryName": directory_name,
@@ -64,11 +62,73 @@ def connect_workspace_to_git(
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{workspace}' workspace has been connected to the '{project_name}' Git project within the '{repository_name}' repository."
+        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."
     )
 
 
-def disconnect_workspace_from_git(workspace: Optional[str] = None):
+def connect_workspace_to_github(
+    owner_name: str,
+    repository_name: str,
+    branch_name: str,
+    directory_name: str,
+    connection_id: UUID,
+    source: str = "ConfiguredConnection",
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Connects a workspace to a GitHub git repository.
+
+    This is a wrapper function for the following API: `Git - Connect <https://learn.microsoft.com/rest/api/fabric/core/git/connect>`_.
+
+    Parameters
+    ----------
+    owner_name : str
+        The owner name.
+    repository_name : str
+        The repository name.
+    branch_name : str
+        The branch name.
+    directory_name : str
+        The directory name.
+    source : str, default="ConfiguredConnection"
+        The Git credentials source.
+    connection_id : uuid.UUID
+        The object ID of the connection.
+    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)
+
+    request_body = {
+        "gitProviderDetails": {
+            "ownerName": owner_name,
+            "gitProviderType": "GitHub",
+            "repositoryName": repository_name,
+            "branchName": branch_name,
+            "directoryName": directory_name,
+        },
+        "myGitCredentials": {
+            "source": source,
+            "connectionId": connection_id,
+        },
+    }
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"/v1/workspaces/{workspace_id}/git/connect", json=request_body
+    )
+    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."
+    )
+
+
+def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
     """
     Disconnects a workpsace from a git repository.
 
@@ -76,13 +136,13 @@ def disconnect_workspace_from_git(workspace: Optional[str] = None):
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.post(f"/v1/workspaces/{workspace_id}/git/disconnect")
@@ -90,11 +150,11 @@ def disconnect_workspace_from_git(workspace: Optional[str] = None):
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{workspace}' workspace has been disconnected from Git."
+        f"{icons.green_dot} The '{workspace_name}' workspace has been disconnected from Git."
     )
 
 
-def get_git_status(workspace: Optional[str] = None) -> pd.DataFrame:
+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.
 
@@ -102,8 +162,8 @@ def get_git_status(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -113,7 +173,7 @@ def get_git_status(workspace: Optional[str] = None) -> pd.DataFrame:
         A pandas dataframe showing the Git status of items in the workspace.
     """
 
-    workspace, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     df = pd.DataFrame(
         columns=[
@@ -157,7 +217,7 @@ def get_git_status(workspace: Optional[str] = None) -> pd.DataFrame:
     return df
 
 
-def get_git_connection(workspace: Optional[str] = None) -> pd.DataFrame:
+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.
 
@@ -165,8 +225,8 @@ def get_git_connection(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -176,7 +236,7 @@ def get_git_connection(workspace: Optional[str] = None) -> pd.DataFrame:
         A pandas dataframe showing the Git status of items in the workspace.
     """
 
-    workspace, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     df = pd.DataFrame(
         columns=[
@@ -217,7 +277,7 @@ def get_git_connection(workspace: Optional[str] = None) -> pd.DataFrame:
     return df
 
 
-def initialize_git_connection(workspace: Optional[str] = None) -> str:
+def initialize_git_connection(workspace: Optional[str | UUID] = None) -> str:
     """
     Initializes a connection for a workspace that is connected to Git.
 
@@ -225,8 +285,8 @@ def initialize_git_connection(workspace: Optional[str] = None) -> str:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -236,7 +296,7 @@ def initialize_git_connection(workspace: Optional[str] = None) -> str:
         Remote full SHA commit hash.
     """
 
-    workspace, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.post(f"/v1/workspaces/{workspace_id}/git/initializeConnection")
@@ -247,14 +307,16 @@ def initialize_git_connection(workspace: Optional[str] = None) -> str:
     lro(client, response)
 
     print(
-        f"{icons.green_dot} The '{workspace}' workspace git connection has been initialized."
+        f"{icons.green_dot} The '{workspace_name}' workspace git connection has been initialized."
     )
 
     return response.json().get("remoteCommitHash")
 
 
 def commit_to_git(
-    comment: str, item_ids: str | List[str] = None, workspace: Optional[str] = None
+    comment: str,
+    item_ids: UUID | List[UUID] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Commits all or a selection of items within a workspace to Git.
@@ -265,18 +327,18 @@ def commit_to_git(
     ----------
     comment : str
         The Git commit comment.
-    item_ids : str | List[str], default=None
+    item_ids : uuid.UUID | List[uuid.UUID], default=None
         A list of item Ids to commit to Git.
         Defaults to None which commits all items to Git.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    gs = get_git_status(workspace=workspace)
+    gs = get_git_status(workspace=workspace_id)
     if not gs.empty:
         workspace_head = gs["Workspace Head"].iloc[0]
 
@@ -310,15 +372,15 @@ def commit_to_git(
 
         if commit_mode == "All":
             print(
-                f"{icons.green_dot} All items within the '{workspace}' workspace have been committed to Git."
+                f"{icons.green_dot} All items within the '{workspace_name}' workspace have been committed to Git."
             )
         else:
             print(
-                f"{icons.green_dot} The {item_ids} items within the '{workspace}' workspace have been committed to Git."
+                f"{icons.green_dot} The {item_ids} items within the '{workspace_name}' workspace have been committed to Git."
             )
     else:
         print(
-            f"{icons.info} Git already up to date: no modified items found within the '{workspace}' workspace."
+            f"{icons.info} Git already up to date: no modified items found within the '{workspace_name}' workspace."
         )
 
 
@@ -327,7 +389,7 @@ def update_from_git(
     conflict_resolution_policy: str,
     workspace_head: Optional[str] = None,
     allow_override: bool = False,
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Updates the workspace with commits pushed to the connected branch.
@@ -345,13 +407,13 @@ def update_from_git(
         In other cases, the system will validate that the given value is aligned with the head known to the system.
     allow_override : bool, default=False
         User consent to override incoming items during the update from Git process. When incoming items are present and the allow override items is not specified or is provided as false, the update operation will not start. Default value is false.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     conflict_resolution_policies = ["PreferWorkspace", "PreferRemote"]
     if "remote" in [policy.lower() for policy in conflict_resolution_policies]:
@@ -388,5 +450,5 @@ def update_from_git(
     lro(client, response, return_status_code=True)
 
     print(
-        f"{icons.green_dot} The '{workspace}' workspace has been updated with commits pushed to the connected branch."
+        f"{icons.green_dot} The '{workspace_name}' workspace has been updated with commits pushed to the connected branch."
     )