MNT: deprecated decorator

[Gui-FernandesBR]

Solves #669

[phmbressan]

Very interesting implementation.

I know that Python 3.13 added a similar decorator. I don't think it has the same custom functionalities (such as providing an alternative). Nonetheless, it is worth the read.

Since this Python is far from being RocketPy minimum required version, even if we were to use it, a custom version would be needed to support other Python versions (similarly to what happed with cached_property a few years ago). Therefore, I agree with this PR implementation.

Optionally, we could discuss the possibility of changing the parameters so that it is compatible with the Python standard one when/if we were to change to it in the future. Another idea for discussion is having the Python default one if the user has a >= 3.13 Python version.

[Copilot]

Pull Request Overview

A pull request introducing a reusable deprecated decorator and replacing inline deprecation warnings with that decorator for legacy methods.

• Added a deprecated decorator in rocketpy/tools.py to standardize deprecation notices.
• Removed manual warnings.warn(...) calls from Rocket.add_fins and Function.plot1D/plot2D, replacing them with the new decorator.
• Updated imports in affected modules to include the deprecated decorator.

Reviewed Changes

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

File	Description
rocketpy/tools.py	Added warnings import and defined the deprecated decorator.
rocketpy/rocket/rocket.py	Imported deprecated; applied decorator to add_fins and removed manual warning.
rocketpy/mathutils/function.py	Imported deprecated; applied decorator to plot1D/plot2D and removed manual warnings.

Comments suppressed due to low confidence (2)

rocketpy/tools.py:32

• Consider adding unit tests for the new deprecated decorator to verify that it emits the correct warnings and preserves function metadata.

def deprecated(reason=None, version=None, alternative=None):

rocketpy/tools.py:68

• The decorator uses functools.wraps but functools is not imported. Add import functools at the top of the file.

        @functools.wraps(func)

[Gui-FernandesBR]

Very interesting implementation.

I know that Python 3.13 added a similar decorator. I don't think it has the same custom functionalities (such as providing an alternative). Nonetheless, it is worth the read.

Since this Python is far from being RocketPy minimum required version, even if we were to use it, a custom version would be needed to support other Python versions (similarly to what happed with cached_property a few years ago). Therefore, I agree with this PR implementation.

Optionally, we could discuss the possibility of changing the parameters so that it is compatible with the Python standard one when/if we were to change to it in the future. Another idea for discussion is having the Python default one if the user has a >= 3.13 Python version.

I agree - it's great that Python 3.13 introduces a standard deprecation decorator, but as you mentioned, our minimum supported version is still far from that, so a custom solution makes sense for now. I also appreciate your point about aligning our decorator’s parameters with the standard one for easier transition in the future; that sounds like a good idea and would make any future migration smoother.

Regarding feature-detection for Python ≥3.13, we could look into conditionally using the standard decorator when available, and fall back to our custom one otherwise. However, I believe the benefits from that would not be significant.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.02%. Comparing base (4df0b38) to head (496cf0d).
Report is 26 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #830      +/-   ##
===========================================
+ Coverage    79.11%   80.02%   +0.90%     
===========================================
  Files           96       98       +2     
  Lines        11575    12003     +428     
===========================================
+ Hits          9158     9605     +447     
+ Misses        2417     2398      -19     

☔ 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.