Detect invalid examples in class docstrings (mlflow#14476)

Signed-off-by: harupy <[email protected]>

Author: harupy

dev/clint/src/clint/linter.py

@@ -277,11 +277,14 @@ def _is_in_test(self) -> bool:
     def visit_ClassDef(self, node: ast.ClassDef) -> None:
         self.stack.append(node)
         self._no_rst(node)
+        self._syntax_error_example(node)
         self._mlflow_class_name(node)
         self.generic_visit(node)
         self.stack.pop()
 
-    def _syntax_error_example(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> None:
+    def _syntax_error_example(
+        self, node: ast.FunctionDef | ast.AsyncFunctionDef | ast.ClassDef
+    ) -> None:
         if docstring_node := self._docstring(node):
             for code_block in _iter_code_blocks(docstring_node.value):
                 try:

mlflow/pyfunc/dbconnect_artifact_cache.py

@@ -27,10 +27,11 @@ class DBConnectArtifactCache:
         db_artifact_cache = DBConnectArtifactCache.get_or_create()
         db_artifact_cache.add_artifact_archive("archive1", "/tmp/archive1.tar.gz")
 
+
         @pandas_udf(...)
-        def my_udf(...):
-           # we can get the unpacked archive files in `archive1_unpacked_dir`
-           archive1_unpacked_dir = db_artifact_cache.get("archive1")
+        def my_udf(x):
+            # we can get the unpacked archive files in `archive1_unpacked_dir`
+            archive1_unpacked_dir = db_artifact_cache.get("archive1")
     """
 
     _global_cache = None