[dagster-sigma] Update Sigma docs to use translator instance and cont…

…ainer data classes (#26800) ## Summary & Motivation As title. ## How I Tested These Changes BK and docs preview
dagster-io · Jan 3, 2025 · b912cb4 · b912cb4 · github-actions · Jan 3, 2025
1 parent 5a63f7e
commit b912cb4
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/docs/content/api/modules.json.gz b/docs/content/api/modules.json.gz
diff --git a/docs/content/api/searchindex.json.gz b/docs/content/api/searchindex.json.gz
diff --git a/docs/content/api/sections.json.gz b/docs/content/api/sections.json.gz
diff --git a/docs/content/integrations/sigma.mdx b/docs/content/integrations/sigma.mdx
@@ -102,7 +102,7 @@ from dagster_sigma import (
     DagsterSigmaTranslator,
     SigmaBaseUrl,
     SigmaOrganization,
-    SigmaWorkbook,
+    SigmaWorkbookTranslatorData,
     load_sigma_asset_specs,
 )
 
@@ -117,15 +117,15 @@ sigma_organization = SigmaOrganization(
 
 # A translator class lets us customize properties of the built Sigma assets, such as the owners or asset key
 class MyCustomSigmaTranslator(DagsterSigmaTranslator):
-    def get_asset_spec(self, data: SigmaWorkbook) -> dg.AssetSpec:
+    def get_asset_spec(self, data: SigmaWorkbookTranslatorData) -> dg.AssetSpec:
         # We create the default asset spec using super()
         default_spec = super().get_asset_spec(data)
         # we customize the team owner tag for all Sigma assets
         return default_spec.replace_attributes(owners=["team:my_team"])
 
 
 sigma_specs = load_sigma_asset_specs(
-    sigma_organization, dagster_sigma_translator=MyCustomSigmaTranslator
+    sigma_organization, dagster_sigma_translator=MyCustomSigmaTranslator()
 )
 defs = dg.Definitions(assets=[*sigma_specs], resources={"sigma": sigma_organization})
 ```

diff --git a/examples/docs_snippets/docs_snippets/integrations/sigma/customize-sigma-asset-defs.py b/examples/docs_snippets/docs_snippets/integrations/sigma/customize-sigma-asset-defs.py
@@ -2,7 +2,7 @@
     DagsterSigmaTranslator,
     SigmaBaseUrl,
     SigmaOrganization,
-    SigmaWorkbook,
+    SigmaWorkbookTranslatorData,
     load_sigma_asset_specs,
 )
 
@@ -17,14 +17,14 @@
 
 # A translator class lets us customize properties of the built Sigma assets, such as the owners or asset key
 class MyCustomSigmaTranslator(DagsterSigmaTranslator):
-    def get_asset_spec(self, data: SigmaWorkbook) -> dg.AssetSpec:
+    def get_asset_spec(self, data: SigmaWorkbookTranslatorData) -> dg.AssetSpec:
         # We create the default asset spec using super()
-        default_spec = super().get_asset_spec(data)  # type: ignore
+        default_spec = super().get_asset_spec(data)
         # we customize the team owner tag for all Sigma assets
         return default_spec.replace_attributes(owners=["team:my_team"])
 
 
 sigma_specs = load_sigma_asset_specs(
-    sigma_organization, dagster_sigma_translator=MyCustomSigmaTranslator
+    sigma_organization, dagster_sigma_translator=MyCustomSigmaTranslator()
 )
 defs = dg.Definitions(assets=[*sigma_specs], resources={"sigma": sigma_organization})
diff --git a/python_modules/libraries/dagster-sigma/dagster_sigma/__init__.py b/python_modules/libraries/dagster-sigma/dagster_sigma/__init__.py
@@ -12,7 +12,9 @@
 from dagster_sigma.translator import (
     DagsterSigmaTranslator as DagsterSigmaTranslator,
     SigmaDataset as SigmaDataset,
+    SigmaDatasetTranslatorData as SigmaDatasetTranslatorData,
     SigmaWorkbook as SigmaWorkbook,
+    SigmaWorkbookTranslatorData as SigmaWorkbookTranslatorData,
 )
 from dagster_sigma.version import __version__