Merge pull request #461 from litebird/add_syntax_hook

Add syntax hook `py3.10+`

Author: ggalloni

.pre-commit-config.yaml

@@ -1,7 +1,13 @@
 repos:
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.20.0
+  hooks:
+    - id: pyupgrade
+      args: [--py310-plus]
+      files: '^(litebird_sim)/.*\.py$'
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.11.11
+  rev: v0.13.0
   hooks:
     # Run the linter.
     - id: ruff

CHANGELOG.md

@@ -1,5 +1,7 @@
 # HEAD
 
+-   Add pre-commit hook to keep syntax compliant with `py3.10+` [#461](https://github.com/litebird/litebird_sim/pull/461)
+
 -   Fix issue [#459](https://github.com/litebird/litebird_sim/issues/459)
 
 -   Fix issue [#457](https://github.com/litebird/litebird_sim/issues/457)

docs/source/scanning.rst

@@ -575,12 +575,11 @@ The following code implements our mock scanning strategy::
    import litebird_sim as lbs
    from litebird_sim import RotQuaternion
    import astropy
-   from typing import Union
 
    class SimpleScanningStrategy(lbs.ScanningStrategy):
        def generate_spin2ecl_quaternions(
            self,
-           start_time: Union[float, astropy.time.Time],
+           start_time: float | astropy.time.Time,
            time_span_s: float,
            delta_time_s: float,
        ) -> RotQuaternion:

litebird_sim/__init__.py

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 import numba
 
 from litebird_sim.mapmaking import (

litebird_sim/bandpasses.py

@@ -1,11 +1,8 @@
-# -*- encoding: utf-8 -*-
-
 from dataclasses import dataclass
 
 import numpy as np
 import scipy as sp
 import logging
-from typing import Optional, Union
 from uuid import UUID
 
 from .imo import Imo
@@ -81,8 +78,8 @@ class BandPassInfo:
 
     bandcenter_ghz: float = 0.0
     bandwidth_ghz: float = 0.0
-    bandlow_ghz: Union[float, None] = None
-    bandhigh_ghz: Union[float, None] = None
+    bandlow_ghz: float | None = None
+    bandhigh_ghz: float | None = None
     nsamples_inband: int = 128
     name: str = ""
     bandtype: str = "top-hat"
@@ -141,7 +138,7 @@ def get_edges(self):
             self.bandcenter_ghz + self.bandwidth_ghz / 2,
         )
 
-    def _get_top_hat_bandpass(self, normalize=False, apodization: Optional[str] = None):
+    def _get_top_hat_bandpass(self, normalize=False, apodization: str | None = None):
         """
         Sample a top-hat bandpass, given the centroid and the bandwidth.
         If the `normalize` flag is set to ``True``, the transmission
@@ -244,7 +241,7 @@ def find_central_frequency(self):
             )
 
     @staticmethod
-    def from_imo(imo: Imo, url: Union[UUID, str]):
+    def from_imo(imo: Imo, url: UUID | str):
         """Create a `BandPassInfo` object from a definition in the IMO
         The `url` must either specify a UUID or a full URL to the
         object.

litebird_sim/beam_convolution.py

@@ -1,9 +1,6 @@
-# -*- encoding: utf-8 -*-
-
 import logging
 import os
 from dataclasses import dataclass
-from typing import Union, List, Dict, Optional
 
 import numpy as np
 import numpy.typing as npt
@@ -57,8 +54,8 @@ def add_convolved_sky_to_one_detector(
     pointings_det,
     mueller_matrix,
     hwp_angle,
-    convolution_params: Optional[BeamConvolutionParameters] = None,
-    nside_centering: Union[int, None] = None,
+    convolution_params: BeamConvolutionParameters | None = None,
+    nside_centering: int | None = None,
     nthreads: int = 0,
 ):
     """
@@ -206,16 +203,16 @@ def add_convolved_sky_to_one_detector(
 def add_convolved_sky(
     tod,
     pointings,
-    sky_alms: Union[SphericalHarmonics, Dict[str, SphericalHarmonics]],
-    beam_alms: Union[SphericalHarmonics, Dict[str, SphericalHarmonics]],
-    hwp_angle: Union[np.ndarray, None] = None,
-    mueller_hwp: Union[np.ndarray, None] = None,
-    input_sky_names: Union[str, None] = None,
-    input_beam_names: Union[str, None] = None,
-    convolution_params: Optional[BeamConvolutionParameters] = None,
+    sky_alms: SphericalHarmonics | dict[str, SphericalHarmonics],
+    beam_alms: SphericalHarmonics | dict[str, SphericalHarmonics],
+    hwp_angle: np.ndarray | None = None,
+    mueller_hwp: np.ndarray | None = None,
+    input_sky_names: str | None = None,
+    input_beam_names: str | None = None,
+    convolution_params: BeamConvolutionParameters | None = None,
     input_sky_alms_in_galactic: bool = True,
     pointings_dtype=np.float64,
-    nside_centering: Union[int, None] = None,
+    nside_centering: int | None = None,
     nthreads: int = 0,
 ):
     """
@@ -230,10 +227,10 @@ def add_convolved_sky(
         Pointing information for each detector. If an array, it should have shape
         (n_detectors, n_samples, 3). If a callable, it should return pointing data when
         passed a detector index.
-    sky_alms : Union[SphericalHarmonics, Dict[str, SphericalHarmonics]]
+    sky_alms : SphericalHarmonics | Dict[str, SphericalHarmonics]
         Spherical harmonic coefficients representing the sky maps. If a dictionary, keys should
         correspond to detector or channel names.
-    beam_alms : Union[SphericalHarmonics, Dict[str, SphericalHarmonics]]
+    beam_alms : SphericalHarmonics | Dict[str, SphericalHarmonics]
         Spherical harmonic coefficients representing the beam functions. If a dictionary,
         keys should correspond to detector or channel names.
     hwp_angle : np.ndarray or None, default=None
@@ -332,21 +329,21 @@ def add_convolved_sky(
 
 
 def add_convolved_sky_to_observations(
-    observations: Union[Observation, List[Observation]],
-    sky_alms: Union[
-        SphericalHarmonics, Dict[str, SphericalHarmonics]
-    ],  # at some point optional, taken from the obs
-    beam_alms: Union[
-        SphericalHarmonics, Dict[str, SphericalHarmonics]
-    ],  # at some point optional, taken from the obs
-    pointings: Union[npt.ArrayLike, List[npt.ArrayLike], None] = None,
-    hwp: Optional[HWP] = None,
+    observations: Observation | list[Observation],
+    sky_alms: (
+        SphericalHarmonics | dict[str, SphericalHarmonics]
+    ),  # at some point optional, taken from the obs
+    beam_alms: (
+        SphericalHarmonics | dict[str, SphericalHarmonics]
+    ),  # at some point optional, taken from the obs
+    pointings: npt.ArrayLike | list[npt.ArrayLike] | None = None,
+    hwp: HWP | None = None,
     input_sky_alms_in_galactic: bool = True,
-    convolution_params: Optional[BeamConvolutionParameters] = None,
+    convolution_params: BeamConvolutionParameters | None = None,
     component: str = "tod",
     pointings_dtype=np.float64,
-    nside_centering: Union[int, None] = None,
-    nthreads: Union[int, None] = None,
+    nside_centering: int | None = None,
+    nthreads: int | None = None,
 ):
     """
     Applies beam convolution to sky maps and adds the resulting signal to the TOD of one or more observations.
@@ -366,12 +363,12 @@ def add_convolved_sky_to_observations(
         keyed by detector/channel names.
     pointings : np.ndarray, list of np.ndarray, or None, default=None
         Detector pointing matrices. If None, the function extracts pointings from the `Observation` objects.
-    hwp : Optional[HWP], default=None
+    hwp : HWP | None, default=None
         Half-Wave Plate (HWP) parameters. If None, the function either assumes the information stored in the
         `Observation` objects, or, if they are absent, assumes no HWP.
     input_sky_alms_in_galactic : bool, default=True
         Whether the input sky alms are in Galactic coordinates.
-    convolution_params : Optional[BeamConvolutionParameters], default=None
+    convolution_params : BeamConvolutionParameters | None, default=None
         Parameters controlling the beam convolution, including resolution limits and numerical precision.
     component : str, default="tod"
         The name of the TOD component to which the computed data is added.

litebird_sim/beam_synthesis.py

@@ -1,7 +1,3 @@
-# -*- encoding: utf-8 -*-
-
-from typing import Optional, Union, List
-
 import numpy as np
 from numpy import sqrt, exp, sin, cos, log
 from scipy.special import iv as bessel_i
@@ -36,7 +32,7 @@ def alm_index(lmax: int, ell: int, m: int) -> int:
 
 
 def allocate_alm(
-    lmax: int, mmax: Optional[int] = None, nstokes: int = 3, dtype=np.complex128
+    lmax: int, mmax: int | None = None, nstokes: int = 3, dtype=np.complex128
 ) -> SphericalHarmonics:
     """
     Allocate an array to store spherical harmonics coefficients.
@@ -69,10 +65,10 @@ def gauss_beam_to_alm(
     lmax: int,
     mmax: int,
     fwhm_rad: float,
-    ellipticity: Optional[float] = 1.0,
-    psi_ell_rad: Optional[float] = 0.0,
-    psi_pol_rad: Union[float, None] = 0.0,
-    cross_polar_leakage: Optional[float] = 0.0,
+    ellipticity: float | None = 1.0,
+    psi_ell_rad: float | None = 0.0,
+    psi_pol_rad: float | None = 0.0,
+    cross_polar_leakage: float | None = 0.0,
 ) -> SphericalHarmonics:
     """
     Compute spherical harmonics coefficients a_ℓm representing a Gaussian beam.
@@ -205,9 +201,9 @@ def gauss_beam_to_alm(
 def generate_gauss_beam_alms(
     observation: Observation,
     lmax: int,
-    mmax: Optional[int] = None,
-    channels: Union[FreqChannelInfo, List[FreqChannelInfo], None] = None,
-    store_in_observation: Optional[bool] = False,
+    mmax: int | None = None,
+    channels: FreqChannelInfo | list[FreqChannelInfo] | None = None,
+    store_in_observation: bool | None = False,
 ):
     """
     Generate Gaussian beam spherical harmonics coefficients for each detector in

litebird_sim/compress.py

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 import numpy as np
 from numba import njit
 

litebird_sim/constants.py

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 import numpy as np
 from astropy.constants import c as c_light
 from astropy.constants import h, k_B

litebird_sim/coordinates.py

@@ -1,6 +1,4 @@
-# -*- encoding: utf-8 -*-
 from enum import Enum
-from typing import Tuple
 
 import numpy as np
 from astropy.coordinates import BarycentricMeanEcliptic
@@ -105,7 +103,7 @@ def vec2ang(vx, vy, vz):
 @njit
 def _ang2galvec_one_sample(
     theta_rad: float, phi_rad: float
-) -> Tuple[float, float, float]:
+) -> tuple[float, float, float]:
     """Transform a direction (theta, phi) in Ecliptic coordinates to
     a unit vector in Galactic coordinates.
 
@@ -139,7 +137,7 @@ def _ang2galvec_one_sample(
 
 
 @njit
-def _vec2ang_for_one_sample(vx: float, vy: float, vz: float) -> Tuple[float, float]:
+def _vec2ang_for_one_sample(vx: float, vy: float, vz: float) -> tuple[float, float]:
     """Transform a vector to angle given by (θ,φ).
 
     Parameters
@@ -168,7 +166,7 @@ def _vec2ang_for_one_sample(vx: float, vy: float, vz: float) -> Tuple[float, flo
 @njit
 def _rotate_coordinates_and_orientation_e2g_for_one_sample(
     theta_ecl_rad: float, phi_ecl_rad: float, psi_ecl_rad: float
-) -> Tuple[float, float, float]:
+) -> tuple[float, float, float]:
     """Rotate the angles theta,phi and psi from ecliptic to galactic coordinates
 
     Parameters