Replaces string enums with Literals

Author: peterdsharpe

aerosandbox/aerodynamics/aero_3D/aero_buildup.py

@@ -11,6 +11,7 @@
     softmax_scalefree,
 )
 from dataclasses import dataclass
+from typing import Literal
 
 
 class AeroBuildup(ExplicitAnalysis):
@@ -52,7 +53,7 @@ def __init__(
         airplane: Airplane,
         op_point: OperatingPoint,
         xyz_ref: np.ndarray | list[float] | None = None,
-        model_size: str = "small",
+        model_size: Literal["small", "large"] = "small",
         include_wave_drag: bool = True,
     ):
         """

aerosandbox/atmosphere/atmosphere.py

@@ -170,7 +170,7 @@ def density(self):
 
         return rho
 
-    def density_altitude(self, method: str = "approximate"):
+    def density_altitude(self, method: Literal["approximate", "exact"] = "approximate"):
         """
         Returns the density altitude, in meters.
 

aerosandbox/dynamics/point_mass/common_point_mass.py

@@ -1,7 +1,7 @@
 import aerosandbox.numpy as np
 from aerosandbox.common import AeroSandboxObject
 from abc import ABC, abstractmethod
-from typing import Sequence
+from typing import Literal, Sequence
 from aerosandbox import (
     MassProperties,
     Opti,
@@ -363,7 +363,7 @@ def add_force(
         Fx: float | np.ndarray = 0,
         Fy: float | np.ndarray = 0,
         Fz: float | np.ndarray = 0,
-        axes: str = "wind",
+        axes: Literal["geometry", "body", "wind", "stability", "earth"] = "wind",
     ) -> None:
         """
         Adds a force (in whichever axis system you choose) to this Dynamics instance.
@@ -423,14 +423,14 @@ def op_point(self):
     def draw(
         self,
         vehicle_model: "Airplane | PolyData | None" = None,
-        backend: str = "pyvista",
+        backend: Literal["pyvista"] = "pyvista",
         plotter=None,
         draw_axes: bool = True,
         draw_global_axes: bool = True,
         draw_global_grid: bool = True,
         scale_vehicle_model: float | None = None,
         n_vehicles_to_draw: int = 10,
-        cg_axes: str = "geometry",
+        cg_axes: Literal["geometry", "body", "wind", "stability"] = "geometry",
         draw_trajectory_line: bool = True,
         trajectory_line_color=None,
         draw_altitude_drape: bool = True,

aerosandbox/geometry/airfoil/airfoil_families.py

@@ -280,7 +280,7 @@ def get_kulfan_parameters(
     n_points_per_side: int = _default_n_points_per_side,
     normalize_coordinates: bool = True,
     use_leading_edge_modification: bool = True,
-    method: str = "least_squares",
+    method: Literal["least_squares", "opti"] = "least_squares",
 ) -> dict[str, np.ndarray | float]:
     """
     Given a set of airfoil coordinates, reconstructs the Kulfan parameters that would recreate that airfoil. Uses a

aerosandbox/geometry/airplane.py

@@ -1,8 +1,7 @@
 import itertools
 from aerosandbox import AeroSandboxObject
 from aerosandbox.geometry.common import *
-from typing import Any
-from typing import Sequence
+from typing import Any, Literal, Sequence
 import aerosandbox.geometry.mesh_utilities as mesh_utils
 from aerosandbox.geometry.wing import Wing
 from aerosandbox.geometry.fuselage import Fuselage
@@ -223,10 +222,10 @@ def mesh_body(
 
     def draw(
         self,
-        backend: str = "pyvista",
+        backend: Literal["matplotlib", "pyvista", "plotly", "trimesh"] = "pyvista",
         thin_wings: bool = False,
         ax=None,
-        use_preset_view_angle: str | None = None,
+        use_preset_view_angle: Literal["XY", "-XY", "XZ", "-XZ", "YZ", "-YZ", "left_isometric", "right_isometric"] | None = None,
         set_background_pane_color: str | tuple[float, float, float] | None = None,
         set_background_pane_alpha: float | None = None,
         set_lims: bool = True,
@@ -386,7 +385,7 @@ def draw_wireframe(
         thin_linewidth=0.2,
         thick_linewidth=0.5,
         fuselage_longeron_theta=None,
-        use_preset_view_angle: str | None = None,
+        use_preset_view_angle: Literal["XY", "-XY", "XZ", "-XZ", "YZ", "-YZ", "left_isometric", "right_isometric"] | None = None,
         set_background_pane_color: str | tuple[float, float, float] | None = None,
         set_background_pane_alpha: float | None = None,
         set_lims: bool = True,
@@ -649,7 +648,7 @@ def reshape(x):
     def draw_three_view(
         self,
         axs=None,
-        style: str = "shaded",
+        style: Literal["shaded", "wireframe"] = "shaded",
         show: bool = True,
     ) -> np.ndarray:
         """

aerosandbox/geometry/fuselage.py

@@ -2,8 +2,7 @@
 
 from aerosandbox import AeroSandboxObject
 from aerosandbox.geometry.common import *
-from typing import Any, Callable
-from typing import Sequence
+from typing import Any, Callable, Literal, Sequence
 import copy
 from aerosandbox.numpy.typing import Scalar  # Type alias including CasADi types
 
@@ -117,7 +116,7 @@ def __repr__(self) -> str:
 
     def add_loft(
         self,
-        kind: str,
+        kind: Literal["linear", "ellipsoid-nose"],
         to_xsec: "FuselageXSec",
         from_xsec: "FuselageXSec | None" = None,
         n_points: int = 5,
@@ -191,7 +190,7 @@ def area_wetted(self) -> float:
 
     def area_projected(
         self,
-        type: str = "XY",
+        type: Literal["XY", "XZ"] = "XY",
     ) -> float:
         """
         Returns the area of the fuselage as projected onto one of the principal planes.
@@ -233,7 +232,7 @@ def area_base(self) -> float:
 
     def fineness_ratio(
         self,
-        assumed_shape="cylinder",
+        assumed_shape: Literal["cylinder", "sears-haack"] = "cylinder",
     ) -> float:
         """
         Approximates the fineness ratio using the volume and length. The fineness ratio of a fuselage is defined as:
@@ -305,7 +304,7 @@ def volume(self, _sectional: bool = False) -> float | list[float]:
 
     def x_centroid_projected(
         self,
-        type: str = "XY",
+        type: Literal["XY", "XZ"] = "XY",
     ) -> float:
         """
         Returns the x_g coordinate of the centroid of the planform area.
@@ -349,7 +348,7 @@ def x_centroid_projected(
 
     def mesh_body(
         self,
-        method="quad",
+        method: Literal["quad", "tri"] = "quad",
         tangential_resolution: int = 36,
     ) -> tuple[np.ndarray, np.ndarray]:
         """
@@ -906,7 +905,7 @@ def get_3D_coordinates(
             self.xyz_c[2] + y * yg_local[2] + z * zg_local[2],
         )
 
-    def equivalent_radius(self, preserve="area") -> float:
+    def equivalent_radius(self, preserve: Literal["area", "perimeter"] = "area") -> float:
         """
         Computes an equivalent radius for non-circular cross-sections. This may be necessary when doing analysis that
         uses axisymmetric assumptions.

aerosandbox/geometry/wing.py

@@ -1,6 +1,6 @@
 from aerosandbox.common import AeroSandboxObject
 from aerosandbox.geometry.common import *
-from typing import Any, Callable, Sequence
+from typing import Any, Callable, Literal, Sequence
 from aerosandbox.geometry.airfoil import Airfoil
 from numpy import pi
 import aerosandbox.numpy as np
@@ -138,7 +138,7 @@ def translate(self, xyz: np.ndarray | Sequence[float]) -> "Wing":
 
     def span(
         self,
-        type: str = "yz",
+        type: Literal["xyz", "xy", "top", "yz", "front", "xz", "side", "x", "y", "z"] = "yz",
         include_centerline_distance=False,
         _sectional: bool = False,
     ) -> float | list[float]:
@@ -287,7 +287,7 @@ def span(
 
     def area(
         self,
-        type: str = "planform",
+        type: Literal["planform", "wetted", "xy", "projected", "top", "xz", "side", "yz"] = "planform",
         include_centerline_distance=False,
         _sectional: bool = False,
     ) -> float | list[float]:
@@ -413,7 +413,7 @@ def area(
 
     def aspect_ratio(
         self,
-        type: str = "geometric",
+        type: Literal["geometric", "effective"] = "geometric",
     ) -> float:
         """
         Computes the aspect ratio of the wing, with options for various ways of measuring this.
@@ -765,7 +765,7 @@ def set_control_surface_deflections(
     def control_surface_area(
         self,
         by_name: str | None = None,
-        type: str | None = "planform",
+        type: Literal["planform", "wetted", "xy", "projected", "top", "xz", "side"] | None = "planform",
     ) -> float:
         """
         Computes the total area of all control surfaces on this wing, optionally filtered by their name.
@@ -830,7 +830,7 @@ def control_surface_area(
 
     def mesh_body(
         self,
-        method="quad",
+        method: Literal["tri", "quad"] = "quad",
         chordwise_resolution: int = 36,
         chordwise_spacing_function_per_side: Callable[[float, float, int], np.ndarray] = np.cosspace,
         mesh_surface: bool = True,
@@ -994,7 +994,7 @@ def add_face(*indices):
 
     def mesh_thin_surface(
         self,
-        method="tri",
+        method: Literal["tri", "quad"] = "tri",
         chordwise_resolution: int = 36,
         chordwise_spacing_function: Callable[[float, float, int], np.ndarray] = np.cosspace,
         add_camber: bool = True,

aerosandbox/library/aerodynamics/components.py

@@ -155,7 +155,7 @@ def CDA_control_surface_gaps(
     return CDA_side_gaps + CDA_hinge_gap
 
 
-def CDA_protruding_bolt_or_rivet(diameter: float, kind: str = "flush_rivet"):
+def CDA_protruding_bolt_or_rivet(diameter: float, kind: Literal["flush_rivet", "round_rivet", "flat_head_bolt", "round_head_bolt", "cylindrical_bolt", "hex_bolt"] = "flush_rivet"):
     """
     Computes the drag area (CDA) of a protruding bolt or rivet.
 

aerosandbox/modeling/splines/hermite.py

@@ -33,7 +33,7 @@ def cubic_hermite_patch(
     f_b: float,
     dfdx_a: float,
     dfdx_b: float,
-    extrapolation: str = "continue",
+    extrapolation: Literal["continue", "clip"] = "continue",
 ) -> float | np.ndarray:
     """
     Computes the cubic Hermite polynomial patch that passes through the given endpoints and endpoint derivatives.

aerosandbox/performance/operating_point.py

@@ -1,7 +1,7 @@
 from aerosandbox.common import AeroSandboxObject
 from aerosandbox import Atmosphere
 import aerosandbox.numpy as np
-from typing import Sequence
+from typing import Literal, Sequence
 from aerosandbox.tools.string_formatting import trim_string
 import inspect
 from aerosandbox.numpy.typing import Vectorizable
@@ -334,8 +334,8 @@ def convert_axes(
         x_from: Vectorizable,
         y_from: Vectorizable,
         z_from: Vectorizable,
-        from_axes: str,
-        to_axes: str,
+        from_axes: Literal["geometry", "body", "wind", "stability"],
+        to_axes: Literal["geometry", "body", "wind", "stability"],
     ) -> tuple[Vectorizable, Vectorizable, Vectorizable]:
         """
         Converts a vector [x_from, y_from, z_from], as given in the `from_axes` frame, to an equivalent vector [x_to,