him_search() WIP

pyrmv/enums/__init__.py

@@ -3,5 +3,8 @@ from .rt_mode import RealTimeMode
 from .lang import Language
 from .location_type import LocationType
 from .selection_mode import SelectionMode
+from .search_mode import SearchMode
 from .filter_mode import FilterMode
-from .board_type import BoardArrivalType, BoardDepartureType
+from .board_type import BoardArrivalType, BoardDepartureType
+from .aff_journey_mode import AffectedJourneyMode
+from .aff_journey_stop_mode import AffectedJourneyStopMode

pyrmv/enums/aff_journey_mode.py

@@ -0,0 +1,11 @@
+from enum import auto
+from .auto_name import AutoName
+
+class AffectedJourneyMode(AutoName):
+    """Enumeration used to declare types of HIM search modes."""
+
+    ALL = auto()
+    "Return affected journeys."
+
+    OFF = auto()
+    "Do not return affected journeys."

pyrmv/enums/aff_journey_stop_mode.py

@@ -0,0 +1,14 @@
+from enum import auto
+from .auto_name import AutoName
+
+class AffectedJourneyStopMode(AutoName):
+    """Enumeration used to declare types of affected journey stops return modes."""
+
+    ALL = auto()
+    "Return all affected stops of affected journeys."
+
+    IMP = auto()
+    "Return important stops of affected journeys."
+
+    OFF = auto()
+    "Do not return stops of affected journeys."

pyrmv/enums/search_mode.py

@@ -0,0 +1,14 @@
+from enum import auto
+from .auto_name import AutoName
+
+class SearchMode(AutoName):
+    """Enumeration used to declare types of HIM search modes."""
+
+    MATCH = auto()
+    "Iterate over all trips to find HIM messages."
+
+    NOMATCH = auto()
+    "Iterate over all HIM messages available."
+
+    TFMATCH = auto()
+    "Uses filters defined `metas` parameter."