Ability to hide object's motion in string output when typical of that object.

Author: theriftlab

immanuel/classes/wrap.py

@@ -235,7 +235,7 @@ def __str__(self) -> str:
         if hasattr(self, 'house'):
             formatted += f', {_(self.house)}'
 
-        if hasattr(self, 'movement'):
+        if hasattr(self, 'movement') and (settings.output_typical_object_motion or not self.movement.typical):
             formatted += f', {_(self.movement)}'
 
         return formatted
@@ -247,6 +247,7 @@ def __init__(self, object: dict) -> None:
         self.direct = self._movement == calc.DIRECT
         self.stationary = self._movement == calc.STATIONARY
         self.retrograde = self._movement == calc.RETROGRADE
+        self.typical = calculate.object_movement_typical(object)
         self.formatted = _(names.OBJECT_MOVEMENTS[self._movement], gender(object['index']))
 
     def __str__(self) -> str:

immanuel/setup.py

@@ -96,6 +96,11 @@ def __init__(self) -> None:
 
         self.default_longitude = -0.0015
 
+        """ Whether or not the stringified output of chart objects should
+        always display the object's motion even when it is typical for
+        that object. """
+        self.output_typical_object_motion = False
+
         """ House system as supported by pyswisseph. """
         self.house_system = chart.PLACIDUS
 

immanuel/tools/calculate.py

@@ -11,7 +11,7 @@
 
 import swisseph as swe
 
-from immanuel.const import calc
+from immanuel.const import calc, chart
 from immanuel.tools import ephemeris
 
 
@@ -58,6 +58,18 @@ def object_movement(object: dict | float) -> int:
     return calc.DIRECT if speed > calc.STATION_SPEED else calc.RETROGRADE
 
 
+def object_movement_typical(object: dict) -> bool:
+    """ Returns whether an object's movement is typical, ie. direct for planets,
+    retrograde for nodes, stationary for Part of Fortune and eclipses. """
+    if object['index'] in (chart.PARS_FORTUNA, chart.PRE_NATAL_SOLAR_ECLIPSE, chart.PRE_NATAL_LUNAR_ECLIPSE, chart.POST_NATAL_SOLAR_ECLIPSE, chart.POST_NATAL_SOLAR_ECLIPSE):
+        return True
+
+    movement = object_movement(object)
+    is_node = object['index'] in (chart.NORTH_NODE, chart.SOUTH_NODE, chart.TRUE_NORTH_NODE, chart.TRUE_SOUTH_NODE)
+
+    return movement == calc.RETROGRADE if is_node else movement == calc.DIRECT
+
+
 def is_out_of_bounds(object: dict | float, jd: float = None, obliquity: float = None) -> bool:
     """ Returns whether the passed object is out of bounds either on the passed
     Julian date or relative to the passed obliquity. """