ENH: custom warning no motor or aerosurface by Bizo883 · Pull Request #871 · RocketPy-Team/RocketPy

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

tests/unit/rocket/test_rocket.py

CHANGELOG.md

rocketpy/rocket/rocket.py

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

rocketpy/rocket/rocket.py

tests/unit/rocket/test_rocket.py

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

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

…osurface

…r: exceptions must be derived from Warning, not <class 'NoneType'>

Bizo883 · 2025-11-25T18:10:19Z

@Gui-FernandesBR The PR is ready for review again. Thank you!

Gui-FernandesBR · 2025-11-25T21:04:28Z

@Bizo883 can you please mark all the solved commets as 'resolved' please?

Gui-FernandesBR

I will approve and merge this PR as soon as you fix linter issues

tests/unit/rocket/test_rocket.py

codecov · 2025-11-25T21:11:39Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.29%. Comparing base (9cf3dd4) to head (dc369f0).
⚠️ Report is 3 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #871      +/-   ##
===========================================
+ Coverage    80.27%   80.29%   +0.02%     
===========================================
  Files          104      104              
  Lines        12769    12777       +8     
===========================================
+ Hits         10250    10259       +9     
+ Misses        2519     2518       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

… the top of file

rocketpy/rocket/rocket.py

Gui-FernandesBR

LGTM

Gui-FernandesBR · 2025-11-26T16:16:42Z

great implementation! It's time to merge it!

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

tests/unit/rocket/test_rocket.py Outdated Show resolved Hide resolved

CHANGELOG.md Show resolved Hide resolved

rocketpy/rocket/rocket.py Show resolved Hide resolved

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

rocketpy/rocket/rocket.py Outdated Show resolved Hide resolved

rocketpy/rocket/rocket.py Outdated Show resolved Hide resolved

rocketpy/rocket/rocket.py Outdated Show resolved Hide resolved

tests/unit/rocket/test_rocket.py Outdated Show resolved Hide resolved

C8H10O2 and others added 3 commits November 25, 2025 14:45

MNT: simplify checks and update docstrings in rocket.py

39a23cf

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

Merge branch 'develop' into enh/custom-warning-no-motor-parachute-aer…

43107d3

…osurface

TST:update test_check_missing_no_components_missing to avoid TypeErro…

192455e

…r: exceptions must be derived from Warning, not <class 'NoneType'>

Gui-FernandesBR reviewed Nov 25, 2025

View reviewed changes

tests/unit/rocket/test_rocket.py Outdated Show resolved Hide resolved

Bizo883 added 2 commits November 26, 2025 09:58

TST:update test_check_missing_no_components_missing:import the lib at…

6e16e60

… the top of file

TST:update test_check_missing_no_components_missing:import the lib at…

85544e6

… the top of file

Gui-FernandesBR approved these changes Nov 26, 2025

View reviewed changes

github-project-automation bot moved this from Backlog to Next Version in LibDev Roadmap Nov 26, 2025

Fix lint errors

dc369f0

Bizo883 commented Nov 26, 2025

View reviewed changes

rocketpy/rocket/rocket.py Show resolved Hide resolved

Gui-FernandesBR approved these changes Nov 26, 2025

View reviewed changes

Gui-FernandesBR merged commit 9da4565 into RocketPy-Team:develop Nov 26, 2025
10 checks passed

github-project-automation bot moved this from Next Version to Closed in LibDev Roadmap Nov 26, 2025

Gui-FernandesBR changed the title ~~Enh/custom warning no motor parachute aerosurface~~ ENH: custom warning no motor or aerosurface Nov 27, 2025

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Gui-FernandesBR commented Nov 19, 2025

Uh oh!

Bizo883 commented Nov 25, 2025

Uh oh!

Gui-FernandesBR commented Nov 25, 2025

Uh oh!

Gui-FernandesBR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Gui-FernandesBR left a comment

Choose a reason for hiding this comment

Uh oh!

Gui-FernandesBR commented Nov 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Bizo883 commented Nov 5, 2025 •

edited

Loading

codecov bot commented Nov 25, 2025 •

edited

Loading