chore: finalize classes (#113)

Signed-off-by: nstarman <nstarman@users.noreply.github.com>

src/galax/dynamics/_base.py

@@ -26,7 +26,7 @@
 
 
 class AbstractPhaseSpacePosition(eqx.Module, strict=True):  # type: ignore[call-arg, misc]
-    """Abstract Base Class of Phase-Space Positions.
+    """Abstract base class of Phase-Space Positions.
 
     Todo:
     ----

src/galax/dynamics/_orbit.py

@@ -3,6 +3,7 @@
 __all__ = ["Orbit"]
 
 from functools import partial
+from typing import final
 
 import equinox as eqx
 import jax
@@ -16,6 +17,7 @@
 from ._base import AbstractPhaseSpacePosition
 
 
+@final
 class Orbit(AbstractPhaseSpacePosition):
     """Represents an orbit.
 

src/galax/dynamics/mockstream/_core.py

@@ -4,7 +4,7 @@
 
 from dataclasses import replace
 from functools import partial
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, final
 
 import equinox as eqx
 import jax
@@ -22,6 +22,7 @@
     from galax.potential._potential.base import AbstractPotentialBase
 
 
+@final
 class MockStream(AbstractPhaseSpacePosition):
     """Mock stream object.
 

src/galax/dynamics/mockstream/_df/base.py

@@ -24,7 +24,7 @@
 
 
 class AbstractStreamDF(eqx.Module, strict=True):  # type: ignore[call-arg, misc]
-    """Abstract Base Class of Stream Distribution Functions."""
+    """Abstract base class of Stream Distribution Functions."""
 
     lead: bool = eqx.field(default=True, static=True)
     trail: bool = eqx.field(default=True, static=True)

src/galax/dynamics/mockstream/_df/fardal.py

@@ -1,10 +1,10 @@
 """galax: Galactic Dynamix in Jax."""
 
-
 __all__ = ["FardalStreamDF"]
 
 
 from functools import partial
+from typing import final
 
 import jax
 import jax.experimental.array_api as xp
@@ -23,6 +23,7 @@
 from .base import AbstractStreamDF
 
 
+@final
 class FardalStreamDF(AbstractStreamDF):
     """Fardal Stream Distribution Function.
 

src/galax/dynamics/mockstream/_mockstream_generator.py

@@ -4,7 +4,7 @@
 
 from dataclasses import KW_ONLY
 from functools import partial
-from typing import TypeAlias
+from typing import TypeAlias, final
 
 import equinox as eqx
 import jax
@@ -35,6 +35,7 @@ def _interleave_concat(
     )
 
 
+@final
 class MockStreamGenerator(eqx.Module):  # type: ignore[misc]
     """Generate a mock stellar stream in the specified external potential."""
 

src/galax/integrate/_builtin.py

@@ -2,7 +2,7 @@
 
 from collections.abc import Mapping
 from dataclasses import KW_ONLY
-from typing import Any
+from typing import Any, final
 
 import equinox as eqx
 import jax.experimental.array_api as xp
@@ -25,6 +25,7 @@
 from ._base import FCallable
 
 
+@final
 class DiffraxIntegrator(AbstractIntegrator):
     """Thin wrapper around ``diffrax.diffeqsolve``."""
 

src/galax/potential/_potential/param/attr.py

@@ -4,14 +4,15 @@
 
 from dataclasses import dataclass, field
 from types import MappingProxyType
-from typing import TYPE_CHECKING, Any, NoReturn
+from typing import TYPE_CHECKING, Any, NoReturn, final
 
 from .field import ParameterField
 
 if TYPE_CHECKING:
     from galax.potential._potential.base import AbstractPotentialBase
 
 
+@final
 @dataclass(frozen=True, slots=True)
 class ParametersAttribute:
     """Mapping of the :class:`~galax.potential.ParameterField` values.

src/galax/potential/_potential/param/core.py

@@ -5,7 +5,7 @@
 import abc
 from dataclasses import KW_ONLY, replace
 from functools import partial
-from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
+from typing import TYPE_CHECKING, Any, Protocol, final, runtime_checkable
 
 import astropy.units as u
 import equinox as eqx
@@ -27,7 +27,7 @@
 
 
 class AbstractParameter(eqx.Module, strict=True):  # type: ignore[call-arg, misc]
-    """Abstract Base Class for Parameters on a Potential.
+    """Abstract base class for Parameters on a Potential.
 
     Parameters are time-dependent quantities that are used to define a
     Potential. They can be constant (see `ConstantParameter`), or they can be
@@ -61,6 +61,7 @@ def __call__(self, t: FloatOrIntScalarLike, **kwargs: Any) -> FloatArrayAnyShape
         ...
 
 
+@final
 class ConstantParameter(AbstractParameter):
     """Time-independent potential parameter."""
 
@@ -134,6 +135,7 @@ def __call__(self, t: FloatScalar, **kwargs: Any) -> FloatArrayAnyShape:
         ...
 
 
+@final
 class UserParameter(AbstractParameter):
     """User-defined Parameter.
 

src/galax/potential/_potential/param/field.py

@@ -10,6 +10,7 @@
     Annotated,
     Any,
     cast,
+    final,
     get_args,
     get_origin,
     get_type_hints,
@@ -27,6 +28,7 @@
     from galax.potential._potential.base import AbstractPotentialBase
 
 
+@final
 @dataclass(frozen=True, slots=True)
 class ParameterField:
     """Descriptor for a Potential Parameter.

src/galax/units.py

@@ -9,7 +9,7 @@
 ]
 
 from collections.abc import Iterator
-from typing import ClassVar, Union
+from typing import ClassVar, Union, final
 
 import astropy.units as u
 from astropy.units.physical import _physical_unit_mapping
@@ -162,6 +162,7 @@ def as_preferred(self, quantity: u.Quantity) -> u.Quantity:
         return quantity.to(self.preferred(quantity.unit.physical_type))
 
 
+@final
 class DimensionlessUnitSystem(UnitSystem):
     """A unit system with only dimensionless units."""