Utility functions for workspace, lakehouse, and tables #527

Kay-Personal · 2025-02-28T21:15:02Z

No description provided.

microsoft-github-policy-service · 2025-02-28T21:15:19Z

@Kay-Personal please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

m-kovalsky · 2025-03-02T07:40:37Z

src/sempy_labs/_helper_functions.py

@@ -17,7 +17,7 @@
 from IPython.display import display, HTML
 import requests
 import sempy_labs._authentication as auth
-
+from pyspark.sql import DataFrame


this import should be within the function itself. otherwise if SLL is opened in a pure python notebook, SLL will fail

Good to know. Removed, and will place this within the functions from now on.

m-kovalsky · 2025-03-02T07:45:45Z

src/sempy_labs/_helper_functions.py

+    Parameters
+    ----------
+    path : str
+        The path or name of the delta table.


I think we should have it say 'The abfss path or name of the delta table'.

Updated accordingly

m-kovalsky · 2025-03-02T07:48:05Z

src/sempy_labs/_helper_functions.py

+        Defaults to None which leaves the description blank.    
+    Returns
+    -------
+    Tuple[str, UUID]


Tuple[str, uuid.UUID]

Thx. Updated.

m-kovalsky · 2025-03-02T07:52:33Z

src/sempy_labs/_helper_functions.py

+
+def _get_or_create_workspace(
+    workspace: Optional[str | UUID] = None,
+    capacity_id: Optional[UUID] = None,


capacity: Optional[str | UUID] = None,

We can resolve a capacity name or ID to an ID using resolve_capacity_id() (see #533)

Thanks. Code updated and parameter description updated.

m-kovalsky · 2025-03-02T07:52:48Z

src/sempy_labs/_helper_functions.py

+        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.
+    capacity_id : uuid.UUID, default=None


capacity : str | uuid.UUID

m-kovalsky · 2025-03-02T07:53:57Z

src/sempy_labs/_helper_functions.py

+        # Otherwise create a new workspace.
+        try:
+            # But only if a human-friendly name was provided. If it's a Guid, raise an exception.
+            UUID(workspace)


can also use if _is_valid_uuid(workspace):

Thanks. Code simplified

m-kovalsky · 2025-03-02T07:55:46Z

src/sempy_labs/_helper_functions.py

+
+    except WorkspaceNotFoundException:
+        # Otherwise create a new workspace.
+        try:


I prefer to avoid use try/except when possible because they can mask other issues. We could do something like

filter_condition = urllib.parse.quote(workspace)
dfW = fabric.list_workspaces(filter=f"name eq '{filter_condition}'")
if dfW.empty:

No worries. Refactored.

m-kovalsky · 2025-03-02T07:56:05Z

src/sempy_labs/_helper_functions.py

+        Defaults to None which leaves the description blank.    
+    Returns
+    -------
+    Tuple[str, UUID]


Tuple[str, uuid.UUID]

m-kovalsky · 2025-03-02T07:56:30Z

src/sempy_labs/_helper_functions.py

+    return (lakehouse, lakehouse_id)
+
+
+def _save_as_delta_table(


we already have this function

OK, updated the description of your function to make clear that it accepts both, Pandas and PySpark dataframes.

Removed the _save_as_delta_table version

m-kovalsky · 2025-03-02T07:56:53Z

src/sempy_labs/_helper_functions.py

+    dataframe.write.mode("overwrite").format("delta").save(filePath)
+    print(f"{icons.green_dot} Delta table '{delta_table_name}' created and {dataframe.count()} rows inserted.")
+
+def _insert_into_delta_table(


we already have this function as save_as_delta_table(write_mode='append')

Cool. Removed.

…pace

m-kovalsky

is this still relevant? I've made many changes to these functions since which have made the functions work for both pyspark and pure python.

m-kovalsky · 2025-03-06T11:26:35Z

src/sempy_labs/_helper_functions.py

+    Tuple[str, uuid.UUID]
+        A tuple holding the name and ID of the workspace.
+    """
+    import urllib.parse


this import already exists at the top of the file

m-kovalsky · 2025-03-06T11:27:08Z

src/sempy_labs/_helper_functions.py

+        # Otherwise create a new workspace.
+        if _is_valid_uuid(workspace):
+            # But only if a human-friendly name was provided. If it's a Guid, raise an exception.
+            raise ValueError("For new workspaces, the workspace parameter must be string, not a Guid. Please provide a workspace name.")


please add the icons.red_dot

m-kovalsky · 2025-03-06T11:28:29Z

src/sempy_labs/_helper_functions.py

+            raise ValueError("For new workspaces, the workspace parameter must be string, not a Guid. Please provide a workspace name.")
+        elif not workspace:
+            # And also make sure the workspace parameter isn't empty.
+            raise ValueError("For new workspaces, the workspace parameter cannot be None or empty. Please provide a workspace name.")


please add the icons.red_dot

m-kovalsky · 2025-03-06T11:28:54Z

src/sempy_labs/_helper_functions.py

+            # And also make sure the workspace parameter isn't empty.
+            raise ValueError("For new workspaces, the workspace parameter cannot be None or empty. Please provide a workspace name.")
+
+        if _is_valid_uuid(capacity):


please use the resolve_capacity_id() logic. it handles this.

m-kovalsky · 2025-03-06T11:32:26Z

src/sempy_labs/_helper_functions.py

+    # Make sure the workspace exists. Raises WorkspaceNotFoundException otherwise.
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    try:


instead of using try can we do something like

dfI = fabric.list_items(type='Lakehouse', workspace=workspace)

and then filter that to see if the lakehouse exists. I prefer not to use try/except if we don't have to

KayUnkroth and others added 2 commits February 28, 2025 12:49

utility functions for workspace, lakehouse, and tables operations

bc0f5e9

Utility functions for workspace, lakehouse, and tables

96fdb86

m-kovalsky requested changes Mar 4, 2025

View reviewed changes

KayUnkroth added 8 commits March 4, 2025 11:58

utility functions for workspace, lakehouse, and tables operations

7441c1b

Addressing PR comments for _helper_functions.py

e7905db

Bug fixes for refactored save_as_delta_table and _get_or_create_works…

d4a910a

…pace

unnecessary pyspark.sql import removed

4e6ca17

Merge remote-tracking branch 'upstream/main'

7894fd4

indentation fixed

95e0779

Merge branch 'microsoft:main' into main

42cd0e7

Merge branch 'microsoft:main' into main

a851694

m-kovalsky reviewed Jun 12, 2025

View reviewed changes

Utility functions for workspace, lakehouse, and tables #527

Are you sure you want to change the base?

Utility functions for workspace, lakehouse, and tables #527

Uh oh!

Conversation

Kay-Personal commented Feb 28, 2025

Uh oh!

microsoft-github-policy-service bot commented Feb 28, 2025

Contribution License Agreement

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-kovalsky left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!