Merge pull request #503 from martynia/janusz_main_repo_test_spell

fstagni · web-flow · commit 76ebeff46d4b · 2025-05-06T10:14:20.000+02:00
RepoReview:  spellchecker
diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
@@ -67,7 +67,7 @@ jobs:
         run: |
           set -xeuo pipefail
           IFS=$'\n\t'
-          # Needed for the advanced patter matching used in REFERENCE_BRANCH
+          # Needed for the advanced pattern matching used in REFERENCE_BRANCH
           PREV_VERSION=$(git describe --tags --abbrev=0)
           # In case of manual trigger,
           # GITHUB_REF is of the form refs/heads/main -> we want main
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -45,3 +45,10 @@ repos:
       additional_dependencies:
       - mdformat-gfm
       - mdformat-black
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+    - id: codespell
+      args: ["--skip=diracx-client/src/diracx/client/_generated/*, diracx-[a-z]*/tests/*, diracx-testing/*, build/*, extensions/gubbins/gubbins-client/src/gubbins/client/_generated/*, extensions/gubbins/gubbins-*/tests/*",
+      "--ignore-words-list=CheckIn", "-w"]
diff --git a/diracx-cli/src/diracx/cli/internal/legacy.py b/diracx-cli/src/diracx/cli/internal/legacy.py
@@ -96,7 +96,7 @@ def _apply_fixes(raw):
     raw["DIRAC"].pop("Framework", None)
     raw["DIRAC"].pop("Security", None)
 
-    # This is VOMS specific and no longer reqired
+    # This is VOMS specific and no longer required
     raw["DIRAC"].pop("ConnConf", None)
 
     # Setups are no longer supported
diff --git a/diracx-client/src/diracx/_client_importer.py b/diracx-client/src/diracx/_client_importer.py
@@ -241,12 +241,12 @@ def __init__(
     def exec_module(self, module):
         """Import an autorest generated module with two layers of patches."""
         # Import the real module and set its __name__ to the alias. This will
-        # then corrospond to the __init__.py file + the _patch.py file from
+        # then correspond to the __init__.py file + the _patch.py file from
         # plain DiracX. When calling self.original_loader.exec_module it will:
         # 1. Import the real module (e.g. aio/__init__.py)
         # 2. Import any submodules (e.g. _operations)
         # 3. Import the patch module from plain DiracX (e.g. _patch.py,
-        #    overriden by the DiracXPathFinder)
+        #    overridden by the DiracXPathFinder)
         # 4. Replace the submodules module's objects with anything in ._patch.__all__
         super().exec_module(module)
 
diff --git a/diracx-client/src/diracx/client/_generated/aio/operations/_operations.py b/diracx-client/src/diracx/client/_generated/aio/operations/_operations.py
@@ -380,7 +380,7 @@ async def do_device_flow(self, *, user_code: str, **kwargs: Any) -> Any:
     async def finish_device_flow(self, *, code: str, state: str, **kwargs: Any) -> Any:
         """Finish Device Flow.
 
-        This the url callbacked by IAM/Checkin after the authorization
+        This the url callbacked by IAM/CheckIn after the authorization
         flow was granted.
         It gets us the code we need for the authorization flow, and we
         can map it to the corresponding device flow using the user_code
diff --git a/diracx-client/src/diracx/client/_generated/operations/_operations.py b/diracx-client/src/diracx/client/_generated/operations/_operations.py
@@ -980,7 +980,7 @@ def do_device_flow(self, *, user_code: str, **kwargs: Any) -> Any:
     def finish_device_flow(self, *, code: str, state: str, **kwargs: Any) -> Any:
         """Finish Device Flow.
 
-        This the url callbacked by IAM/Checkin after the authorization
+        This the url callbacked by IAM/CheckIn after the authorization
         flow was granted.
         It gets us the code we need for the authorization flow, and we
         can map it to the corresponding device flow using the user_code
diff --git a/diracx-client/src/diracx/client/patches/client/common.py b/diracx-client/src/diracx/client/patches/client/common.py
@@ -132,7 +132,7 @@ def refresh_token(
 
     if response.status_code != 200:
         raise RuntimeError(
-            f"An issue occured while refreshing your access token: {response.json()['detail']}"
+            f"An issue occurred while refreshing your access token: {response.json()['detail']}"
         )
 
     res = response.json()
diff --git a/diracx-client/src/diracx/client/patches/utils.py b/diracx-client/src/diracx/client/patches/utils.py
@@ -135,7 +135,7 @@ def refresh_token(
 
     if response.status_code != 200:
         raise RuntimeError(
-            f"An issue occured while refreshing your access token: {response.json()['detail']}"
+            f"An issue occurred while refreshing your access token: {response.json()['detail']}"
         )
 
     res = response.json()
diff --git a/diracx-core/src/diracx/core/utils.py b/diracx-core/src/diracx/core/utils.py
@@ -188,7 +188,7 @@ def get(self, key: str, populate_func: Callable[[], T], blocking: bool = True) -
                 self.locks[key].release()
             if blocking:
                 # It is critical that ``future`` is waited for outside of the lock
-                # as _work aquires the lock before filling the caches. This also
+                # as _work acquires the lock before filling the caches. This also
                 # means we can guarantee that the future has not yet been removed
                 # from the futures dict.
                 wait([future])
diff --git a/diracx-db/src/diracx/db/sql/job/db.py b/diracx-db/src/diracx/db/sql/job/db.py
@@ -50,7 +50,7 @@ class JobDB(BaseSQLDB):
     }
 
     # TODO: this is copied from the DIRAC JobDB
-    # but is overwriten in LHCbDIRAC, so we need
+    # but is overwritten in LHCbDIRAC, so we need
     # to find a way to make it dynamic
     jdl_2_db_parameters = ["JobName", "JobType", "JobGroup"]
 
diff --git a/diracx-db/src/diracx/db/sql/job_logging/schema.py b/diracx-db/src/diracx/db/sql/job_logging/schema.py
@@ -44,7 +44,7 @@ def process_result_value(self, value, dialect):
         """
         if value is None:
             return None
-        # Carefully convert from Decimal to datetime to avoid loosing precision
+        # Carefully convert from Decimal to datetime to avoid losing precision
         value += self.MAGIC_EPOC_NUMBER
         value_int = int(value)
         result = datetime.fromtimestamp(value_int, tz=UTC)
diff --git a/diracx-db/src/diracx/db/sql/sandbox_metadata/db.py b/diracx-db/src/diracx/db/sql/sandbox_metadata/db.py
@@ -128,7 +128,7 @@ async def assign_sandbox_to_jobs(
         sb_type: SandboxType,
         se_name: str,
     ) -> None:
-        """Mapp sandbox and jobs."""
+        """Map sandbox and jobs."""
         for job_id in jobs_ids:
             # Define the entity id as 'Entity:entity_id' due to the DB definition:
             entity_id = self.jobid_to_entity_id(job_id)
diff --git a/diracx-db/src/diracx/db/sql/task_queue/db.py b/diracx-db/src/diracx/db/sql/task_queue/db.py
@@ -56,7 +56,7 @@ async def get_task_queue_owners_by_group(self, group: str) -> dict[str, int]:
         )
         rows = await self.conn.execute(stmt)
         # Get owners in this group and the amount of times they appear
-        # TODO: I guess the rows are already a list of tupes
+        # TODO: I guess the rows are already a list of tuples
         # maybe refactor
         return {r[0]: r[1] for r in rows if r}
 
@@ -108,7 +108,7 @@ async def set_priorities_for_entity(
         tq_ids: list[int],
         priority: float,
     ):
-        """Set the priority for a user/userGroup combo given a splitted share."""
+        """Set the priority for a user/userGroup combo given a split share."""
         update_stmt = (
             update(TaskQueues)
             .where(TaskQueues.TQId.in_(tq_ids))
diff --git a/diracx-db/src/diracx/db/sql/utils/base.py b/diracx-db/src/diracx/db/sql/utils/base.py
@@ -51,7 +51,7 @@ class BaseSQLDB(metaclass=ABCMeta):
     of the same database. To list the available implementations use
     `BaseSQLDB.available_implementations(db_name)`. The first entry in this list
     will be the preferred implementation and it can be initialized by calling
-    it's `__init__` function with a URL perviously obtained from
+    it's `__init__` function with a URL previously obtained from
     `BaseSQLDB.available_urls`.
 
     To control the lifetime of the SQLAlchemy engine used for connecting to the
diff --git a/diracx-logic/src/diracx/logic/auth/device_flow.py b/diracx-logic/src/diracx/logic/auth/device_flow.py
@@ -82,7 +82,7 @@ async def finish_device_flow(
     config: Config,
     settings: AuthSettings,
 ):
-    """This the url callbacked by IAM/Checkin after the authorization
+    """This the url callbacked by IAM/CheckIn after the authorization
     flow was granted.
     """
     decrypted_state = decrypt_state(state, settings.state_key.fernet)
diff --git a/diracx-logic/src/diracx/logic/auth/utils.py b/diracx-logic/src/diracx/logic/auth/utils.py
@@ -233,7 +233,7 @@ def parse_and_validate_scope(
     return dict with group and properties.
 
     :raises:
-        * ValueError in case the scope isn't valide
+        * ValueError in case the scope isn't valid
     """
     scopes = set(scope.split(" "))
 
diff --git a/diracx-logic/src/diracx/logic/jobs/query.py b/diracx-logic/src/diracx/logic/jobs/query.py
@@ -52,7 +52,7 @@ async def search(
                 "parameter": "Owner",
                 "operator": ScalarSearchOperator.EQUAL,
                 # TODO-385: https://github.com/DIRACGrid/diracx/issues/385
-                # The value shoud be user_info.sub,
+                # The value should be user_info.sub,
                 # but since we historically rely on the preferred_username
                 # we will keep using the preferred_username for now.
                 "value": preferred_username,
@@ -91,7 +91,7 @@ async def summary(
                 "parameter": "Owner",
                 "operator": ScalarSearchOperator.EQUAL,
                 # TODO-385: https://github.com/DIRACGrid/diracx/issues/385
-                # The value shoud be user_info.sub,
+                # The value should be user_info.sub,
                 # but since we historically rely on the preferred_username
                 # we will keep using the preferred_username for now.
                 "value": preferred_username,
diff --git a/diracx-logic/src/diracx/logic/task_queues/priority.py b/diracx-logic/src/diracx/logic/task_queues/priority.py
@@ -80,7 +80,7 @@ async def set_priorities_for_entity(
     task_queue_db: TaskQueueDB,
     owner: str | None = None,
 ):
-    """Set the priority for a user/userGroup combo given a splitted share."""
+    """Set the priority for a user/userGroup combo given a split share."""
     tq_dict = await task_queue_db.get_task_queue_priorities(owner_group, owner)
     if not tq_dict:
         return
diff --git a/diracx-routers/src/diracx/routers/auth/device_flow.py b/diracx-routers/src/diracx/routers/auth/device_flow.py
@@ -167,7 +167,7 @@ async def finish_device_flow(
     config: Config,
     settings: AuthSettings,
 ) -> RedirectResponse:
-    """This the url callbacked by IAM/Checkin after the authorization
+    """This the url callbacked by IAM/CheckIn after the authorization
     flow was granted.
     It gets us the code we need for the authorization flow, and we
     can map it to the corresponding device flow using the user_code
diff --git a/diracx-routers/src/diracx/routers/factory.py b/diracx-routers/src/diracx/routers/factory.py
@@ -19,7 +19,7 @@
 import dotenv
 from cachetools import TTLCache
 from fastapi import APIRouter, Depends, FastAPI, HTTPException, Request, status
-from fastapi.dependencies.models import Dependant
+from fastapi.dependencies.models import Dependant  # codespell:ignore dependant
 from fastapi.exception_handlers import request_validation_exception_handler
 from fastapi.exceptions import RequestValidationError
 from fastapi.middleware.cors import CORSMiddleware
@@ -110,7 +110,7 @@ def create_app_inner(
 ) -> DiracFastAPI:
     """This method does the heavy lifting work of putting all the pieces together.
 
-    When starting the application normaly, this method is called by create_app,
+    When starting the application normally, this method is called by create_app,
     and the values of the parameters are taken from environment variables or
     entrypoints.
 
@@ -173,7 +173,7 @@ def create_app_inner(
         # This means vanilla DiracX routers get an instance of the extension's AccessPolicy
         for access_policy_class in access_policy_classes:
             # Here we do not check that access_policy_class.check is
-            # not already in the dependency_overrides becaue the same
+            # not already in the dependency_overrides because the same
             # policy could be used for multiple purpose
             # (e.g. open access)
             # assert access_policy_class.check not in app.dependency_overrides
@@ -436,14 +436,16 @@ async def validation_error_handler(request: Request, exc: RequestValidationError
 
 
 def find_dependents(
-    obj: APIRouter | Iterable[Dependant], cls: type[T]
+    obj: APIRouter | Iterable[Dependant], cls: type[T]  # codespell:ignore dependant
 ) -> Iterable[type[T]]:
     if isinstance(obj, APIRouter):
         # TODO: Support dependencies of the router itself
         # yield from find_dependents(obj.dependencies, cls)
         for route in obj.routes:
             if isinstance(route, APIRoute):
-                yield from find_dependents(route.dependant.dependencies, cls)
+                yield from find_dependents(
+                    route.dependant.dependencies, cls  # codespell:ignore dependant
+                )
         return
 
     for dependency in obj:
@@ -458,7 +460,7 @@ def find_dependents(
 
 async def is_db_unavailable(db: BaseSQLDB | BaseOSDB) -> str:
     """Cache the result of pinging the DB
-    (exceptions are not cachable).
+    (exceptions are not cacheable).
     """
     if db not in _db_alive_cache:
         try:
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -26,7 +26,7 @@ These headers can be used to efficiently check for updates without needing to do
 ## Modifying configuration
 
 Currently the canonical source of configuration is from the legacy DIRAC Configuration Service.
-We forsee this will continue to be the case until the migration from DIRAC -> DiracX is complete.
+We foresee this will continue to be the case until the migration from DIRAC -> DiracX is complete.
 During this time, the DiracX configuration is not intended to be edited directly.
 The DiracX `default.yml` file differs in structure and contents from the legacy DIRAC Configuration Service.
 The legacy DIRAC CFG file can be converted into the new YAML format with:
diff --git a/docs/DATABASES.md b/docs/DATABASES.md
@@ -15,7 +15,7 @@ For convenience SQLite is used for testing and development however this should n
 
 Connections to DiracX DBs are configured using the [SQLAlchemy connection URL format](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls).
 DiracX requires that the `driver` part of the URL is always specified and it must refer to an async-compatible backend.
-The value of this URL is taken from the environment vairable of the form `DIRACX_DB_URL_<db-name>`, where `<db-name>` is defined by the entry in the `diracx.dbs.sql` entrypoint in the `pyproject.toml`.
+The value of this URL is taken from the environment variable of the form `DIRACX_DB_URL_<db-name>`, where `<db-name>` is defined by the entry in the `diracx.dbs.sql` entrypoint in the `pyproject.toml`.
 
 ```bash
 export DIRACX_DB_URL_MYDB="mysql+aiomysql://user:pass@hostname:3306/MyDB"
diff --git a/docs/OPENTELEMETRY.md b/docs/OPENTELEMETRY.md
@@ -2,9 +2,8 @@
 
 > :warning: **Experimental**: opentelemetry is an evolving product, and so is our implementation of it.
 
-`diracx` is capable of sending [OpenTelemetry](https://opentelemetry.io/) data to a collector. The settings are controled by the
+`diracx` is capable of sending [OpenTelemetry](https://opentelemetry.io/) data to a collector. The settings are controlled by the
 `diracx.routers.otel.OTELSettings` classes
-
 `diracx` will then export metrics, traces, and logs. For the moment, nothing is really instrumented, but the infrastructure is there
 
 ![OTEL Logs](./otel-logs.png)
diff --git a/extensions/README.md b/extensions/README.md
@@ -205,7 +205,7 @@ Note that even if you have your own `testing` package depending on `diracx-testi
 
 Working on this test extension is tricky as it is a subdirectory. if you want to debug it you need to:
 
-- buid the `gubbins` docker images (or download an art)
+- build the `gubbins` docker images (or download an art)
 - copy the files somewhere else
 - edit the pyproject
 - run_demo
diff --git a/extensions/gubbins/gubbins-client/src/gubbins/client/_generated/aio/operations/_operations.py b/extensions/gubbins/gubbins-client/src/gubbins/client/_generated/aio/operations/_operations.py
@@ -387,7 +387,7 @@ async def do_device_flow(self, *, user_code: str, **kwargs: Any) -> Any:
     async def finish_device_flow(self, *, code: str, state: str, **kwargs: Any) -> Any:
         """Finish Device Flow.
 
-        This the url callbacked by IAM/Checkin after the authorization
+        This the url callbacked by IAM/CheckIn after the authorization
         flow was granted.
         It gets us the code we need for the authorization flow, and we
         can map it to the corresponding device flow using the user_code
diff --git a/extensions/gubbins/gubbins-client/src/gubbins/client/_generated/operations/_operations.py b/extensions/gubbins/gubbins-client/src/gubbins/client/_generated/operations/_operations.py
@@ -1033,7 +1033,7 @@ def do_device_flow(self, *, user_code: str, **kwargs: Any) -> Any:
     def finish_device_flow(self, *, code: str, state: str, **kwargs: Any) -> Any:
         """Finish Device Flow.
 
-        This the url callbacked by IAM/Checkin after the authorization
+        This the url callbacked by IAM/CheckIn after the authorization
         flow was granted.
         It gets us the code we need for the authorization flow, and we
         can map it to the corresponding device flow using the user_code
diff --git a/extensions/gubbins/gubbins-db/src/gubbins/db/sql/jobs/db.py b/extensions/gubbins/gubbins-db/src/gubbins/db/sql/jobs/db.py
@@ -24,7 +24,7 @@ async def get_job_jdls(  # type: ignore[override]
         self, job_ids, original: bool = False, with_info=False
     ) -> dict:
         """
-        This method modifes the one in the parent class:
+        This method modifies the one in the parent class:
         * adds an extra argument
         * changes the return type
 
diff --git a/extensions/gubbins/pyproject.toml b/extensions/gubbins/pyproject.toml
@@ -43,7 +43,7 @@ profile = "black"
 
 [tool.ruff.lint]
 select = [
-    "E",   # pycodestyle errrors
+    "E",   # pycodestyle errors
     "F",   # pyflakes
     "B",   # flake8-bugbear
     "I",   # isort
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,7 @@ exclude = [
 
 [tool.ruff.lint]
 select = [
-    "E",   # pycodestyle errrors
+    "E",   # pycodestyle errors
     "F",   # pyflakes
     "B",   # flake8-bugbear
     "I",   # isort
diff --git a/run_local.sh b/run_local.sh
@@ -79,7 +79,7 @@ function cleanup(){
   trap - SIGTERM
   kill $moto_pid
   kill $diracx_pid
-  echo "Waiting for proccesses to exit"
+  echo "Waiting for processes to exit"
   wait $moto_pid $diracx_pid
   echo "Cleaning up"
   rm -rf "${tmp_dir}"
diff --git a/security_model.md b/security_model.md
@@ -74,7 +74,7 @@ DiracX is built around the OAuth 2.0 authorisation flow, with the exception that
 - Enforcing user/group-specific quotas on compute and storage resources
 - Allowing for easier traceability
 
-For communication between users and DiracX services JSON Web Tokens (JWTs) are used as OAuth2 bearer tokens. The same mechanism is used whenever impersonation is required, such as running a user-provided payload in a job. The need to use encrypted JWT is not forseen.
+For communication between users and DiracX services JSON Web Tokens (JWTs) are used as OAuth2 bearer tokens. The same mechanism is used whenever impersonation is required, such as running a user-provided payload in a job. The need to use encrypted JWT is not foreseen.
 
 ### User and group management
 
@@ -105,7 +105,7 @@ These fields are requested using the `scope` parameter when initiating the OAuth
 
 DiracX exclusively uses asymmetric cryptography for signing tokens. It follows the current best practices for algorithms and key lengths and supports multiple active keys at the same time to facilitate key rotation. The time required before the key can be invalidated without disruption is related to the installation configured access token duration.
 
-The JSON Web Keys required for verifying tokens are publically exposed according to OIDC standards.
+The JSON Web Keys required for verifying tokens are publicly exposed according to OIDC standards.
 
 ### Issuance
 
@@ -144,7 +144,7 @@ All flows involving the external IdP follow the same sequence:
 
 ### Pilot jobs
 
-Pilots are submitted with a unique secret which can be used to start the pilot. This secret is hashed and registered in a database and can only be used to start a pilot only once. In special cases (such as Vaccum) a secret can be registered in the database manually by an installation admin for use with multiple pilots.
+Pilots are submitted with a unique secret which can be used to start the pilot. This secret is hashed and registered in a database and can only be used to start a pilot only once. In special cases (such as Vacuum) a secret can be registered in the database manually by an installation admin for use with multiple pilots.
 
 This initial secret is exchanged for a credential that can be used for pilot-specific activities, such as matching jobs or uploading pilot logging information, henceforth referred to as the pilot-matching secret.
 

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ def refresh_token(`
`132`	`132`
`133`	`133`	`if response.status_code != 200:`
`134`	`134`	`raise RuntimeError(`
`135`		`- f"An issue occured while refreshing your access token: {response.json()['detail']}"`
	`135`	`+ f"An issue occurred while refreshing your access token: {response.json()['detail']}"`
`136`	`136`	`)`
`137`	`137`
`138`	`138`	`res = response.json()`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ def refresh_token(`
`135`	`135`
`136`	`136`	`if response.status_code != 200:`
`137`	`137`	`raise RuntimeError(`
`138`		`- f"An issue occured while refreshing your access token: {response.json()['detail']}"`
	`138`	`+ f"An issue occurred while refreshing your access token: {response.json()['detail']}"`
`139`	`139`	`)`
`140`	`140`
`141`	`141`	`res = response.json()`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class JobDB(BaseSQLDB):`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`# TODO: this is copied from the DIRAC JobDB`
`53`		`- # but is overwriten in LHCbDIRAC, so we need`
	`53`	`+ # but is overwritten in LHCbDIRAC, so we need`
`54`	`54`	`# to find a way to make it dynamic`
`55`	`55`	`jdl_2_db_parameters = ["JobName", "JobType", "JobGroup"]`
`56`	`56`