Merge pull request #731 from fractal-analytics-platform/union-types

Write union types as `X | Y`

docs/gen_ref_pages.py

@@ -2,7 +2,6 @@
 from pathlib import Path
 from textwrap import fill
 from typing import Any
-from typing import Optional
 
 import mkdocs_gen_files  # type: ignore[import]
 from mkdocs_gen_files import Nav
@@ -17,7 +16,7 @@
 def to_markdown(
     data: dict[str, Any],
     level: int,
-    parent_cmd: Optional[str] = None,
+    parent_cmd: str | None = None,
 ) -> str:
     """
     Given a `data` object with keys `name`, `description` and `usage`, produce

fractal_client/client.py

@@ -16,7 +16,6 @@
 from sys import argv
 from typing import List
 from typing import Tuple
-from typing import Union
 
 from httpx import Client
 from httpx import ConnectError
@@ -34,7 +33,7 @@ class MissingCredentialsError(RuntimeError):
 
 
 def _check_credentials(
-    *, username: Union[str, None], password: Union[str, None]
+    *, username: str | None, password: str | None
 ) -> Tuple[str, str]:
     """
     Check that username and password are defined

fractal_client/cmd/_aux_task_caching.py

@@ -1,7 +1,6 @@
 import json
 from pathlib import Path
 from typing import Any
-from typing import Optional
 
 import packaging.version
 
@@ -92,7 +91,7 @@ def _get_matching_tasks(
     task_list: _TaskList,
     *,
     name: str,
-    version: Optional[str] = None,
+    version: str | None = None,
 ) -> _TaskList:
     """
     Given a task list, extract all the tasks matching some conditions.
@@ -128,7 +127,7 @@ def _search_in_task_list(
     *,
     task_list: _TaskList,
     name: str,
-    version: Optional[str] = None,
+    version: str | None = None,
 ) -> int:
     """
     Search for a single task in `task_list` based on the provided `name`
@@ -194,7 +193,7 @@ def _search_in_task_list(
 
 
 def get_task_id_from_cache(
-    client: AuthClient, task_name: str, version: Optional[str] = None
+    client: AuthClient, task_name: str, version: str | None = None
 ) -> int:
     """
     Retrieve the `id` of a task from the cache based on the provided

fractal_client/cmd/_dataset.py

@@ -1,5 +1,4 @@
 import json
-from typing import Optional
 
 from ..authclient import AuthClient
 from ..config import settings
@@ -13,7 +12,7 @@ def post_dataset(
     project_id: int,
     dataset_name: str,
     zarr_dir: str,
-    filters: Optional[str] = None,
+    filters: str | None = None,
     batch: bool = False,
 ) -> Interface:
     """
@@ -48,8 +47,8 @@ def patch_dataset(
     *,
     project_id: int,
     dataset_id: int,
-    new_name: Optional[str] = None,
-    filters: Optional[str] = None,
+    new_name: str | None = None,
+    filters: str | None = None,
 ) -> Interface:
     # Prepare payload
     dataset_update = {}

fractal_client/cmd/_group.py

@@ -1,5 +1,3 @@
-from typing import Optional
-
 from ..authclient import AuthClient
 from ..config import settings
 from ..interface import Interface
@@ -30,7 +28,7 @@ def group_new(
     client: AuthClient,
     *,
     name: str,
-    viewer_paths: Optional[list[str]] = None,
+    viewer_paths: list[str] | None = None,
     batch: bool = False,
 ):
     request_body = dict(name=name)
@@ -52,8 +50,8 @@ def group_update(
     client: AuthClient,
     *,
     group_id: int,
-    new_user_ids: Optional[list[int]] = None,
-    new_viewer_paths: Optional[list[str]] = None,
+    new_user_ids: list[int] | None = None,
+    new_viewer_paths: list[str] | None = None,
 ):
 
     request_body = dict()

fractal_client/cmd/_job.py

@@ -1,7 +1,6 @@
 import logging
 import os
 from pathlib import Path
-from typing import Optional
 from zipfile import ZipFile
 
 from ..authclient import AuthClient
@@ -129,9 +128,9 @@ def job_submit(
     project_id: int,
     workflow_id: int,
     dataset_id: int,
-    first_task_index: Optional[int] = None,
-    last_task_index: Optional[int] = None,
-    worker_init: Optional[str] = None,
+    first_task_index: int | None = None,
+    last_task_index: int | None = None,
+    worker_init: str | None = None,
     batch: bool = False,
 ) -> Interface:
 

fractal_client/cmd/_project.py

@@ -1,5 +1,3 @@
-from typing import Optional
-
 from ..authclient import AuthClient
 from ..config import settings
 from ..interface import Interface
@@ -47,7 +45,7 @@ def patch_project(
     client: AuthClient,
     *,
     project_id: int,
-    new_name: Optional[str] = None,
+    new_name: str | None = None,
 ) -> Interface:
     project_update = {}
     if new_name:

fractal_client/cmd/_task.py

@@ -1,7 +1,6 @@
 import json
 import logging
 import sys
-from typing import Optional
 
 from ..authclient import AuthClient
 from ..config import settings
@@ -21,10 +20,10 @@ def task_collect_pip(
     client: AuthClient,
     *,
     package: str,
-    package_version: Optional[str] = None,
-    python_version: Optional[str] = None,
-    package_extras: Optional[str] = None,
-    pinned_dependency: Optional[list[str]] = None,
+    package_version: str | None = None,
+    python_version: str | None = None,
+    package_extras: str | None = None,
+    pinned_dependency: list[str] | None = None,
     private: bool = False,
     batch: bool = False,
 ) -> Interface:
@@ -70,9 +69,9 @@ def task_collect_custom(
     label: str,
     python_interpreter: str,
     manifest: str,
-    version: Optional[str] = None,
-    package_name: Optional[str] = None,
-    package_root: Optional[str] = None,
+    version: str | None = None,
+    package_name: str | None = None,
+    package_root: str | None = None,
     private: bool = False,
     batch: bool = False,
 ) -> Interface:
@@ -139,14 +138,14 @@ def post_task(
     *,
     name: str,
     batch: bool = False,
-    command_non_parallel: Optional[str] = None,
-    command_parallel: Optional[str] = None,
-    version: Optional[str] = None,
-    meta_non_parallel: Optional[str] = None,
-    meta_parallel: Optional[str] = None,
-    args_schema_non_parallel: Optional[str] = None,
-    args_schema_parallel: Optional[str] = None,
-    args_schema_version: Optional[str] = None,
+    command_non_parallel: str | None = None,
+    command_parallel: str | None = None,
+    version: str | None = None,
+    meta_non_parallel: str | None = None,
+    meta_parallel: str | None = None,
+    args_schema_non_parallel: str | None = None,
+    args_schema_parallel: str | None = None,
+    args_schema_version: str | None = None,
     private: bool = False,
 ) -> Interface:
     task = dict(name=name)
@@ -184,13 +183,13 @@ def post_task(
 def patch_task(
     client: AuthClient,
     *,
-    id: Optional[int] = None,
-    name: Optional[str] = None,
-    version: Optional[str] = None,
-    command_non_parallel: Optional[str] = None,
-    command_parallel: Optional[str] = None,
-    input_types: Optional[str] = None,
-    output_types: Optional[str] = None,
+    id: int | None = None,
+    name: str | None = None,
+    version: str | None = None,
+    command_non_parallel: str | None = None,
+    command_parallel: str | None = None,
+    input_types: str | None = None,
+    output_types: str | None = None,
 ) -> Interface:
 
     if id:

fractal_client/cmd/_user.py

@@ -2,7 +2,6 @@
 import sys
 from json.decoder import JSONDecodeError
 from pathlib import Path
-from typing import Optional
 
 from ..authclient import AuthClient
 from ..config import settings
@@ -44,10 +43,10 @@ def user_register(
     *,
     new_email: str,
     new_password: str,
-    slurm_user: Optional[str] = None,
-    cache_dir: Optional[str] = None,
-    username: Optional[str] = None,
-    ssh_settings_json: Optional[str] = None,
+    slurm_user: str | None = None,
+    cache_dir: str | None = None,
+    username: str | None = None,
+    ssh_settings_json: str | None = None,
     superuser: bool = False,
     verified: bool = True,  # TODO: this is not currently exposed in the CLI
     batch: bool = False,
@@ -124,12 +123,12 @@ def user_edit(
     client: AuthClient,
     *,
     user_id: str,
-    new_email: Optional[str] = None,
-    new_password: Optional[str] = None,
-    new_username: Optional[str] = None,
-    new_slurm_user: Optional[str] = None,
-    new_cache_dir: Optional[str] = None,
-    new_ssh_settings_json: Optional[str] = None,
+    new_email: str | None = None,
+    new_password: str | None = None,
+    new_username: str | None = None,
+    new_slurm_user: str | None = None,
+    new_cache_dir: str | None = None,
+    new_ssh_settings_json: str | None = None,
     make_superuser: bool = False,
     remove_superuser: bool = False,
     make_verified: bool = False,

fractal_client/cmd/_workflow.py

@@ -2,7 +2,6 @@
 import logging
 import sys
 from pathlib import Path
-from typing import Optional
 
 from ..authclient import AuthClient
 from ..config import settings
@@ -63,16 +62,16 @@ def post_workflowtask(
     *,
     project_id: int,
     workflow_id: int,
-    input_filters: Optional[str] = None,
-    args_non_parallel: Optional[str] = None,
-    args_parallel: Optional[str] = None,
-    meta_non_parallel: Optional[str] = None,
-    meta_parallel: Optional[str] = None,
-    task_id: Optional[int] = None,
-    task_name: Optional[str] = None,
-    task_version: Optional[str] = None,
+    input_filters: str | None = None,
+    args_non_parallel: str | None = None,
+    args_parallel: str | None = None,
+    meta_non_parallel: str | None = None,
+    meta_parallel: str | None = None,
+    task_id: int | None = None,
+    task_name: str | None = None,
+    task_version: str | None = None,
     batch: bool = False,
-    order: Optional[int] = None,
+    order: int | None = None,
 ) -> Interface:
 
     if task_id:
@@ -143,11 +142,11 @@ def patch_workflowtask(
     project_id: int,
     workflow_id: int,
     workflow_task_id: int,
-    input_filters: Optional[str] = None,
-    args_non_parallel: Optional[str] = None,
-    args_parallel: Optional[str] = None,
-    meta_non_parallel: Optional[str] = None,
-    meta_parallel: Optional[str] = None,
+    input_filters: str | None = None,
+    args_non_parallel: str | None = None,
+    args_parallel: str | None = None,
+    meta_non_parallel: str | None = None,
+    meta_parallel: str | None = None,
 ) -> Interface:
 
     payload = {}
@@ -227,7 +226,7 @@ def workflow_import(
     *,
     project_id: int,
     json_file: str,
-    workflow_name: Optional[str] = None,
+    workflow_name: str | None = None,
     batch: bool = False,
 ) -> Interface:
     with Path(json_file).open("r") as f:

fractal_client/config.py

@@ -13,7 +13,6 @@
 """
 from os import getenv
 from pathlib import Path
-from typing import Optional
 
 from dotenv import load_dotenv
 
@@ -23,8 +22,8 @@
 class Settings:
     def __init__(self):
 
-        self.FRACTAL_USER: Optional[str] = getenv("FRACTAL_USER")
-        self.FRACTAL_PASSWORD: Optional[str] = getenv("FRACTAL_PASSWORD")
+        self.FRACTAL_USER: str | None = getenv("FRACTAL_USER")
+        self.FRACTAL_PASSWORD: str | None = getenv("FRACTAL_PASSWORD")
 
         self.FRACTAL_SERVER: str = getenv(
             "FRACTAL_SERVER", "http://localhost:8000"

fractal_client/response.py

@@ -3,7 +3,6 @@
 import sys
 from json.decoder import JSONDecodeError
 from typing import Any
-from typing import Union
 
 from httpx import Response
 
@@ -12,9 +11,9 @@
 
 def check_response(
     res: Response,
-    expected_status_code: Union[int, list[int]] = 200,
+    expected_status_code: int | list[int] = 200,
     redact_long_payload: bool = False,
-) -> Union[list[Any], dict[str, Any], str, int, float, bool]:
+) -> list[Any] | dict[str, Any] | str | int | float | bool:
     """
     Check the validity of the http response from fractal server