export AssetChecksDefinition (#17678)

add to api docs etc.
dagster-io · Nov 3, 2023 · b6d44e1 · b6d44e1 · github-actions · Nov 3, 2023
1 parent f837660
commit b6d44e1
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 5 deletions.
diff --git a/docs/content/concepts/assets/asset-checks.mdx b/docs/content/concepts/assets/asset-checks.mdx
@@ -165,7 +165,13 @@ If you want to define many checks that are similar, you can use the factory patt
 ```python file=/concepts/assets/asset_checks/factory.py
 from typing import Any, Mapping, Sequence
 
-from dagster import AssetCheckResult, Definitions, asset, asset_check
+from dagster import (
+    AssetCheckResult,
+    AssetChecksDefinition,
+    Definitions,
+    asset,
+    asset_check,
+)
 
 
 @asset
@@ -178,7 +184,9 @@ def items():
     ...
 
 
-def make_checks(check_blobs: Sequence[Mapping[str, str]]):
+def make_checks(
+    check_blobs: Sequence[Mapping[str, str]]
+) -> Sequence[AssetChecksDefinition]:
     checks = []
     for check_blob in check_blobs:
 

diff --git a/docs/sphinx/sections/api/apidocs/asset-checks.rst b/docs/sphinx/sections/api/apidocs/asset-checks.rst
@@ -21,4 +21,6 @@ Dagster allows you to define and execute checks on your software-defined assets.
 
 .. autofunction:: load_asset_checks_from_package_module
 
-.. autofunction:: load_asset_checks_from_package_name
+.. autofunction:: load_asset_checks_from_package_name
+
+.. autoclass:: AssetChecksDefinition
diff --git a/examples/docs_snippets/docs_snippets/concepts/assets/asset_checks/factory.py b/examples/docs_snippets/docs_snippets/concepts/assets/asset_checks/factory.py
@@ -1,6 +1,12 @@
 from typing import Any, Mapping, Sequence
 
-from dagster import AssetCheckResult, Definitions, asset, asset_check
+from dagster import (
+    AssetCheckResult,
+    AssetChecksDefinition,
+    Definitions,
+    asset,
+    asset_check,
+)
 
 
 @asset
@@ -13,7 +19,9 @@ def items():
     ...
 
 
-def make_checks(check_blobs: Sequence[Mapping[str, str]]):
+def make_checks(
+    check_blobs: Sequence[Mapping[str, str]]
+) -> Sequence[AssetChecksDefinition]:
     checks = []
     for check_blob in check_blobs:
 

diff --git a/python_modules/dagster/dagster/__init__.py b/python_modules/dagster/dagster/__init__.py
@@ -116,6 +116,7 @@
     AssetCheckSeverity as AssetCheckSeverity,
     AssetCheckSpec as AssetCheckSpec,
 )
+from dagster._core.definitions.asset_checks import AssetChecksDefinition as AssetChecksDefinition
 from dagster._core.definitions.asset_dep import AssetDep as AssetDep
 from dagster._core.definitions.asset_in import AssetIn as AssetIn
 from dagster._core.definitions.asset_out import AssetOut as AssetOut