semantic-link-labs 0.5.0__tar.gz → 0.6.0__tar.gz

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: semantic-link-labs
-Version: 0.5.0
+Version: 0.6.0
 Summary: Semantic Link Labs project
 Author: Microsoft Corporation
 License: MIT License
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Framework :: Jupyter
 Requires-Python: <3.12,>=3.10
 License-File: LICENSE
-Requires-Dist: semantic-link-sempy>=0.7.5
+Requires-Dist: semantic-link-sempy>=0.7.6
 Requires-Dist: anytree
 Requires-Dist: powerbiclient
 Provides-Extra: test

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/README.md

@@ -1,13 +1,15 @@
-# [semantic-link-labs](https://semantic-link-labs.readthedocs.io/en/0.5.0/)
+# Semantic Link Labs
 
 [![PyPI version](https://badge.fury.io/py/semantic-link-labs.svg)](https://badge.fury.io/py/semantic-link-labs)
-[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.5.0&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
+[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.6.0&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/semantic-link-labs)](https://pepy.tech/project/semantic-link-labs)
 
-All functions in this library are documented [here](https://semantic-link-labs.readthedocs.io/en/0.5.0/)!
+---
+[Read the documentation on ReadTheDocs!](https://semantic-link-labs.readthedocs.io/en/stable/)
+---
 
-This is a python library intended to be used in [Microsoft Fabric notebooks](https://learn.microsoft.com/fabric/data-engineering/how-to-use-notebook). This library was originally intended to contain functions used for [migrating semantic models to Direct Lake mode](https://github.com/microsoft/semantic-link-labs?tab=readme-ov-file#direct-lake-migration). However, it quickly became apparent that functions within such a library could support many other useful activities in the realm of semantic models, reports, lakehouses and really anything Fabric-related. As such, this library contains a variety of functions ranging from running [Vertipaq Analyzer](https://semantic-link-labs.readthedocs.io/en/0.5.0/sempy_labs.html#sempy_labs.import_vertipaq_analyzer) or the [Best Practice Analyzer](https://semantic-link-labs.readthedocs.io/en/0.5.0/sempy_labs.html#sempy_labs.run_model_bpa) against a semantic model to seeing if any [lakehouse tables hit Direct Lake guardrails](https://semantic-link-labs.readthedocs.io/en/0.5.0/sempy_labs.lakehouse.html#sempy_labs.lakehouse.get_lakehouse_tables) or accessing the [Tabular Object Model](https://semantic-link-labs.readthedocs.io/en/0.5.0/sempy_labs.tom.html) and more!
+This is a python library intended to be used in [Microsoft Fabric notebooks](https://learn.microsoft.com/fabric/data-engineering/how-to-use-notebook). This library was originally intended to solely contain functions used for [migrating semantic models to Direct Lake mode](https://github.com/microsoft/semantic-link-labs?tab=readme-ov-file#direct-lake-migration). However, it quickly became apparent that functions within such a library could support many other useful activities in the realm of semantic models, reports, lakehouses and really anything Fabric-related. As such, this library contains a variety of functions ranging from running [Vertipaq Analyzer](https://semantic-link-labs.readthedocs.io/en/stable/sempy_labs.html#sempy_labs.import_vertipaq_analyzer) or the [Best Practice Analyzer](https://semantic-link-labs.readthedocs.io/en/stable/sempy_labs.html#sempy_labs.run_model_bpa) against a semantic model to seeing if any [lakehouse tables hit Direct Lake guardrails](https://semantic-link-labs.readthedocs.io/en/stable/sempy_labs.lakehouse.html#sempy_labs.lakehouse.get_lakehouse_tables) or accessing the [Tabular Object Model](https://semantic-link-labs.readthedocs.io/en/stable/sempy_labs.tom.html) and more!
 
 Instructions for migrating import/DirectQuery semantic models to Direct Lake mode can be found [here](https://github.com/microsoft/semantic-link-labs?tab=readme-ov-file#direct-lake-migration).
 
@@ -15,8 +17,6 @@ If you encounter any issues, please [raise a bug](https://github.com/microsoft/s
 
 If you have ideas for new features/functions, please [request a feature](https://github.com/microsoft/semantic-link-labs/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=).
 
-## [Function documentation](https://semantic-link-labs.readthedocs.io/en/0.5.0/)
-
 ## Install the library in a Fabric notebook
 ```python
 %pip install semantic-link-labs

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/docs/source/conf.py

@@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath('../../src/'))
 project = 'semantic-link-labs'
 copyright = '2024, Microsoft and community'
 author = 'Microsoft and community'
-release = '0.5.0'
+release = '0.6.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

semantic_link_labs-0.6.0/notebooks/Tabular Object Model.ipynb

@@ -0,0 +1 @@
+{"cells":[{"cell_type":"markdown","id":"5c27dfd1-4fe0-4a97-92e6-ddf78889aa93","metadata":{"nteract":{"transient":{"deleting":false}}},"source":["### Install the latest .whl package\n","\n","Check [here](https://pypi.org/project/semantic-link-labs/) to see the latest version."]},{"cell_type":"code","execution_count":null,"id":"d5cae9db-cef9-48a8-a351-9c5fcc99645c","metadata":{"jupyter":{"outputs_hidden":true,"source_hidden":false},"nteract":{"transient":{"deleting":false}}},"outputs":[],"source":["%pip install semantic-link-labs"]},{"cell_type":"markdown","id":"5a3fe6e8-b8aa-4447-812b-7931831e07fe","metadata":{"nteract":{"transient":{"deleting":false}}},"source":["### Connect to the [Tabular Object Model](https://learn.microsoft.com/analysis-services/tom/introduction-to-the-tabular-object-model-tom-in-analysis-services-amo?view=asallproducts-allversions) ([TOM](https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.model?view=analysisservices-dotnet))\n","Setting the 'readonly' property to False enables read/write mode. This allows changes to be made to the semantic model."]},{"cell_type":"code","execution_count":null,"id":"cde43b47-4ecc-46ae-9125-9674819c7eab","metadata":{"jupyter":{"outputs_hidden":false,"source_hidden":false},"nteract":{"transient":{"deleting":false}}},"outputs":[],"source":["import sempy_labs as labs\n","from sempy_labs.tom import connect_semantic_model\n","\n","dataset = '' # Enter dataset name\n","workspace = None # Enter workspace name\n","\n","with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        print(t.Name)"]},{"cell_type":"markdown","id":"fc6b277e","metadata":{},"source":["### Make changes to a semantic model using custom functions\n","Note that the custom functions have additional optional parameters (which may not be used in the examples below) for adding properties to model objects. Check the [documentation](https://semantic-link-labs.readthedocs.io/en/0.5.0/sempy_labs.tom.html) to see all available parameters for each function."]},{"cell_type":"markdown","id":"6d46d878","metadata":{},"source":["#### Rename objects in the semantic model"]},{"cell_type":"code","execution_count":null,"id":"1284825a","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        t.Name = t.Name.replace('_',' ')\n"]},{"cell_type":"code","execution_count":null,"id":"d3b60303","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for c in tom.all_columns():\n","        c.Name = c.Name.replace('_',' ')"]},{"cell_type":"markdown","id":"402a477c","metadata":{},"source":["#### Add measure(s) to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"bdaaaa5c","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_measure(table_name ='Internet Sales', measure_name = 'Sales Amount', expression = \"SUM('Internet Sales'[SalesAmount])\")\n","    tom.add_measure(table_name ='Internet Sales', measure_name = 'Order Quantity', expression = \"SUM('Internet Sales'[OrderQty])\")    "]},{"cell_type":"code","execution_count":null,"id":"a53a544b","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        if t.Name == 'Internet Sales':\n","            tom.add_measure(table_name = t.Name, measure_name = 'Sales Amount', expression = \"SUM('Internet Sales'[SalesAmount])\")\n","            tom.add_measure(table_name = t.Name, measure_name = 'Order Quantity', expression = \"SUM('Internet Sales'[OrderQty])\")"]},{"cell_type":"markdown","id":"1cb1632f","metadata":{},"source":["#### Add column(s) to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"81a22749","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_data_column(table_name ='Product', column_name = 'Size Range', source_column = 'SizeRange', data_type = 'Int64')\n","    tom.add_data_column(table_name = 'Segment', column_name = 'Summary Segment', source_column = 'SummarySegment', data_type = 'String')\n","\n","    tom.add_calculated_column(table_name = 'Internet Sales', column_name = 'GrossMargin', expression = \"'Internet Sales'[SalesAmount] - 'Internet Sales'[ProductCost]\", data_type = 'Decimal')"]},{"cell_type":"code","execution_count":null,"id":"053b6516","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        if t.Name == 'Product':\n","            tom.add_data_column(table_name = t.Name, column_name = 'Size Range', source_column = 'SizeRange', data_type = 'Int64')\n","        elif t.Name == 'Segment':\n","            tom.add_data_column(table_name = t.Name, column_name = 'Summary Segment', source_column = 'SummarySegment', data_type = 'String')\n","        elif t.Name == 'Internet Sales':\n","            tom.add_calculated_column(table_name = t.Name, column_name = 'GrossMargin', expression = \"'Internet Sales'[SalesAmount] - 'Internet Sales'[ProductCost]\", data_type = 'Decimal')"]},{"cell_type":"markdown","id":"f53dcca7","metadata":{},"source":["#### Add hierarchies to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"a9309e23","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_hierarchy(table_name = 'Geography', hierarchy_name = 'Geo Hierarchy', levels = ['Continent', 'Country', 'State', 'City'])"]},{"cell_type":"code","execution_count":null,"id":"a04281ce","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        if t.Name == 'Geography':\n","            tom.add_hierarchy(table_name = t.Name, hierarchy_name = 'Geo Hierarchy', levels = ['Continent', 'Country', 'State', 'City'])"]},{"cell_type":"markdown","id":"47c06a4f","metadata":{},"source":["#### Add relationship(s) to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"e8cd7bbf","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_relationship(\n","        from_table = 'Internet Sales', from_column = 'ProductKey',\n","        to_table = 'Product', to_column = 'ProductKey', \n","        from_cardinality = 'Many', to_cardinality = 'One')"]},{"cell_type":"markdown","id":"3cc7f11e","metadata":{},"source":["#### Add a table with an M partition to a semantic model"]},{"cell_type":"code","execution_count":null,"id":"0f5dd66a","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    table_name = 'Sales'\n","    tom.add_table(name = table_name)\n","    tom.add_m_partition(table_name = table_name, partition_name = table_name, expression = 'let....')"]},{"cell_type":"markdown","id":"ea389123","metadata":{},"source":["#### Add a table with an entity partition to a Direct Lake semantic model "]},{"cell_type":"code","execution_count":null,"id":"f75387d1","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    table_name = 'Sales'\n","    tom.add_table(name = table_name)\n","    tom.add_entity_partition(table_name = table_name, entity_name = table_name)"]},{"cell_type":"markdown","id":"e74d0f54","metadata":{},"source":["#### Add a calculated table (and columns) to a semantic model"]},{"cell_type":"code","execution_count":null,"id":"934f7315","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    table_name = 'Sales'\n","    tom.add_calculated_table(name = table_name, expression = \"DISTINCT('Product'[Color])\")\n","    tom.add_calculated_table_column(table_name = table_name, column_name = 'Color', source_column = \"'Product[Color]\", data_type = 'String')"]},{"cell_type":"markdown","id":"0e7088b7","metadata":{},"source":["#### Add role(s) to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"ad60ebb9","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_role(role_name = 'Reader')"]},{"cell_type":"markdown","id":"c541f81a","metadata":{},"source":["#### Set row level security (RLS) to the semantic model\n","This adds row level security (or updates it if it already exists)"]},{"cell_type":"code","execution_count":null,"id":"98603a08","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.set_rls(role_name ='Reader', table_name = 'Product', filter_expression = \"'Dim Product'[Color] = \\\"Blue\\\"\")"]},{"cell_type":"code","execution_count":null,"id":"effea009","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for r in tom.model.Roles:\n","        if r.Name == 'Reader':\n","            tom.set_rls(role_name = r.Name, table_name = 'Product', filter_expression = \"'Dim Product'[Color] = \\\"Blue\\\"\")"]},{"cell_type":"markdown","id":"7fa7a03c","metadata":{},"source":["#### Set object level security (OLS) to the semantic model\n","This adds row level security (or updates it if it already exists)"]},{"cell_type":"code","execution_count":null,"id":"dd0def9d","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.set_ols(role_name = 'Reader', table_name = 'Product', column_name = 'Size', permission = 'None')"]},{"cell_type":"code","execution_count":null,"id":"7a389dc7","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for r in tom.model.Roles:\n","        if r.Name == 'Reader':\n","            for t in tom.model.Tables:\n","                if t.Name == 'Product':\n","                    tom.set_ols(role_name = r.Name, table_name = t.Name, column_name = 'Size', permission = 'None')"]},{"cell_type":"markdown","id":"d0f7ccd1","metadata":{},"source":["#### Add calculation groups and calculation items to the semantic model"]},{"cell_type":"code","execution_count":null,"id":"97f4708b","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_calculation_group(name = 'MyCalcGroup')"]},{"cell_type":"code","execution_count":null,"id":"fef68832","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_calculation_item(table_name = 'MyCalcGroup', calculation_item_name = 'YTD', expression = \"CALCULATE(SELECTEDMEASURE(), DATESYTD('Calendar'[CalendarDate]))\")\n","    tom.add_calculation_item(table_name = 'MyCalcGroup', calculation_item_name = 'MTD', expression = \"CALCULATE(SELECTEDMEASURE(), DATESMTD('Calendar'[CalendarDate]))\")"]},{"cell_type":"code","execution_count":null,"id":"c7653dcc","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        if t.Name == 'MyCalcGroup':\n","            tom.add_calculation_item(table_name = t.Name, calculation_item_name = 'YTD', expression = \"CALCULATE(SELECTEDMEASURE(), DATESYTD('Calendar'[CalendarDate]))\")\n","            tom.add_calculation_item(table_name = t.Name, calculation_item_name = 'MTD', expression = \"CALCULATE(SELECTEDMEASURE(), DATESMTD('Calendar'[CalendarDate]))\")"]},{"cell_type":"markdown","id":"c6450c74","metadata":{},"source":["#### Add translations to a semantic model"]},{"cell_type":"code","execution_count":null,"id":"2b616b90","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_translation(language = 'it-IT')"]},{"cell_type":"code","execution_count":null,"id":"dc24c200","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.set_translation(object = tom.model.Tables['Product'], language = 'it-IT', property = 'Name', value = 'Produtto')"]},{"cell_type":"markdown","id":"3048cc95","metadata":{},"source":["#### Add a [Field Parameter](https://learn.microsoft.com/power-bi/create-reports/power-bi-field-parameters) to a semantic model"]},{"cell_type":"code","execution_count":null,"id":"0a94af94","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.add_field_parameter(table_name = 'Parameter', objects = \"'Product'[Color], [Sales Amount], 'Geography'[Country]\")"]},{"cell_type":"markdown","id":"95aac09a","metadata":{},"source":["#### Remove an object(s) from a semantic model"]},{"cell_type":"code","execution_count":null,"id":"1e2572a8","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        if t.Name == 'Product':\n","            tom.remove_object(object = t.Columns['Size'])\n","            tom.remove_object(object = t.Hierarchies['Product Hierarchy'])"]},{"cell_type":"code","execution_count":null,"id":"bc453177","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.remove_object(object = tom.model.Tables['Product'].Columns['Size'])\n","    tom.remove_object(object = tom.model.Tables['Product'].Hierarchies['Product Hierarchy'])"]},{"cell_type":"markdown","id":"e0d0cb9e","metadata":{},"source":["### Custom functions to loop through non-top-level objects in a semantic model"]},{"cell_type":"code","execution_count":null,"id":"cbe3b1a3","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for c in tom.all_columns():\n","        print(c.Name)"]},{"cell_type":"code","execution_count":null,"id":"3f643e66","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for m in tom.all_measures():\n","        print(m.Name)"]},{"cell_type":"code","execution_count":null,"id":"ed1cde0f","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for p in tom.all_partitions():\n","        print(p.Name)"]},{"cell_type":"code","execution_count":null,"id":"f48014ae","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for h in tom.all_hierarchies():\n","        print(h.Name)"]},{"cell_type":"code","execution_count":null,"id":"9f5e7b72","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for ci in tom.all_calculation_items():\n","        print(ci.Name)"]},{"cell_type":"code","execution_count":null,"id":"3cd9ebc1","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for l in tom.all_levels():\n","        print(l.Name)"]},{"cell_type":"code","execution_count":null,"id":"12c58bad","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    for rls in tom.all_rls():\n","        print(rls.Name)"]},{"cell_type":"markdown","id":"1a294bd2","metadata":{},"source":["### See Vertipaq Analyzer stats"]},{"cell_type":"code","execution_count":null,"id":"469660e9","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=False, workspace=workspace) as tom:\n","    tom.set_vertipaq_annotations()\n","\n","    for t in tom.model.Tables:\n","        rc = tom.row_count(object = t)\n","        print(t.Name + ' : ' + str(rc))\n","        for c in t.Columns:\n","            col_size = tom.total_size(column = c)\n","            print(labs.format_dax_object_name(t.Name, c.Name) + ' : ' + str(col_size))"]},{"cell_type":"markdown","id":"1ab26dfd","metadata":{},"source":["### 'UsedIn' functions"]},{"cell_type":"code","execution_count":null,"id":"412bf287","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for c in tom.all_columns():\n","        full_name = labs.format_dax_object_name(c.Parent.Name, c.Name)\n","        for h in tom.used_in_hierarchies(column = c):\n","            print(full_name + ' : ' + h.Name)"]},{"cell_type":"code","execution_count":null,"id":"76556900","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for c in tom.all_columns():\n","        full_name = labs.format_dax_object_name(c.Parent.Name, c.Name)\n","        for r in tom.used_in_relationships(object = c):\n","            rel_name = labs.create_relationship_name(r.FromTable.Name, r.FromColumn.Name, r.ToTable.Name, r.ToColumn.Name)\n","            print(full_name + ' : ' + rel_name)"]},{"cell_type":"code","execution_count":null,"id":"4d9ec24e","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    for t in tom.model.Tables:\n","        for r in tom.used_in_relationships(object = t):\n","            rel_name = labs.create_relationship_name(r.FromTable.Name, r.FromColumn.Name, r.ToTable.Name, r.ToColumn.Name)\n","            print(t.Name + ' : ' + rel_name)"]},{"cell_type":"code","execution_count":null,"id":"82251336","metadata":{},"outputs":[],"source":["with connect_semantic_model(dataset=dataset, readonly=True, workspace=workspace) as tom:\n","    dep = labs.get_model_calc_dependencies(dataset = dataset, workspace=workspace)\n","    for o in tom.used_in_rls(object = tom.model.Tables['Product'].Columns['Color'], dependencies=dep):\n","        print(o.Name)"]}],"metadata":{"kernel_info":{"name":"synapse_pyspark"},"kernelspec":{"display_name":"Synapse PySpark","language":"Python","name":"synapse_pyspark"},"language_info":{"name":"python"},"microsoft":{"language":"python"},"nteract":{"version":"nteract-front-end@1.0.0"},"spark_compute":{"compute_id":"/trident/default"},"synapse_widget":{"state":{},"version":"0.1"},"widgets":{}},"nbformat":4,"nbformat_minor":5}

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/pyproject.toml

@@ -7,7 +7,7 @@ name="semantic-link-labs"
 authors = [
     { name = "Microsoft Corporation" },
 ]
-version="0.5.0"
+version="0.6.0"
 description="Semantic Link Labs project"
 requires-python=">=3.10,<3.12"
 classifiers = [
@@ -22,7 +22,7 @@ classifiers = [
 license= { text = "MIT License" }
 
 dependencies = [
-    "semantic-link-sempy>=0.7.5",
+    "semantic-link-sempy>=0.7.6",
     "anytree",
     "powerbiclient"
 ]

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/semantic_link_labs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: semantic-link-labs
-Version: 0.5.0
+Version: 0.6.0
 Summary: Semantic Link Labs project
 Author: Microsoft Corporation
 License: MIT License
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Framework :: Jupyter
 Requires-Python: <3.12,>=3.10
 License-File: LICENSE
-Requires-Dist: semantic-link-sempy>=0.7.5
+Requires-Dist: semantic-link-sempy>=0.7.6
 Requires-Dist: anytree
 Requires-Dist: powerbiclient
 Provides-Extra: test

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/semantic_link_labs.egg-info/SOURCES.txt

@@ -39,6 +39,7 @@ src/sempy_labs/_icons.py
 src/sempy_labs/_list_functions.py
 src/sempy_labs/_model_auto_build.py
 src/sempy_labs/_model_bpa.py
+src/sempy_labs/_model_bpa_rules.py
 src/sempy_labs/_model_dependencies.py
 src/sempy_labs/_one_lake_integration.py
 src/sempy_labs/_query_scale_out.py

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/semantic_link_labs.egg-info/requires.txt

@@ -1,4 +1,4 @@
-semantic-link-sempy>=0.7.5
+semantic-link-sempy>=0.7.6
 anytree
 powerbiclient
 

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/sempy_labs/__init__.py

@@ -9,13 +9,15 @@ from sempy_labs._dax import evaluate_dax_impersonation
 from sempy_labs._generate_semantic_model import (
     create_blank_semantic_model,
     create_semantic_model_from_bim,
-    # deploy_semantic_model,
+    deploy_semantic_model,
     get_semantic_model_bim,
 )
 from sempy_labs._list_functions import (
+    delete_custom_pool,
     list_semantic_model_objects,
     list_shortcuts,
     get_object_level_security,
+    list_capacities,
     # list_annotations,
     # list_columns,
     list_dashboards,
@@ -66,8 +68,10 @@ from sempy_labs._helper_functions import (
     resolve_report_name,
     #  language_validate
 )
+
 #  from sempy_labs._model_auto_build import model_auto_build
-from sempy_labs._model_bpa import model_bpa_rules, run_model_bpa
+from sempy_labs._model_bpa import run_model_bpa
+from sempy_labs._model_bpa_rules import model_bpa_rules
 from sempy_labs._model_dependencies import (
     measure_dependency_tree,
     get_measure_dependencies,
@@ -97,6 +101,7 @@ from sempy_labs._vertipaq import (
 )
 
 __all__ = [
+    "delete_custom_pool",
     "clear_cache",
     # create_connection_cloud,
     # create_connection_vnet,
@@ -104,7 +109,7 @@ __all__ = [
     "evaluate_dax_impersonation",
     "create_blank_semantic_model",
     "create_semantic_model_from_bim",
-    #'deploy_semantic_model',
+    "deploy_semantic_model",
     "get_semantic_model_bim",
     "get_object_level_security",
     #'list_annotations',
@@ -125,7 +130,7 @@ __all__ = [
     #'list_sqlendpoints',
     #'list_tables',
     "list_warehouses",
-    'list_workspace_role_assignments',
+    "list_workspace_role_assignments",
     "create_warehouse",
     "update_item",
     "create_abfss_path",
@@ -141,20 +146,20 @@ __all__ = [
     "resolve_report_id",
     "resolve_report_name",
     #'language_validate',
-    #"model_auto_build",
+    # "model_auto_build",
     "model_bpa_rules",
     "run_model_bpa",
     "measure_dependency_tree",
     "get_measure_dependencies",
     "get_model_calc_dependencies",
     "export_model_to_onelake",
-    'qso_sync',
-    'qso_sync_status',
-    'set_qso',
-    'list_qso_settings',
-    'disable_qso',
-    'set_semantic_model_storage_format',
-    'set_workspace_default_storage_format',
+    "qso_sync",
+    "qso_sync_status",
+    "set_qso",
+    "list_qso_settings",
+    "disable_qso",
+    "set_semantic_model_storage_format",
+    "set_workspace_default_storage_format",
     "refresh_semantic_model",
     "cancel_dataset_refresh",
     "translate_semantic_model",
@@ -174,5 +179,6 @@ __all__ = [
     "delete_user_from_workspace",
     "update_workspace_user",
     "list_workspace_users",
-    "assign_workspace_to_dataflow_storage"
+    "assign_workspace_to_dataflow_storage",
+    "list_capacities",
 ]

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/sempy_labs/_ai.py

@@ -14,7 +14,6 @@ def optimize_semantic_model(dataset: str, workspace: Optional[str] = None):
     from ._model_bpa import run_model_bpa
     from .directlake._fallback import check_fallback_reason
     from ._helper_functions import format_dax_object_name
-    from sempy_labs.tom import connect_semantic_model
 
     modelBPA = run_model_bpa(
         dataset=dataset, workspace=workspace, return_dataframe=True
@@ -41,7 +40,8 @@ def optimize_semantic_model(dataset: str, workspace: Optional[str] = None):
 
         if len(fallback_filt) > 0:
             print(
-                f"{icons.yellow_dot} The '{dataset}' semantic model is a Direct Lake semantic model which contains views. Since views always fall back to DirectQuery, it is recommended to only use lakehouse tables and not views."
+                f"{icons.yellow_dot} The '{dataset}' semantic model is a Direct Lake semantic model which contains views. "
+                "Since views always fall back to DirectQuery, it is recommended to only use lakehouse tables and not views."
             )
 
     # Potential model reduction estimate
@@ -79,7 +79,9 @@ def generate_measure_descriptions(
 
     validModels = ["gpt-35-turbo", "gpt-35-turbo-16k", "gpt-4"]
     if gpt_model not in validModels:
-        raise ValueError(f"{icons.red_dot} The '{gpt_model}' model is not a valid model. Enter a gpt_model from this list: {validModels}.")
+        raise ValueError(
+            f"{icons.red_dot} The '{gpt_model}' model is not a valid model. Enter a gpt_model from this list: {validModels}."
+        )
 
     dfM = fabric.list_measures(dataset=dataset, workspace=workspace)
 
@@ -114,8 +116,7 @@ def generate_measure_descriptions(
     )
 
     # Update the model to use the new descriptions
-    #with connect_semantic_model(dataset=dataset, workspace=workspace, readonly=False) as tom:
-    
+    # with connect_semantic_model(dataset=dataset, workspace=workspace, readonly=False) as tom:
 
     # for t in m.Tables:
     # tName = t.Name
@@ -146,10 +147,10 @@ def generate_aggs(
     import System
 
     # columns = {
-    #'SalesAmount': 'Sum',
-    #'ProductKey': 'GroupBy',
-    #'OrderDateKey': 'GroupBy'
-    # }
+    # 'SalesAmount': 'Sum',
+    # 'ProductKey': 'GroupBy',
+    # 'OrderDateKey': 'GroupBy'
+    #  }
 
     if workspace is None:
         workspace_id = fabric.get_workspace_id()
@@ -171,33 +172,44 @@ def generate_aggs(
     numericTypes = ["Int64", "Double", "Decimal"]
 
     if any(value not in aggTypes for value in columns.values()):
-        raise ValueError(f"{icons.red_dot} Invalid aggregation type(s) have been specified in the 'columns' parameter. Valid aggregation types: {aggTypes}.")
+        raise ValueError(
+            f"{icons.red_dot} Invalid aggregation type(s) have been specified in the 'columns' parameter. Valid aggregation types: {aggTypes}."
+        )
 
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     dfP = fabric.list_partitions(dataset=dataset, workspace=workspace)
     dfM = fabric.list_measures(dataset=dataset, workspace=workspace)
     dfR = fabric.list_relationships(dataset=dataset, workspace=workspace)
     if not any(r["Mode"] == "DirectLake" for i, r in dfP.iterrows()):
-        raise ValueError(f"{icons.red_dot} The '{dataset}' semantic model within the '{workspace}' workspace is not in Direct Lake mode. This function is only relevant for Direct Lake semantic models.")
-        
+        raise ValueError(
+            f"{icons.red_dot} The '{dataset}' semantic model within the '{workspace}' workspace is not in Direct Lake mode. This function is only relevant for Direct Lake semantic models."
+        )
+
     dfC_filtT = dfC[dfC["Table Name"] == table_name]
 
     if len(dfC_filtT) == 0:
-        raise ValueError(f"{icons.red_dot} The '{table_name}' table does not exist in the '{dataset}' semantic model within the '{workspace}' workspace.")
+        raise ValueError(
+            f"{icons.red_dot} The '{table_name}' table does not exist in the '{dataset}' semantic model within the '{workspace}' workspace."
+        )
 
     dfC_filt = dfC[
         (dfC["Table Name"] == table_name) & (dfC["Column Name"].isin(columnValues))
     ]
 
     if len(columns) != len(dfC_filt):
-        raise ValueError(f"{icons.red_dot} Columns listed in '{columnValues}' do not exist in the '{table_name}' table in the '{dataset}' semantic model within the '{workspace}' workspace.")
+        raise ValueError(
+            f"{icons.red_dot} Columns listed in '{columnValues}' do not exist in the '{table_name}' table in the '{dataset}' semantic model within the '{workspace}' workspace."
+        )
 
     # Check if doing sum/count/min/max etc. on a non-number column
-    for col, agg in columns.items():
-        dfC_col = dfC_filt[dfC_filt["Column Name"] == col]
+    for cm, agg in columns.items():
+        dfC_col = dfC_filt[dfC_filt["Column Name"] == cm]
         dataType = dfC_col["Data Type"].iloc[0]
         if agg in aggTypesAggregate and dataType not in numericTypes:
-            raise ValueError(f"{icons.red_dot} The '{col}' column in the '{table_name}' table is of '{dataType}' data type. Only columns of '{numericTypes}' data types can be aggregated as '{aggTypesAggregate}' aggregation types.")            
+            raise ValueError(
+                f"{icons.red_dot} The '{cm}' column in the '{table_name}' table is of '{dataType}' data type. Only columns of '{numericTypes}' data types"
+                f" can be aggregated as '{aggTypesAggregate}' aggregation types."
+            )
 
     # Create/update lakehouse delta agg table
     aggSuffix = "_agg"
@@ -213,7 +225,10 @@ def generate_aggs(
     dfI_filt = dfI[(dfI["Id"] == sqlEndpointId)]
 
     if len(dfI_filt) == 0:
-        raise ValueError(f"{icons.red_dot} The lakehouse (SQL Endpoint) used by the '{dataset}' semantic model does not reside in the '{lakehouse_workspace}' workspace. Please update the lakehouse_workspace parameter.")
+        raise ValueError(
+            f"{icons.red_dot} The lakehouse (SQL Endpoint) used by the '{dataset}' semantic model does not reside in"
+            f" the '{lakehouse_workspace}' workspace. Please update the lakehouse_workspace parameter."
+        )
 
     lakehouseName = dfI_filt["Display Name"].iloc[0]
     lakehouse_id = resolve_lakehouse_id(
@@ -223,8 +238,8 @@ def generate_aggs(
     # Generate SQL query
     query = "SELECT"
     groupBy = "\nGROUP BY"
-    for col, agg in columns.items():
-        colFilt = dfC_filt[dfC_filt["Column Name"] == col]
+    for cm, agg in columns.items():
+        colFilt = dfC_filt[dfC_filt["Column Name"] == cm]
         sourceCol = colFilt["Source"].iloc[0]
 
         if agg == "GroupBy":
@@ -328,7 +343,9 @@ def generate_aggs(
             col.DataType = System.Enum.Parse(TOM.DataType, dType)
 
             m.Tables[aggTableName].Columns.Add(col)
-            print(f"{icons.green_dot} The '{aggTableName}'[{cName}] column has been added.")
+            print(
+                f"{icons.green_dot} The '{aggTableName}'[{cName}] column has been added."
+            )
 
     # Create relationships
     relMap = {"m": "Many", "1": "One", "0": "None"}
@@ -367,10 +384,11 @@ def generate_aggs(
                 print(
                     f"{icons.green_dot} '{aggTableName}'[{fromColumn}] -> '{toTable}'[{toColumn}] relationship has been added."
                 )
-            except:
+            except Exception as e:
                 print(
                     f"{icons.red_dot} '{aggTableName}'[{fromColumn}] -> '{toTable}'[{toColumn}] relationship has not been created."
                 )
+                print(f"Exception occured: {e}")
         elif toTable == table_name:
             try:
                 rel.ToColumn = m.Tables[aggTableName].Columns[toColumn]
@@ -378,11 +396,12 @@ def generate_aggs(
                 print(
                     f"{icons.green_dot} '{fromTable}'[{fromColumn}] -> '{aggTableName}'[{toColumn}] relationship has been added."
                 )
-            except:
+            except Exception as e:
                 print(
                     f"{icons.red_dot} '{fromTable}'[{fromColumn}] -> '{aggTableName}'[{toColumn}] relationship has not been created."
                 )
-    f"Relationship creation is complete."
+                print(f"Exception occured: {e}")
+    "Relationship creation is complete."
 
     # Create IF measure
     f"\n{icons.in_progress} Creating measure to check if the agg table can be used..."

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/sempy_labs/_clear_cache.py

@@ -1,7 +1,6 @@
-import sempy
 import sempy.fabric as fabric
 from ._helper_functions import resolve_dataset_id
-from typing import List, Optional, Union
+from typing import Optional
 import sempy_labs._icons as icons
 
 
@@ -25,10 +24,10 @@ def clear_cache(dataset: str, workspace: Optional[str] = None):
     datasetID = resolve_dataset_id(dataset=dataset, workspace=workspace)
 
     xmla = f"""
-            <ClearCache xmlns="http://schemas.microsoft.com/analysisservices/2003/engine">  
+            <ClearCache xmlns="http://schemas.microsoft.com/analysisservices/2003/engine">
                 <Object>  
-                    <DatabaseID>{datasetID}</DatabaseID>  
-                </Object>  
+                    <DatabaseID>{datasetID}</DatabaseID>
+                </Object>
             </ClearCache>
             """
     fabric.execute_xmla(dataset=dataset, xmla_command=xmla, workspace=workspace)

{semantic_link_labs-0.5.0 → semantic_link_labs-0.6.0}/src/sempy_labs/_connections.py

@@ -1,8 +1,6 @@
-import sempy
 import sempy.fabric as fabric
 import pandas as pd
-from typing import List, Optional, Union
-import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_connection_cloud(
@@ -56,29 +54,32 @@ def create_connection_cloud(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    return df
 
 
 def create_connection_on_prem(
@@ -131,30 +132,33 @@ def create_connection_on_prem(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Gateway ID": o.get("gatewayId"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Gateway ID": o.get("gatewayId"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    return df
 
 
 def create_connection_vnet(
@@ -209,27 +213,30 @@ def create_connection_vnet(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Gateway ID": o.get("gatewayId"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
-
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Gateway ID": o.get("gatewayId"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+
+    return df