0.5.6 Tmdl POC (#102)

* concept of tmdl implemented

* woops misspelled

* tmdl poc

* reworking test framework w/ tox

* basic tmdl tests

* clean up paramtrize into conftest

* pytest_generate_test cleanup

* drop 3.8 add 3.13

* nevermind I'll keep 3.8

---------

Co-authored-by: Curtis Stallings <curtis.stallings@bakertilly.com>

Author: Curts0

.flake8

@@ -1,4 +1,4 @@
 [flake8]
-extend-ignore=E203
+extend-ignore=E203, D107
 max-line-length=100
 docstring-convention=google

.github/workflows/docstr-coverage.yml

@@ -30,4 +30,4 @@ jobs:
             python-version: '3.10'
       - run: pip install --upgrade pip
       - run: pip install docstr-coverage==2.2.0
-      - run: docstr-coverage
+      - run: docstr-coverage --skip-init

.gitignore

@@ -178,6 +178,7 @@ docs/_config.yml# Byte-compiled / optimized / DLL files
 *$py.class
 /Best_Practice_Analyzer
 /Tabular_Editor_2
+*.tmdl
 
 # Test files for new functionality
 test-notebook.ipynb

.pre-commit-config.yaml

@@ -1,4 +1,3 @@
-exclude pytabular/localsecret.py
 include pytabular/dll/Microsoft.AnalysisServices.AdomdClient.dll
 include pytabular/dll/Microsoft.AnalysisServices.Core.dll
 include pytabular/dll/Microsoft.AnalysisServices.dll

MANIFEST.in

@@ -0,0 +1 @@
+:::pytabular.tmdl.Tmdl

docs/tmdl.md

@@ -25,6 +25,7 @@ nav:
       - best_practice_analyzer: best_practice_analyzer.md
       - pbi_helper: pbi_helper.md
       - logic_utils: logic_utils.md
+      - tmdl: tmdl.md
     - Running Traces: tabular_tracing.md
     - Documenting Model: document.md
     - Contributing: CONTRIBUTING.md

mkdocs.yml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python_tabular"
-version = "0.5.5"
+version = "0.5.6"
 authors = [
   { name="Curtis Stallings", email="curtisrstallings@gmail.com" },
 ]
@@ -25,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Development Status :: 5 - Production/Stable",
     "Operating System :: Microsoft",
     "License :: OSI Approved :: MIT License"

pyproject.toml

@@ -65,6 +65,7 @@
 from .query import Connection
 from .pbi_helper import find_local_pbi_instances
 from .document import ModelDocumenter
+from .tmdl import Tmdl
 
 
 logger.info("Import successful...")

pytabular/__init__.py

@@ -0,0 +1,45 @@
+"""See [TMDL Scripting].(https://learn.microsoft.com/en-us/analysis-services/tmdl/tmdl-overview).
+
+Run `Tmdl(model).save_to_folder()` to save tmdl of model.
+Run `Tmdl(model).execute()` to execute a specific set of tmdl scripts.
+"""
+
+from Microsoft.AnalysisServices.Tabular import TmdlSerializer
+
+
+class Tmdl:
+    """Specify the specific model you want to use for scripting.
+
+    Args:
+        model (Tabular): Initialize with Tabular model.
+    """
+    def __init__(self, model):
+        self.model = model
+
+    def save_to_folder(self, path: str = "tmdl"):
+        """Runs `SerializeModelToFolder` from .net library.
+
+        Args:
+            path (str, optional): directory where to save tmdl structure.
+                Defaults to "tmdl".
+        """
+        TmdlSerializer.SerializeModelToFolder(self.model._object, path)
+        return True
+
+    def execute(self, path: str = "tmdl", auto_save: bool = True):
+        """Runs `DeserializeModelFromFolder` from .net library.
+
+        Args:
+            path (str, optional): directory to look for tmdl scripts.
+                Defaults to "tmdl".
+            auto_save (bool, optional): You can set to false
+                if you want to precheck a few things, but will need to
+                run `model.save_changes()`. Setting to `True` will go ahead
+                and execute `model.save_changes()` Defaults to True.
+        """
+        model_object = TmdlSerializer.DeserializeModelFromFolder(path)
+        model_object.CopyTo(self.model._object)
+        if auto_save:
+            return self.model.save_changes()
+        else:
+            return True