Merge pull request #477 from RocketPy-Team/enh/get-attributes

ENH: Get Instance Attributes

rocketpy/environment/environment.py

@@ -2365,7 +2365,7 @@ def process_forecast_reanalysis(self, file, dictionary):
         self.wind_vs = wind_vs
         self.levels = levels
         self.temperatures = temperatures
-        self.time_array = time_array
+        self.time_array = time_array[:].tolist()
         self.height = height
 
         # Close weather data
@@ -2735,7 +2735,7 @@ def process_ensemble(self, file, dictionary):
         self.wind_vs = wind_vs
         self.levels = levels
         self.temperatures = temperatures
-        self.time_array = time_array
+        self.time_array = time_array[:].tolist()
         self.height = height
 
         # Close weather data
@@ -3126,7 +3126,19 @@ def all_plot_info_returned(self):
         ------
         plot_info : Dict
             Dict of data relevant to plot externally
+
+        Warning
+        -------
+        Deprecated in favor of `utilities.get_instance_attributes`.
+
         """
+        warnings.warn(
+            "The method 'all_plot_info_returned' is deprecated as of version "
+            + "1.2 and will be removed in version 1.4 "
+            + "Use 'utilities.get_instance_attributes' instead.",
+            DeprecationWarning,
+        )
+
         grid = np.linspace(self.elevation, self.max_expected_height)
         plot_info = dict(
             grid=[i for i in grid],
@@ -3187,7 +3199,18 @@ def all_info_returned(self):
         ------
         info : Dict
             Information relevant about the Environment class.
+
+        Warning
+        -------
+        Deprecated in favor of `utilities.get_instance_attributes`.
+
         """
+        warnings.warn(
+            "The method 'all_info_returned' is deprecated as of version "
+            + "1.2 and will be removed in version 1.4 "
+            + "Use 'utilities.get_instance_attributes' instead.",
+            DeprecationWarning,
+        )
 
         # Dictionary creation, if not commented follows the SI
         info = dict(

rocketpy/utilities.py

@@ -1,3 +1,4 @@
+import inspect
 import traceback
 import warnings
 
@@ -654,3 +655,25 @@ def liftoff_speed(mass):
     if plot:
         retfunc.plot(min_mass, max_mass, points)
     return retfunc
+
+
+def get_instance_attributes(instance):
+    """Returns a dictionary with all attributes of a given instance.
+
+    Parameters
+    ----------
+    instance : object
+        Instance of a class.
+
+    Returns
+    -------
+    dictionary
+        Dictionary with all attributes of the given instance.
+    """
+    attributes_dict = dict()
+    members = inspect.getmembers(instance)
+    for member in members:
+        # Filter out methods and protected attributes
+        if not inspect.ismethod(member[1]) and not member[0].startswith("__"):
+            attributes_dict[member[0]] = member[1]
+    return attributes_dict

tests/test_utilities.py

@@ -161,3 +161,16 @@ def test_fin_flutter_analysis(mock_show, flight):
         )
         == None
     )
+
+
+def test_get_instance_attributes(flight_calisto_robust):
+    """Tests if get_instance_attributes returns the expected results for a
+    robust flight object."""
+
+    attributes = utilities.get_instance_attributes(flight_calisto_robust)
+    for key, value in attributes.items():
+        attr = getattr(flight_calisto_robust, key)
+        if isinstance(attr, np.ndarray):
+            assert np.allclose(attr, value)
+        else:
+            assert attr == value