Merge pull request #1047 from RocketPy-Team/fix/pre-release-hardening

FIX: pre release hardening

Author: Gui-FernandesBR

.github/workflows/changelog.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Clone RocketPy
-        uses: actions/checkout@main
+        uses: actions/checkout@v4
         with:
           repository: RocketPy-Team/RocketPy
           ref: develop
@@ -27,31 +27,52 @@ jobs:
           PR_NUMBER: ${{ github.event.pull_request.number }}
           PR_LABELS: ${{ join(github.event.pull_request.labels.*.name, ',') }}
         run: |
-          SECTION="### Added"
-          PREFIX="ENH"
-
-          if [[ "$PR_LABELS" == *"Bug"* ]]; then
-            SECTION="### Fixed"
-            PREFIX="BUG"
-          elif [[ "$PR_LABELS" == *"Refactor"* ]]; then
-            SECTION="### Changed"
-            PREFIX="MNT"
-          elif [[ "$PR_LABELS" == *"Docs"* ]] && [[ "$PR_LABELS" == *"Git housekeeping"* ]]; then
-            SECTION="### Changed"
-            PREFIX="DOC"
-          elif [[ "$PR_LABELS" == *"Tests"* ]]; then
-            SECTION="### Changed"
-            PREFIX="TST"
-          elif [[ "$PR_LABELS" == *"Docs"* ]]; then
-            # Only documentation -> Added section
-            SECTION="### Added"
-            PREFIX="DOC"
-          fi
-
-          ENTRY="- $PREFIX: $PR_TITLE [#$PR_NUMBER](https://github.com/RocketPy-Team/RocketPy/pull/$PR_NUMBER)"
-          SECTION_LINE=$(grep -n "^$SECTION$" CHANGELOG.md | head -1 | cut -d: -f1)
-
-          sed -i "$((SECTION_LINE + 1))a\\$ENTRY" CHANGELOG.md
+          # The PR title is untrusted input, so it is read from the environment
+          # inside Python rather than interpolated into a shell/sed program.
+          # This avoids both shell injection and sed breaking on special
+          # characters (\, /, &, newlines) in the title.
+          python - <<'PY'
+          import os
+
+          labels = os.environ.get("PR_LABELS", "")
+          title = os.environ["PR_TITLE"]
+          number = os.environ["PR_NUMBER"]
+
+          section, prefix = "### Added", "ENH"
+          if "Bug" in labels:
+              section, prefix = "### Fixed", "BUG"
+          elif "Refactor" in labels:
+              section, prefix = "### Changed", "MNT"
+          elif "Docs" in labels and "Git housekeeping" in labels:
+              section, prefix = "### Changed", "DOC"
+          elif "Tests" in labels:
+              section, prefix = "### Changed", "TST"
+          elif "Docs" in labels:
+              section, prefix = "### Added", "DOC"
+
+          entry = (
+              f"- {prefix}: {title} "
+              f"[#{number}](https://github.com/RocketPy-Team/RocketPy/pull/{number})\n"
+          )
+
+          with open("CHANGELOG.md", encoding="utf-8") as handle:
+              lines = handle.readlines()
+
+          for index, line in enumerate(lines):
+              if line.rstrip("\n") == section:
+                  insert_at = index + 1
+                  # Place the entry at the top of the list, after the single
+                  # blank line that follows the section header.
+                  if insert_at < len(lines) and lines[insert_at].strip() == "":
+                      insert_at += 1
+                  lines.insert(insert_at, entry)
+                  break
+          else:
+              raise SystemExit(f"Section {section!r} not found in CHANGELOG.md")
+
+          with open("CHANGELOG.md", "w", encoding="utf-8") as handle:
+              handle.writelines(lines)
+          PY
 
       - name: Push Changes
         run: |

.github/workflows/docs.yml

@@ -22,6 +22,10 @@ on:
       - ".readthedocs.yaml"
       - ".github/workflows/docs.yml"
 
+# Least privilege: this workflow only needs to read the repository.
+permissions:
+  contents: read
+
 defaults:
   run:
     shell: bash
@@ -42,13 +46,13 @@ jobs:
       # (reStructuredText, cross-references, toctrees, autodoc API reference).
       DOCS_SKIP_EXECUTE: "1"
     steps:
-      - uses: actions/checkout@main
+      - uses: actions/checkout@v4
 
       - name: Install pandoc (required by nbsphinx)
         run: sudo apt-get update && sudo apt-get install -y pandoc
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@main
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
@@ -64,7 +68,7 @@ jobs:
           pip install .[all]
 
       - name: Cache Sphinx doctrees
-        uses: actions/cache@main
+        uses: actions/cache@v4
         with:
           path: docs/_build/doctrees
           key: sphinx-doctrees-${{ github.ref }}-${{ hashFiles('docs/**', 'rocketpy/**') }}
@@ -96,7 +100,7 @@ jobs:
 
       - name: Upload built HTML
         if: always()
-        uses: actions/upload-artifact@main
+        uses: actions/upload-artifact@v4
         with:
           name: docs-html
           path: docs/_build/html

CHANGELOG.md

@@ -57,8 +57,6 @@ Attention: The newest changes should be on top -->
 
 ### Changed
 
-- 
-
 ### Deprecated
 
 - MNT: Rename `radius` to `radius_function` in `CylindricalTank` and `SphericalTank`; old `radius=` keyword argument now raises `DeprecationWarning` [#957](https://github.com/RocketPy-Team/RocketPy/pull/957)
@@ -69,6 +67,7 @@ Attention: The newest changes should be on top -->
 
 ### Fixed
 
+- FIX: pre-release hardening — bug fixes across the unreleased features [#1047](https://github.com/RocketPy-Team/RocketPy/pull/1047)
 - BUG: Remove duplicate controller process; controllers were being invoked twice per time node [#949](https://github.com/RocketPy-Team/RocketPy/pull/949)
 - BUG: fix wind heading and direction wraparound interpolation [#974](https://github.com/RocketPy-Team/RocketPy/pull/974)
 - BUG: fix NaN in ND linear interpolation outside convex hull (closes [#926](https://github.com/RocketPy-Team/RocketPy/issues/926)) [#969](https://github.com/RocketPy-Team/RocketPy/pull/969)

README.md

@@ -316,7 +316,9 @@ Here is just a quick taste of what RocketPy is able to calculate. There are hund
 If you want to see the trajectory on Google Earth, RocketPy acn easily export a KML file for you:
 
 ```python
-test_flight.export_kml(file_name="test_flight.kml")
+from rocketpy.simulation import FlightDataExporter
+
+FlightDataExporter(test_flight).export_kml(file_name="test_flight.kml")
 ```
 
 <img alt="6-DOF Trajectory Plot" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/trajectory-earth.png" width="501">

docs/notebooks/getting_started.ipynb

@@ -1249,24 +1249,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "File  trajectory.kml  saved with success!\n"
-     ]
-    }
-   ],
-   "source": [
-    "test_flight.export_kml(\n",
-    "    file_name=\"trajectory.kml\",\n",
-    "    extrude=True,\n",
-    "    altitude_mode=\"relative_to_ground\",\n",
-    ")"
-   ]
+   "outputs": [],
+   "source": "from rocketpy.simulation import FlightDataExporter\n\nFlightDataExporter(test_flight).export_kml(\n    file_name=\"trajectory.kml\",\n    extrude=True,\n    altitude_mode=\"relative_to_ground\",\n)"
   },
   {
    "attachments": {},
@@ -1600,4 +1586,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

docs/notebooks/getting_started_colab.ipynb

@@ -591,13 +591,7 @@
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "test_flight.export_kml(\n",
-    "    file_name=\"trajectory.kml\",\n",
-    "    extrude=True,\n",
-    "    altitude_mode=\"relative_to_ground\",\n",
-    ")"
-   ]
+   "source": "from rocketpy.simulation import FlightDataExporter\n\nFlightDataExporter(test_flight).export_kml(\n    file_name=\"trajectory.kml\",\n    extrude=True,\n    altitude_mode=\"relative_to_ground\",\n)"
   },
   {
    "cell_type": "markdown",
@@ -842,4 +836,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

docs/user/first_simulation.rst

@@ -589,7 +589,7 @@ Use the dedicated exporter class:
 
 .. note::
 
-    The legacy method ``Flight.export_kml`` is deprecated. Use
+    The legacy method ``Flight.export_kml`` was removed in v1.13.0. Use
     :meth:`rocketpy.simulation.flight_data_exporter.FlightDataExporter.export_kml`.
 
 Manipulating results
@@ -689,7 +689,7 @@ by not passing any attribute names:
 
 .. note::
 
-    The legacy method ``Flight.export_data`` is deprecated. Use
+    The legacy method ``Flight.export_data`` was removed in v1.13.0. Use
     :meth:`rocketpy.simulation.flight_data_exporter.FlightDataExporter.export_data`.
 
 Saving and Storing Plots

rocketpy/__init__.py

@@ -1,5 +1,3 @@
-import logging
-
 from . import utils
 from .control import _Controller
 from .environment import Environment, EnvironmentAnalysis
@@ -72,5 +70,3 @@
     StochasticTail,
     StochasticTrapezoidalFins,
 )
-
-logging.getLogger(__name__).addHandler(logging.NullHandler())

rocketpy/_encoders.py

@@ -1,6 +1,7 @@
 """Defines a custom JSON encoder for RocketPy objects."""
 
 import json
+import warnings
 from datetime import datetime
 from importlib import import_module
 
@@ -133,7 +134,13 @@ def object_hook(self, obj):
                     if hash_ is not None:
                         setattr(new_obj, "__rpy_hash", hash_)
                     return new_obj
-            except (ImportError, AttributeError):
+            except (ImportError, AttributeError) as exc:
+                warnings.warn(
+                    "Could not reconstruct a RocketPy object from the stored "
+                    f"signature {signature!r}: {exc}. Returning the raw data "
+                    "dictionary instead; the loaded object may be incomplete.",
+                    stacklevel=2,
+                )
                 return obj
         else:
             return obj
@@ -239,10 +246,23 @@ def get_class_from_signature(signature):
     type
         Class defined by the signature.
     """
-    module = import_module(signature["module"])
+    module_name = signature["module"]
+    name = signature["name"]
+
+    # Backward compatibility: the parachute module was moved to the
+    # ``rocketpy.rocket.parachutes`` subpackage and the old concrete
+    # ``Parachute`` class became an abstract base, with the hemispherical model
+    # split out. Remap the legacy signature so ``.rpy`` files saved with older
+    # versions reconstruct as a concrete ``HemisphericalParachute`` instead of
+    # silently falling back to a raw dictionary.
+    if module_name == "rocketpy.rocket.parachute" and name == "Parachute":
+        module_name = "rocketpy.rocket.parachutes.hemispherical_parachute"
+        name = "HemisphericalParachute"
+
+    module = import_module(module_name)
     inner_class = None
 
-    for class_ in signature["name"].split("."):
+    for class_ in name.split("."):
         inner_class = getattr(module, class_)
 
     return inner_class

rocketpy/environment/environment.py

@@ -701,7 +701,6 @@ def __validate_dictionary(self, file, dictionary):
             "HRRR",
             "HIRESW",
             "GEFS",
-            "ERA5",
             "MERRA2",
         ]
         if isinstance(dictionary, str):
@@ -1166,10 +1165,16 @@ def __determine_pressure_conversion_factor(
 
         # Auto-detect. Primary source: known-model lookup table.
         # Fallback: units attribute inside the file.
-        _hpa_dicts = {"ECMWF", "ECMWF_V0", "ERA5", "MERRA2"}
-        _pa_files = {"GFS", "NAM", "RAP", "HRRR", "AIGFS", "HIRESW", "GEFS"}
+        # THREDDS (UCAR) models expose pressure on the 'isobaric' coordinate in
+        # Pa; NOMADS-GrADS models (GEFS, HIRESW) expose it on the 'lev'
+        # coordinate in hPa/millibars and must be scaled by 100.
+        _hpa_dicts = {"ECMWF", "ECMWF_V0", "MERRA2"}
+        _hpa_files = {"GEFS", "HIRESW"}
+        _pa_files = {"GFS", "NAM", "RAP", "HRRR", "AIGFS"}
         if input_dict in _hpa_dicts or input_file in _hpa_dicts:
             return 100
+        if input_file in _hpa_files:
+            return 100
         if input_file in _pa_files:
             return 1
         return None
@@ -1219,7 +1224,7 @@ def set_atmospheric_model(  # pylint: disable=too-many-statements
             - ``"windy"``: ignored.
             - ``"forecast"``, ``"reanalysis"`` and ``"ensemble"``: local
               dictionary, or one of the built-in mappings (e.g. ``"ECMWF"``,
-              ``"GFS"``, ``"ERA5"``, ``"RAP"``, ``"HRRR"``, etc.) corresponding
+              ``"GFS"``, ``"MERRA2"``, ``"RAP"``, ``"HRRR"``, etc.) corresponding
               to the file structure.
         pressure : float, string, array, callable, optional
             This defines the atmospheric pressure profile. Should be given if