Enh/custom warning no motor parachute aerosurface (#871)

* DOC: Add entry for custom warnings in CHANGELOG.md

Added a placeholder in the [Unreleased] section for the upcoming feature
to add custom warnings when a rocket is missing motors and/or aero-surface. See #285.

* ENH: add custom warning for Rocket with no components

This enhancement adds a warning when a Rocket object has no motors,
parachutes, or AeroSurface components. It notifies the user so that
they can add missing components before running simulations. See #285

* ENH:Add tests for _check_missing_components method in Rocket class

* TST:improve test_check_missing_no_components_missing to correctly handle warnings

* BUG: do not warn for rockets without parachute

Only warn if motor or aerodynamic surfaces are missing. Never raise a warning for no parachute. See #285

* TST:Update the test:do not warn when missing parachute

* MNT: simplify checks and update docstrings in rocket.py

- Removed redundant len() check for aerodynamic_surfaces.
- Added 'Returns: None' section to NumPy-style docstring.
- Removed redundant '[WARNING]' prefix in warnings messages.

* TST:update test_check_missing_no_components_missing to avoid TypeError: exceptions must be derived from Warning, not <class 'NoneType'>

* TST:update test_check_missing_no_components_missing:import the lib at the top of file

* TST:update test_check_missing_no_components_missing:import the lib at the top of file

* Fix lint errors

---------

Co-authored-by: Tang Xiaoyu <[email protected]>
Co-authored-by: Marchma0 <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -32,6 +32,8 @@ Attention: The newest changes should be on top -->
 
 ### Added
 
+- ENH: Custom Exception errors and messages [#285](https://github.com/RocketPy-Team/RocketPy/issues/285)
+
 ### Changed
 
 ### Fixed

rocketpy/rocket/rocket.py

@@ -384,6 +384,35 @@ def __init__(  # pylint: disable=too-many-statements
         self.prints = _RocketPrints(self)
         self.plots = _RocketPlots(self)
 
+    def _check_missing_components(self):
+        """Check if the rocket is missing any essential components and issue a warning.
+
+        This method verifies whether the rocket has the following key components:
+        - motor
+        - aerodynamic surface(s)
+
+        If any of these components are missing, a single warning message is issued
+        listing all missing components. This helps users quickly identify potential
+        issues before running simulations or analyses.
+
+        Notes
+        -----
+        - The warning uses Python's built-in `warnings.warn` function.
+
+        Returns
+        -------
+        None
+        """
+        missing_components = []
+        if isinstance(self.motor, EmptyMotor):
+            missing_components.append("motor")
+        if not self.aerodynamic_surfaces:
+            missing_components.append("aerodynamic surfaces")
+
+        if missing_components:
+            component_list = ", ".join(missing_components)
+            warnings.warn(f"Rocket has no {component_list} defined.", UserWarning)
+
     @property
     def nosecones(self):
         """A list containing all the nose cones currently added to the rocket."""

tests/unit/rocket/test_rocket.py

@@ -1,3 +1,4 @@
+import warnings
 from unittest.mock import patch
 
 import numpy as np
@@ -370,6 +371,39 @@ def test_add_motor(calisto_motorless, cesaroni_m1670):
     assert center_of_mass_motorless is not center_of_mass_with_motor
 
 
+def test_check_missing_all_components(calisto_motorless):
+    """Tests the _check_missing_components method for a Rocket with no components."""
+    with pytest.warns(UserWarning) as record:
+        calisto_motorless._check_missing_components()
+
+    assert len(record) == 1
+    msg = str(record[0].message)
+    assert "motor" in msg
+    assert "aerodynamic surfaces" in msg
+
+
+def test_check_missing_some_components(calisto):
+    """Tests the _check_missing_components method for a Rocket missing some components."""
+    calisto.aerodynamic_surfaces = []
+
+    with pytest.warns(UserWarning) as record:
+        calisto._check_missing_components()
+
+    assert len(record) == 1
+    msg = str(record[0].message)
+    assert "aerodynamic surfaces" in msg
+
+
+def test_check_missing_no_components_missing(calisto_robust):
+    """Tests the _check_missing_components method for a complete Rocket."""
+    # Catch all warnings that occur inside this 'with' block.
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        calisto_robust._check_missing_components()
+        # For a complete rocket, this method should NOT issue any warnings.
+    assert len(w) == 0
+
+
 def test_set_rail_button(calisto):
     rail_buttons = calisto.set_rail_buttons(0.2, -0.5, 30)
     # assert buttons_distance