Enh/custom warning no motor parachute aerosurface #871

Bizo883 · 2025-11-05T15:21:59Z

Pull request type

Code changes (bugfix, features)
Code maintenance (refactoring, formatting, tests)
ReadMe, Docs and GitHub updates

Checklist

Tests for the changes have been added (if needed)
Docs have been reviewed and added / updated
Lint (black rocketpy/ tests/) has passed locally
All tests (pytest tests -m slow --runslow) have passed locally
CHANGELOG.md has been updated (if relevant)

Current behavior

There is no test for the _check_missing_components().

New behavior

This PR adds unit tests to verify the warning behavior of the _check_missing_components() method.
Specifically, it includes three test cases:

All components missing → expects a single warning listing all missing elements.
Some components missing → ensures only the absent components appear in the warning message.
No components missing → ensures no warning is issued.

These tests are defined in tests/unit/test_rocket.py.

Breaking change

Yes
No

Gui-FernandesBR · 2025-11-05T18:16:40Z

tests/unit/rocket/test_rocket.py

+    """Tests the _check_missing_components method for a complete Rocket."""
+    # Call directly — no warnings expected
+    calisto_robust._check_missing_components()
+    # If any warning occurs, pytest will fail automatically


are you sure?

# If any warning occurs, pytest will fail automatically

Thank you for the review!You're correct.By default, pytest only displays warnings but doesn't fail.I will updated the test.

Gui-FernandesBR · 2025-11-05T18:17:10Z

CHANGELOG.md

changelog seems weird @phmbressan

Thanks for your feedback. Could you please clarify which part of the changelog seems weird? I want to make sure my addition follows the proper format.

your added line is listed along together other changes that have already been deployed

changelog seems weird @phmbressan

I can double-check later, but this branch might not be up to date with develop (v1.11), which is why the CHANGELOG seems outdated. Could you @C8H10O2 try rebasing this branch with the current develop so that all conflicts are sorted out?

changelog seems weird @phmbressan

I can double-check later, but this branch might not be up to date with develop (v1.11), which is why the CHANGELOG seems outdated. Could you @C8H10O2 try rebasing this branch with the current develop so that all conflicts are sorted out?

Understood, I’ll take care of it. Thanks for pointing it out.

Gui-FernandesBR · 2025-11-05T18:18:24Z

rocketpy/rocket/rocket.py

a rocket without parachute is something quite common.

Following up on issue #285 and your comment:

#285 (comment)

I wanted to clarify: for rockets without parachutes, should the custom warning be changed to a notice/info message instead, or should it only trigger under specific conditions?

we should never raise an warning for "parachuteless rockets", so to say

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 RocketPy-Team#285.

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 RocketPy-Team#285

…dle warnings

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

Copilot

Pull Request Overview

This PR adds unit tests for the new _check_missing_components() method in the Rocket class, which verifies whether a rocket has essential components (motor and aerodynamic surfaces) and issues warnings when components are missing.

Adds _check_missing_components() method to detect missing rocket components
Implements three unit tests covering all scenarios: all components missing, some missing, and none missing
Updates CHANGELOG to document the enhancement

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
rocketpy/rocket/rocket.py	Adds `_check_missing_components()` method to warn users about missing motor or aerodynamic surfaces
tests/unit/rocket/test_rocket.py	Adds three unit tests to verify warning behavior for different component configurations
CHANGELOG.md	Documents the custom exception errors and messages enhancement

Copilot · 2025-11-19T01:53:36Z

rocketpy/rocket/rocket.py

+        missing_components = []
+        if isinstance(self.motor, EmptyMotor):
+            missing_components.append("motor")
+        if not self.aerodynamic_surfaces or len(self.aerodynamic_surfaces) == 0:


The condition not self.aerodynamic_surfaces already covers empty lists, making the explicit len(self.aerodynamic_surfaces) == 0 check redundant. Simplify to just if not self.aerodynamic_surfaces:.

Suggested change

if not self.aerodynamic_surfaces or len(self.aerodynamic_surfaces) == 0:

if not self.aerodynamic_surfaces:

Copilot · 2025-11-19T01:53:37Z

rocketpy/rocket/rocket.py

+        Notes:
+        - The warning uses Python's built-in `warnings.warn` function.


The docstring is missing a 'Returns' section. According to NumPy docstring format, if a method doesn't return anything, it should include 'Returns\n-------\nNone' to be explicit. This aligns with RocketPy's requirement for comprehensive NumPy-style docstrings.

Suggested change

Notes:

- The warning uses Python's built-in `warnings.warn` function.

Notes

-----

- The warning uses Python's built-in `warnings.warn` function.

Returns

-------

None

Copilot · 2025-11-19T01:53:37Z

rocketpy/rocket/rocket.py

+        if missing_components:
+            component_list = ", ".join(missing_components)
+            warnings.warn(
+                f"[WARNING] Rocket has no {component_list} defined.", UserWarning


The '[WARNING]' prefix in the warning message is redundant since warnings.warn() already identifies messages as warnings. Remove the prefix to avoid duplication: f'Rocket has no {component_list} defined.'

Suggested change

f"[WARNING] Rocket has no {component_list} defined.", UserWarning

f"Rocket has no {component_list} defined.", UserWarning

Copilot · 2025-11-19T01:53:37Z

tests/unit/rocket/test_rocket.py

+
+def test_check_missing_some_components(calisto):
+    """Tests the _check_missing_components method for a Rocket missing some components."""
+    calisto.parachutes = []


The test modifies calisto.parachutes = [] on line 388, but the _check_missing_components() method doesn't check for parachutes—only motor and aerodynamic surfaces. This modification is unnecessary and may confuse future maintainers about what the method actually validates. Remove line 388.

Suggested change

calisto.parachutes = []

Gui-FernandesBR · 2025-11-19T02:00:44Z

@Bizo883 please address all the comments, fix tests and linters. You can let me know when the PR is ready for review again

Bizo883 requested a review from a team as a code owner November 5, 2025 15:22

github-project-automation bot added this to LibDev Roadmap Nov 5, 2025

github-project-automation bot moved this to Backlog in LibDev Roadmap Nov 5, 2025

Gui-FernandesBR reviewed Nov 5, 2025

View reviewed changes

C8H10O2 and others added 5 commits November 15, 2025 00:23

DOC: Add entry for custom warnings in CHANGELOG.md

1d7b2f2

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 RocketPy-Team#285.

ENH: add custom warning for Rocket with no components

4eff12e

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 RocketPy-Team#285

ENH:Add tests for _check_missing_components method in Rocket class

a4f44c4

TST:improve test_check_missing_no_components_missing to correctly han…

c00e2dd

…dle warnings

BUG: do not warn for rockets without parachute

1d75f80

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

C8H10O2 force-pushed the enh/custom-warning-no-motor-parachute-aerosurface branch from 016acae to 1d75f80 Compare November 14, 2025 23:32

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

c787b36

Gui-FernandesBR requested a review from Copilot November 19, 2025 01:50

Gui-FernandesBR changed the base branch from master to develop November 19, 2025 01:50

Copilot started reviewing on behalf of Gui-FernandesBR November 19, 2025 01:51 View session

Copilot finished reviewing on behalf of Gui-FernandesBR November 19, 2025 01:52

Copilot AI reviewed Nov 19, 2025

View reviewed changes

	if not self.aerodynamic_surfaces or len(self.aerodynamic_surfaces) == 0:
	if not self.aerodynamic_surfaces:

		Notes:
		- The warning uses Python's built-in `warnings.warn` function.

	f"[WARNING] Rocket has no {component_list} defined.", UserWarning
	f"Rocket has no {component_list} defined.", UserWarning

Uh oh!

Enh/custom warning no motor parachute aerosurface #871

Are you sure you want to change the base?

Enh/custom warning no motor parachute aerosurface #871

Conversation

Bizo883 commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request type

Checklist

Current behavior

New behavior

Breaking change

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Gui-FernandesBR commented Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Bizo883 commented Nov 5, 2025 •

edited

Loading