Initial removal of Optional/Union in favor of |

Author: amas0

cmdstanpy/cmdstan_args.py

@@ -5,14 +5,14 @@
 import os
 from enum import Enum, auto
 from time import time
-from typing import Any, Mapping, Optional, Union
+from typing import Any, Mapping
 
 import numpy as np
 from numpy.random import default_rng
 
 from cmdstanpy.utils import cmdstan_path, cmdstan_version_before, get_logger
 
-OptionalPath = Union[str, os.PathLike, None]
+OptionalPath = str | os.PathLike | None
 
 
 class Method(Enum):
@@ -52,19 +52,19 @@ class SamplerArgs:
 
     def __init__(
         self,
-        iter_warmup: Optional[int] = None,
-        iter_sampling: Optional[int] = None,
+        iter_warmup: int | None = None,
+        iter_sampling: int | None = None,
         save_warmup: bool = False,
-        thin: Optional[int] = None,
-        max_treedepth: Optional[int] = None,
-        metric_type: Optional[str] = None,
-        metric_file: Union[str, list[str], None] = None,
-        step_size: Union[float, list[float], None] = None,
+        thin: int | None = None,
+        max_treedepth: int | None = None,
+        metric_type: str | None = None,
+        metric_file: str | list[str] | None = None,
+        step_size: float | list[float] | None = None,
         adapt_engaged: bool = True,
-        adapt_delta: Optional[float] = None,
-        adapt_init_phase: Optional[int] = None,
-        adapt_metric_window: Optional[int] = None,
-        adapt_step_size: Optional[int] = None,
+        adapt_delta: float | None = None,
+        adapt_init_phase: int | None = None,
+        adapt_metric_window: int | None = None,
+        adapt_step_size: int | None = None,
         fixed_param: bool = False,
         num_chains: int = 1,
     ) -> None:
@@ -74,8 +74,8 @@ def __init__(
         self.save_warmup = save_warmup
         self.thin = thin
         self.max_treedepth = max_treedepth
-        self.metric_type: Optional[str] = metric_type
-        self.metric_file: Union[str, list[str], None] = metric_file
+        self.metric_type: str | None = metric_type
+        self.metric_file: str | list[str] | None = metric_file
         self.step_size = step_size
         self.adapt_engaged = adapt_engaged
         self.adapt_delta = adapt_delta
@@ -86,7 +86,7 @@ def __init__(
         self.diagnostic_file = None
         self.num_chains = num_chains
 
-    def validate(self, chains: Optional[int]) -> None:
+    def validate(self, chains: int | None) -> None:
         """
         Check arguments correctness and consistency.
 
@@ -295,16 +295,16 @@ class OptimizeArgs:
 
     def __init__(
         self,
-        algorithm: Optional[str] = None,
-        init_alpha: Optional[float] = None,
-        iter: Optional[int] = None,
+        algorithm: str | None = None,
+        init_alpha: float | None = None,
+        iter: int | None = None,
         save_iterations: bool = False,
-        tol_obj: Optional[float] = None,
-        tol_rel_obj: Optional[float] = None,
-        tol_grad: Optional[float] = None,
-        tol_rel_grad: Optional[float] = None,
-        tol_param: Optional[float] = None,
-        history_size: Optional[int] = None,
+        tol_obj: float | None = None,
+        tol_rel_obj: float | None = None,
+        tol_grad: float | None = None,
+        tol_rel_grad: float | None = None,
+        tol_param: float | None = None,
+        history_size: int | None = None,
         jacobian: bool = False,
     ) -> None:
         self.algorithm = algorithm or ""
@@ -319,7 +319,7 @@ def __init__(
         self.history_size = history_size
         self.jacobian = jacobian
 
-    def validate(self, _chains: Optional[int] = None) -> None:
+    def validate(self, _chains: int | None = None) -> None:
         """
         Check arguments correctness and consistency.
         """
@@ -383,13 +383,13 @@ class LaplaceArgs:
     """Arguments needed for laplace method."""
 
     def __init__(
-        self, mode: str, draws: Optional[int] = None, jacobian: bool = True
+        self, mode: str, draws: int | None = None, jacobian: bool = True
     ) -> None:
         self.mode = mode
         self.jacobian = jacobian
         self.draws = draws
 
-    def validate(self, _chains: Optional[int] = None) -> None:
+    def validate(self, _chains: int | None = None) -> None:
         """Check arguments correctness and consistency."""
         if not os.path.exists(self.mode):
             raise ValueError(f'Invalid path for mode file: {self.mode}')
@@ -411,18 +411,18 @@ class PathfinderArgs:
 
     def __init__(
         self,
-        init_alpha: Optional[float] = None,
-        tol_obj: Optional[float] = None,
-        tol_rel_obj: Optional[float] = None,
-        tol_grad: Optional[float] = None,
-        tol_rel_grad: Optional[float] = None,
-        tol_param: Optional[float] = None,
-        history_size: Optional[int] = None,
-        num_psis_draws: Optional[int] = None,
-        num_paths: Optional[int] = None,
-        max_lbfgs_iters: Optional[int] = None,
-        num_draws: Optional[int] = None,
-        num_elbo_draws: Optional[int] = None,
+        init_alpha: float | None = None,
+        tol_obj: float | None = None,
+        tol_rel_obj: float | None = None,
+        tol_grad: float | None = None,
+        tol_rel_grad: float | None = None,
+        tol_param: float | None = None,
+        history_size: int | None = None,
+        num_psis_draws: int | None = None,
+        num_paths: int | None = None,
+        max_lbfgs_iters: int | None = None,
+        num_draws: int | None = None,
+        num_elbo_draws: int | None = None,
         save_single_paths: bool = False,
         psis_resample: bool = True,
         calculate_lp: bool = True,
@@ -445,7 +445,7 @@ def __init__(
         self.psis_resample = psis_resample
         self.calculate_lp = calculate_lp
 
-    def validate(self, _chains: Optional[int] = None) -> None:
+    def validate(self, _chains: int | None = None) -> None:
         """
         Check arguments correctness and consistency.
         """
@@ -514,7 +514,7 @@ def __init__(self, csv_files: list[str]) -> None:
 
     def validate(
         self,
-        chains: Optional[int] = None,  # pylint: disable=unused-argument
+        chains: int | None = None,  # pylint: disable=unused-argument
     ) -> None:
         """
         Check arguments correctness and consistency.
@@ -543,16 +543,16 @@ class VariationalArgs:
 
     def __init__(
         self,
-        algorithm: Optional[str] = None,
-        iter: Optional[int] = None,
-        grad_samples: Optional[int] = None,
-        elbo_samples: Optional[int] = None,
-        eta: Optional[float] = None,
-        adapt_iter: Optional[int] = None,
+        algorithm: str | None = None,
+        iter: int | None = None,
+        grad_samples: int | None = None,
+        elbo_samples: int | None = None,
+        eta: float | None = None,
+        adapt_iter: int | None = None,
         adapt_engaged: bool = True,
-        tol_rel_obj: Optional[float] = None,
-        eval_elbo: Optional[int] = None,
-        output_samples: Optional[int] = None,
+        tol_rel_obj: float | None = None,
+        eval_elbo: int | None = None,
+        output_samples: int | None = None,
     ) -> None:
         self.algorithm = algorithm
         self.iter = iter
@@ -567,7 +567,7 @@ def __init__(
 
     def validate(
         self,
-        chains: Optional[int] = None,  # pylint: disable=unused-argument
+        chains: int | None = None,  # pylint: disable=unused-argument
     ) -> None:
         """
         Check arguments correctness and consistency.
@@ -633,23 +633,23 @@ def __init__(
         self,
         model_name: str,
         model_exe: str,
-        chain_ids: Optional[list[int]],
-        method_args: Union[
-            SamplerArgs,
-            OptimizeArgs,
-            GenerateQuantitiesArgs,
-            VariationalArgs,
-            LaplaceArgs,
-            PathfinderArgs,
-        ],
-        data: Union[Mapping[str, Any], str, None] = None,
-        seed: Union[int, list[int], None] = None,
-        inits: Union[int, float, str, list[str], None] = None,
+        chain_ids: list[int] | None,
+        method_args: (
+            SamplerArgs
+            | OptimizeArgs
+            | GenerateQuantitiesArgs
+            | VariationalArgs
+            | LaplaceArgs
+            | PathfinderArgs
+        ),
+        data: Mapping[str, Any] | str | None = None,
+        seed: int | list[int] | None = None,
+        inits: int | float | str | list[str] | None = None,
         output_dir: OptionalPath = None,
-        sig_figs: Optional[int] = None,
+        sig_figs: int | None = None,
         save_latent_dynamics: bool = False,
         save_profile: bool = False,
-        refresh: Optional[int] = None,
+        refresh: int | None = None,
     ) -> None:
         """Initialize object."""
         self.model_name = model_name
@@ -839,8 +839,8 @@ def compose_command(
         idx: int,
         csv_file: str,
         *,
-        diagnostic_file: Optional[str] = None,
-        profile_file: Optional[str] = None,
+        diagnostic_file: str | None = None,
+        profile_file: str | None = None,
     ) -> list[str]:
         """
         Compose CmdStan command for non-default arguments.

cmdstanpy/compilation.py

@@ -10,7 +10,7 @@
 import subprocess
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Iterable, Optional, Union
+from typing import Any, Iterable
 
 from cmdstanpy.utils import get_logger
 from cmdstanpy.utils.cmdstan import (
@@ -57,7 +57,7 @@
     'version',
 ]
 
-OptionalPath = Union[str, os.PathLike, None]
+OptionalPath = str | os.PathLike | None
 
 
 class CompilerOptions:
@@ -73,8 +73,8 @@ class CompilerOptions:
     def __init__(
         self,
         *,
-        stanc_options: Optional[dict[str, Any]] = None,
-        cpp_options: Optional[dict[str, Any]] = None,
+        stanc_options: dict[str, Any] | None = None,
+        cpp_options: dict[str, Any] | None = None,
         user_header: OptionalPath = None,
     ) -> None:
         """Initialize object."""
@@ -88,14 +88,14 @@ def __repr__(self) -> str:
         )
 
     @property
-    def stanc_options(self) -> dict[str, Union[bool, int, str, Iterable[str]]]:
+    def stanc_options(self) -> dict[str, bool | int | str | Iterable[str]]:
         """Stanc compiler options."""
         return self._stanc_options
 
     @property
-    def cpp_options(self) -> dict[str, Union[bool, int]]:
+    def cpp_options(self) -> dict[str, bool | int]:
         """C++ compiler options."""
-        return self._cpp_options
+        return self._cpp_options  # type: ignore
 
     @property
     def user_header(self) -> str:
@@ -220,7 +220,7 @@ def validate_user_header(self) -> None:
 
             self._cpp_options['USER_HEADER'] = self._user_header
 
-    def compose_stanc(self, filename_in_msg: Optional[str]) -> list[str]:
+    def compose_stanc(self, filename_in_msg: str | None) -> list[str]:
         opts = []
 
         if filename_in_msg is not None:
@@ -244,7 +244,7 @@ def compose_stanc(self, filename_in_msg: Optional[str]) -> list[str]:
                     opts.append(f'--{key}')
         return opts
 
-    def compose(self, filename_in_msg: Optional[str] = None) -> list[str]:
+    def compose(self, filename_in_msg: str | None = None) -> list[str]:
         """
         Format makefile options as list of strings.
 
@@ -266,7 +266,7 @@ def compose(self, filename_in_msg: Optional[str] = None) -> list[str]:
 
 def src_info(
     stan_file: str,
-    stanc_options: Optional[dict[str, Any]] = None,
+    stanc_options: dict[str, Any] | None = None,
 ) -> dict[str, Any]:
     """
     Get source info for Stan program file.
@@ -291,10 +291,10 @@ def src_info(
 
 
 def compile_stan_file(
-    src: Union[str, Path],
+    src: str | Path,
     force: bool = False,
-    stanc_options: Optional[dict[str, Any]] = None,
-    cpp_options: Optional[dict[str, Any]] = None,
+    stanc_options: dict[str, Any] | None = None,
+    cpp_options: dict[str, Any] | None = None,
     user_header: OptionalPath = None,
 ) -> str:
     """
@@ -423,13 +423,13 @@ def compile_stan_file(
 
 
 def format_stan_file(
-    stan_file: Union[str, os.PathLike],
+    stan_file: str | os.PathLike,
     *,
     overwrite_file: bool = False,
-    canonicalize: Union[bool, str, Iterable[str]] = False,
+    canonicalize: bool | str | Iterable[str] = False,
     max_line_length: int = 78,
     backup: bool = True,
-    stanc_options: Optional[dict[str, Any]] = None,
+    stanc_options: dict[str, Any] | None = None,
 ) -> None:
     """
     Run stanc's auto-formatter on the model code. Either saves directly