darglint becomes pydoclint

.github/workflows/ci-fast.yml

@@ -14,23 +14,6 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
-  docstring-check:
-    if: github.event.pull_request.draft == false
-    runs-on: arc-runner-set
-    steps:
-      - name: Checkout code
-        uses: actions/[email protected]
-      - name: Set up Python
-        uses: actions/[email protected]
-        with:
-          python-version: '3.10'
-      - name: Install darglint using uv
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          source $HOME/.cargo/env
-          uv pip install --system darglint
-      - name: Check docstrings
-        run: bash scripts/docstring.sh
   sqlite-db-migration-testing-random:
     runs-on: arc-runner-set
     env:

.github/workflows/ci-slow.yml

@@ -39,23 +39,6 @@ jobs:
         run: |
           echo "Please add the 'run-slow-ci' label to this PR before merging."
           exit 1
-  docstring-check:
-    if: github.event.pull_request.draft == false
-    needs: run-slow-ci-label-is-set
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/[email protected]
-      - name: Set up Python
-        uses: actions/[email protected]
-        with:
-          python-version: '3.10'
-      - name: Install current package as editable
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          source $HOME/.cargo/env
-          uv pip install --system darglint
-      - name: Check docstrings
-        run: bash scripts/docstring.sh
   mysql-db-migration-testing-full:
     if: github.event.pull_request.draft == false
     needs: run-slow-ci-label-is-set

pyproject.toml

@@ -131,7 +131,7 @@ pyment = { version = "^0.3.3", optional = true }
 tox = { version = "^3.24.3", optional = true }
 hypothesis = { version = "^6.43.1", optional = true }
 typing-extensions = { version = ">=3.7.4", optional = true }
-darglint = { version = "^1.8.1", optional = true }
+pydoclint = { version = "^0.5.7", optional = true }
 ruff = { version = ">=0.1.7", optional = true }
 yamlfix = { version = "^1.16.0", optional = true }
 maison = { version = "<2.0", optional = true }
@@ -225,7 +225,7 @@ dev = [
     "tox",
     "hypothesis",
     "typing-extensions",
-    "darglint",
+    "pydoclint",
     "pytest-randomly",
     "pytest-mock",
     "pytest-clarity",
@@ -374,6 +374,14 @@ max-complexity = 18
 # Use Google-style docstrings.
 convention = "google"
 
+[tool.pydoclint]
+style = 'google'
+arg-type-hints-in-docstring = false
+check-return-types = false
+check-arg-order = false
+allow-init-docstring = true
+check-class-attributes = false
+
 [tool.mypy]
 
 plugins = ["pydantic.mypy"]

scripts/install-zenml-dev.sh

@@ -70,6 +70,17 @@ install_integrations() {
 
     uv pip install $PIP_ARGS -r integration-requirements.txt
     rm integration-requirements.txt
+
+    # TODO: remove after testing this in the CI
+    # shows what is installing docstring-parser
+    uv pip install $PIP_ARGS pipdeptree
+    pipdeptree -r -p docstring-parser
+    uv pip uninstall $PIP_ARGS pipdeptree -y
+
+    # to avoid conflicts with the one installed 
+    # by pydoclint (i.e. docstring-parser-fork)
+    uv pip uninstall docstring-parser -y
+
 }
 
 set -x

scripts/lint.sh

@@ -38,5 +38,8 @@ ruff check $SRC --select F401,F841 --exclude "__init__.py" --exclude "*.ipynb" -
 
 ruff format $SRC  --check
 
+# pydoclint docstring linter
+pydoclint -q $SRC_NO_TESTS
+
 # check type annotations
 mypy $SRC_NO_TESTS

scripts/run-ci-checks.sh

@@ -7,4 +7,3 @@ export ZENML_ANALYTICS_OPT_IN=false
 
 scripts/lint.sh
 scripts/check-spelling.sh
-scripts/docstring.sh

src/zenml/analytics/utils.py

@@ -232,6 +232,8 @@ def __exit__(
             value: The instance of the exception
             traceback: The traceback of the exception
 
+        Returns:
+            None
         """
         if traceback is not None:
             self.metadata.update({"event_success": False})

src/zenml/artifact_stores/base_artifact_store.py

@@ -54,14 +54,6 @@ class _sanitize_paths:
 
     Extra decoration layer is needed to pass in fixed artifact store root
     path for static methods that are called on filesystems directly.
-
-    Args:
-        func: The function to decorate.
-        fixed_root_path: The fixed artifact store root path.
-        is_static: Whether the function is static or not.
-
-    Returns:
-        Function that calls the input function with sanitized path inputs.
     """
 
     def __init__(self, func: Callable[..., Any], fixed_root_path: str) -> None:

src/zenml/artifacts/external_artifact_config.py

@@ -61,9 +61,8 @@ def get_artifact_version_id(self) -> UUID:
 
         Raises:
             RuntimeError: If the artifact store of the referenced artifact
-                is not the same as the one in the active stack.
-            RuntimeError: If neither the ID nor the name of the artifact was
-                provided.
+                is not the same as the one in the active stack or if neither the
+                ID nor the name of the artifact was provided.
         """
         from zenml.client import Client
 

src/zenml/artifacts/utils.py

@@ -773,7 +773,7 @@ def _load_file_from_artifact_store(
     Raises:
         DoesNotExistException: If the file does not exist in the artifact store.
         NotImplementedError: If the artifact store cannot open the file.
-        IOError: If the artifact store rejects the request.
+        e: If the artifact store rejects the request.
     """
     try:
         with artifact_store.open(uri, mode) as text_file:

src/zenml/cli/cli.py

@@ -51,7 +51,7 @@ def __init__(
             name: The name of the group.
             tag: The tag of the group.
             commands: The commands of the group.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
         """
         super(TagGroup, self).__init__(name, commands, **kwargs)
         self.tag = tag or CliCategories.OTHER_COMMANDS

src/zenml/cli/formatter.py

@@ -47,7 +47,7 @@ def iter_rows(
         col_count: The number of columns in the table.
 
     Yields:
-        An iterator over the rows of the table.
+        Tuple[str, ...]: A row of the table, padded with empty strings if necessary.
     """
     for row in rows:
         yield row + ("",) * (col_count - len(row))

src/zenml/cli/secret.py

@@ -170,7 +170,7 @@ def list_secrets(**kwargs: Any) -> None:
     """List all secrets that fulfill the filter criteria.
 
     Args:
-        kwargs: Keyword arguments to filter the secrets.
+        **kwargs: Keyword arguments to filter the secrets.
     """
     client = Client()
     with console.status("Listing secrets..."):

src/zenml/cli/service_accounts.py

@@ -188,11 +188,11 @@ def describe_service_account(service_account_name_or_id: str) -> None:
 @list_options(ServiceAccountFilter)
 @click.pass_context
 def list_service_accounts(ctx: click.Context, **kwargs: Any) -> None:
-    """List all users.
+    """List service accounts.
 
     Args:
-        ctx: The click context object
-        kwargs: Keyword arguments to filter the list of users.
+        ctx: The click context.
+        **kwargs: Keyword arguments to filter the service accounts.
     """
     client = Client()
     with console.status("Listing service accounts...\n"):

src/zenml/cli/service_connectors.py

@@ -985,7 +985,7 @@ def list_service_connectors(
     Args:
         ctx: The click context object
         labels: Labels to filter by.
-        kwargs: Keyword arguments to filter the components.
+        **kwargs: Keyword arguments to filter the components.
     """
     client = Client()
 
@@ -1432,8 +1432,7 @@ def update_service_connector(
         auth_method_spec = connector_type_spec.auth_method_dict[auth_method]
 
         # If the authentication method has changed, we need to reconfigure
-        # the connector from scratch; otherwise, we ask the user if they
-        # want to update the existing configuration
+        # the connector or update the existing configuration
         if auth_method != connector.auth_method:
             confirm = True
         else:

src/zenml/cli/stack.py

@@ -32,6 +32,7 @@
 from uuid import UUID
 
 import click
+from click import Abort, BadParameter
 from rich.console import Console
 from rich.markdown import Markdown
 from rich.prompt import Confirm
@@ -960,12 +961,15 @@ def rename_stack(
 @stack.command("list")
 @list_options(StackFilter)
 @click.pass_context
-def list_stacks(ctx: click.Context, **kwargs: Any) -> None:
+def list_stacks(
+    ctx: click.Context,
+    **kwargs: Any,
+) -> None:
     """List all stacks that fulfill the filter requirements.
 
     Args:
         ctx: the Click context
-        kwargs: Keyword arguments to filter the stacks.
+        **kwargs: Keyword arguments to filter the stacks.
     """
     client = Client()
     with console.status("Listing stacks...\n"):
@@ -1604,12 +1608,12 @@ def validate_name(ctx: click.Context, param: str, value: str) -> str:
         return value
 
     if not re.match(r"^[a-zA-Z0-9-]*$", value):
-        raise click.BadParameter(
+        raise BadParameter(
             "Stack name must contain only alphanumeric characters and hyphens."
         )
 
     if len(value) > 16:
-        raise click.BadParameter(
+        raise BadParameter(
             "Stack name must have a maximum length of 16 characters."
         )
 
@@ -1754,7 +1758,7 @@ def deploy(
             f"automatically redirected to "
             f"{deployment_config.deployment_url_text} in your browser.",
         ):
-            raise click.Abort()
+            raise Abort()
 
         date_start = datetime.utcnow()
 
@@ -2130,8 +2134,9 @@ def deploy_mlstack(
 
 
 @stack.command(
+    "destroy",
     help="Destroy stack components created previously with "
-    "`zenml stack deploy`"
+    "`zenml stack deploy`",
 )
 @click.argument("stack_name", required=True)
 @click.option(
@@ -2393,8 +2398,7 @@ def _get_stack_component_info(
         The info model of the stack component.
 
     Raises:
-        ValueError: If the cloud provider is not supported.
-        ValueError: If the component type is not supported.
+        ValueError: If the cloud provider or component type is not supported.
     """
     from rich.prompt import Prompt
 

src/zenml/cli/stack_components.py

@@ -175,8 +175,8 @@ def list_stack_components_command(
         """Prints a table of stack components.
 
         Args:
-            ctx: The click context object
-            kwargs: Keyword arguments to filter the components.
+            ctx: The click context object.
+            **kwargs: Keyword arguments to filter the components.
         """
         client = Client()
         with console.status(f"Listing {component_type.plural}..."):
@@ -2019,7 +2019,7 @@ def connect_stack_component_with_service_connector(
                 f"'{component_model.name}' {display_name} in your "
                 f"workspace. {additional_info}You can create a new "
                 "connector using the 'zenml service-connector register' "
-                "command or list the compatible resources using the "
+                f"command or list the compatible resources using the "
                 f"'zenml service-connector list-resources{command_args}' "
                 "command."
             )

src/zenml/cli/text_utils.py

@@ -13,7 +13,7 @@
 #  permissions and limitations under the License.
 """Utilities for CLI output."""
 
-from typing import List
+from typing import Generator, List
 
 from rich.console import Console, ConsoleOptions, RenderResult
 from rich.markdown import Heading, Markdown
@@ -91,15 +91,15 @@ class OldSchoolMarkdownHeading(Heading):
 
     def __rich_console__(
         self, console: Console, options: ConsoleOptions
-    ) -> RenderResult:
-        """Render the heading.
+    ) -> Generator[RenderResult, None, None]:
+        """Render the heading to the console.
 
         Args:
-            console: The console rendering the content.
+            console: The console to render to.
             options: The console options.
 
         Yields:
-            RenderResult: The rendered content.
+            RenderResult: The rendered heading.
         """
         text = self.text
         text.justify = "left"

src/zenml/cli/user_management.py

@@ -84,7 +84,7 @@ def list_users(ctx: click.Context, **kwargs: Any) -> None:
 
     Args:
         ctx: The click context object
-        kwargs: Keyword arguments to filter the list of users.
+        **kwargs: Keyword arguments to filter the list of users.
     """
     client = Client()
     with console.status("Listing stacks...\n"):

src/zenml/cli/utils.py

@@ -42,6 +42,7 @@
 import click
 import pkg_resources
 import yaml
+from click import ClickException
 from pydantic import BaseModel, SecretStr
 from rich import box, table
 from rich.console import Console
@@ -163,7 +164,7 @@ def error(text: str) -> NoReturn:
     Raises:
         ClickException: when called.
     """
-    raise click.ClickException(message=click.style(text, fg="red", bold=True))
+    raise ClickException(message=click.style(text, fg="red", bold=True))
 
 
 def warning(
@@ -222,7 +223,7 @@ def print_table(
         obj: A List containing dictionaries.
         title: Title of the table.
         caption: Caption of the table.
-        columns: Optional column configurations to be used in the table.
+        **columns: Optional column configurations to be used in the table.
     """
     column_keys = {key: None for dict_ in obj for key in dict_}
     column_names = [columns.get(key, key.upper()) for key in column_keys]
@@ -2635,7 +2636,7 @@ def temporary_active_stack(
             this contextmanager will not do anything.
 
     Yields:
-        The active stack.
+        Stack: The active stack.
     """
     from zenml.client import Client