feat: check for __all__ presence in __init__.py files

.github/workflows/main.yml

@@ -245,3 +245,20 @@ jobs:
           environments: ${{ matrix.package }}-generate-client
       - name: Run autorest
         run: pixi run -e ${{ matrix.package }}-generate-client generate-client
+
+  pre-commit:
+    name: pre-commit (with pixi)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: prefix-dev/setup-pixi@a0af7a228712d6121d37aba47adf55c1332c9c2e # v0.9.4
+        with:
+          run-install: false
+          post-cleanup: false
+      - uses: prefix-dev/setup-pixi@a0af7a228712d6121d37aba47adf55c1332c9c2e # v0.9.4
+        with:
+          cache: false
+          environments: pre-commit
+      - name: Run pre-commit
+        run: pixi run pre-commit run --all-files

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ default_language_version:
   python: python3
 
 ci:
-  skip: [generate-pixi-docs, settings-doc-check]
+  skip: [generate-pixi-docs, settings-doc-check, check-init-files]
 
 default_stages: [pre-commit]
 
@@ -90,7 +90,7 @@ repos:
     hooks:
       - id: generate-pixi-docs
         name: Generate pixi tasks documentation
-        entry: pixi run -e default python .github/workflows/generate_pixi_tasks_doc.py
+        entry: pixi run -e default python scripts/generate_pixi_tasks_doc.py
         language: system
         pass_filenames: false
         files: ^pixi\.toml$|^pixi\.lock$ # only run if pixi files change
@@ -103,3 +103,12 @@ repos:
         language: system
         pass_filenames: false
         files: ^(diracx-.*/src/diracx/.*/settings\.py|diracx-routers/src/diracx/routers/otel\.py|docs/.*\.j2|docs/templates/.*\.jinja|scripts/generate_settings_docs\.py)$
+
+  - repo: local
+    hooks:
+      - id: check-init-files
+        name: Check __all__ dunder in __init__.py files
+        language: system
+        entry: pixi run -e default python scripts/check_init_files_precommit_hook.py
+        files: ^(diracx-|extensions/gubbins/gubbins-)[a-z]+/src/[a-z]+/[a-z]+/((.*/)*__init__\.py|[a-zA-Z0-9_]+\.py)$
+        exclude: (test|_generated|__main__)

diracx-api/src/diracx/api/__init__.py

@@ -1,5 +1,3 @@
 from __future__ import annotations
 
-__all__ = ("jobs",)
-
-from . import jobs
+__all__ = []

diracx-api/src/diracx/api/jobs.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("create_sandbox", "download_sandbox")
+__all__ = ["create_sandbox", "download_sandbox"]
 
 import hashlib
 import logging

diracx-api/src/diracx/api/utils.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("with_client",)
+__all__ = ["with_client"]
 
 from functools import wraps
 

diracx-cli/src/diracx/cli/__init__.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
+__all__ = ["app"]
+
 from diracx.core.extensions import DiracEntryPoint, select_from_extension
 
 from .auth import app
 
-__all__ = ("app",)
-
-
 # Load all the sub commands
 cli_names = set(
     [

diracx-cli/src/diracx/cli/auth.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("app",)
+__all__ = ["app"]
 
 import asyncio
 import json

diracx-cli/src/diracx/cli/config.py

@@ -2,7 +2,7 @@
 # from __future__ import annotations
 from __future__ import annotations
 
-__all__ = ("dump",)
+__all__ = ["dump"]
 
 import json
 

diracx-cli/src/diracx/cli/internal/__init__.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
+__all__ = ["app"]
+
 from . import legacy
 from .config import app
 
-__all__ = ("app",)
-
 app.add_typer(legacy.app, name="legacy")

diracx-cli/src/diracx/cli/internal/config.py

@@ -8,9 +8,10 @@
 import yaml
 from pydantic import TypeAdapter
 
-from diracx.core.config import ConfigSource, ConfigSourceUrl
-from diracx.core.config.schema import (
+from diracx.core.config import (
     Config,
+    ConfigSource,
+    ConfigSourceUrl,
     DIRACConfig,
     GroupConfig,
     IdpConfig,

diracx-cli/src/diracx/cli/internal/legacy.py

@@ -16,11 +16,10 @@
 if TYPE_CHECKING:
     from diraccfg.cfg import CFGAsDict
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 from typer import Option
 
-from diracx.core.config import Config
-from diracx.core.config.schema import Field, SupportInfo
+from diracx.core.config import Config, SupportInfo
 from diracx.core.extensions import DiracEntryPoint, select_from_extension
 
 from ..utils import AsyncTyper

diracx-cli/src/diracx/cli/jobs.py

@@ -2,7 +2,7 @@
 # from __future__ import annotations
 from __future__ import annotations
 
-__all__ = ("app",)
+__all__ = ["app"]
 
 import json
 import re
@@ -13,7 +13,7 @@
 from typer import FileText, Option
 
 from diracx.client.aio import AsyncDiracClient
-from diracx.core.models.search import (
+from diracx.core.models import (
     ScalarSearchOperator,
     SearchSpec,
     VectorSearchOperator,

diracx-cli/src/diracx/cli/utils.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("AsyncTyper",)
+__all__ = ["AsyncTyper"]
 
 from asyncio import run
 from functools import wraps

diracx-cli/tests/legacy/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__all__ = []

diracx-cli/tests/legacy/cs_sync/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__all__ = []

diracx-cli/tests/legacy/cs_sync/test_cssync.py

@@ -6,7 +6,7 @@
 from typer.testing import CliRunner
 
 from diracx.cli import app
-from diracx.core.config.schema import Config
+from diracx.core.config import Config
 
 runner = CliRunner()
 

diracx-cli/tests/test_login.py

@@ -6,7 +6,7 @@
 
 
 async def test_login(monkeypatch, capfd, cli_env):
-    from diracx.testing import test_login
+    from diracx.testing.utils import test_login
 
     return await test_login(monkeypatch, capfd, cli_env)
 

diracx-client/src/diracx/client/__init__.py

@@ -1,15 +1,3 @@
 from __future__ import absolute_import
 
-__all__ = [
-    "aio",
-    "models",
-    "sync",
-]
-
-from typing import TYPE_CHECKING
-
-
-if TYPE_CHECKING:
-    from . import aio
-    from . import models
-    from . import sync
+__all__ = []

diracx-client/src/diracx/client/patches/auth/aio.py

@@ -14,7 +14,7 @@
 
 from azure.core.pipeline import PipelineResponse
 from azure.core.tracing.decorator_async import distributed_trace_async
-from diracx.core.models.auth import TokenResponse
+from diracx.core.models import TokenResponse
 
 from ..._generated.aio.operations._operations import (
     _models,

diracx-client/src/diracx/client/patches/client/common.py

@@ -20,7 +20,7 @@
 import jwt
 from azure.core.credentials import AccessToken
 from diracx.core.utils import EXPIRES_GRACE_SECONDS, serialize_credentials
-from diracx.core.models.auth import TokenResponse
+from diracx.core.models import TokenResponse
 
 
 class TokenStatus(Enum):

diracx-client/src/diracx/client/patches/jobs/common.py

@@ -16,7 +16,7 @@
 from io import BytesIO, IOBase
 from typing import Any, IO, Dict, TypedDict, Union, Unpack, cast, Literal
 
-from diracx.core.models.search import SearchSpec
+from diracx.core.models import SearchSpec
 
 
 class ResponseExtra(TypedDict, total=False):

diracx-client/src/diracx/client/patches/utils.py

@@ -22,7 +22,7 @@
 from azure.core.pipeline import PipelineRequest
 from azure.core.pipeline.policies import BearerTokenCredentialPolicy
 
-from diracx.core.models.auth import TokenResponse
+from diracx.core.models import TokenResponse
 from diracx.core.preferences import DiracxPreferences, get_diracx_preferences
 
 

diracx-client/tests/test_auth.py

@@ -9,7 +9,7 @@
 from azure.core.credentials import AccessToken
 
 from diracx.client.patches.utils import get_token
-from diracx.core.models.auth import TokenResponse
+from diracx.core.models import TokenResponse
 from diracx.core.utils import serialize_credentials
 
 # Create a fake jwt dictionary

diracx-core/src/diracx/core/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__all__ = []

diracx-core/src/diracx/core/config/__init__.py

@@ -2,20 +2,38 @@
 
 from __future__ import annotations
 
-from .schema import Config
-from .sources import (
-    ConfigSource,
-    ConfigSourceUrl,
-    LocalGitConfigSource,
-    RemoteGitConfigSource,
-    is_running_in_async_context,
-)
-
-__all__ = (
+__all__ = [
     "Config",
     "ConfigSource",
     "ConfigSourceUrl",
+    "DIRACConfig",
+    "GroupConfig",
+    "IdpConfig",
     "LocalGitConfigSource",
+    "OperationsConfig",
+    "RegistryConfig",
     "RemoteGitConfigSource",
+    "SerializableSet",
+    "SupportInfo",
+    "UserConfig",
     "is_running_in_async_context",
+]
+
+from .schema import (
+    Config,
+    DIRACConfig,
+    GroupConfig,
+    IdpConfig,
+    OperationsConfig,
+    RegistryConfig,
+    SerializableSet,
+    SupportInfo,
+    UserConfig,
+)
+from .sources import (
+    ConfigSource,
+    ConfigSourceUrl,
+    LocalGitConfigSource,
+    RemoteGitConfigSource,
+    is_running_in_async_context,
 )

diracx-core/src/diracx/core/config/schema.py

@@ -16,8 +16,8 @@
 )
 from pydantic.functional_serializers import PlainSerializer
 
-from ..properties import SecurityProperty
-from ..utils import recursive_merge
+from diracx.core.properties import SecurityProperty
+from diracx.core.utils import recursive_merge
 
 # By default the serialization of set doesn't have a well defined ordering so
 # we have to use a custom type to make sure the values are always sorted.

diracx-core/src/diracx/core/config/sources.py

@@ -20,9 +20,10 @@
 from cachetools import Cache, LRUCache
 from pydantic import AnyUrl, BeforeValidator, TypeAdapter, UrlConstraints
 
-from ..exceptions import BadConfigurationVersionError
-from ..extensions import DiracEntryPoint, select_from_extension
-from ..utils import TwoLevelCache
+from diracx.core.exceptions import BadConfigurationVersionError
+from diracx.core.extensions import DiracEntryPoint, select_from_extension
+from diracx.core.utils import TwoLevelCache
+
 from .schema import Config
 
 DEFAULT_CONFIG_FILE = "default.yml"

diracx-core/src/diracx/core/exceptions.py

@@ -1,5 +1,21 @@
 from __future__ import annotations
 
+__all__ = [
+    "AuthorizationError",
+    "DiracError",
+    "DiracHttpResponseError",
+    "IAMClientError",
+    "IAMServerError",
+    "InvalidCredentialsError",
+    "InvalidQueryError",
+    "NotReadyError",
+    "PendingAuthorizationError",
+    "SandboxAlreadyAssignedError",
+    "SandboxAlreadyInsertedError",
+    "SandboxNotFoundError",
+    "TokenNotFoundError",
+]
+
 from http import HTTPStatus
 
 

diracx-core/src/diracx/core/extensions.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 __all__ = [
+    "DiracEntryPoint",
     "extensions_by_priority",
     "select_from_extension",
     "supports_extending",
-    "DiracEntryPoint",
 ]
 
 from collections import defaultdict