Resolved open issues

ssim/ssim.py

@@ -46,9 +46,16 @@
         "DEC": 0,
     },
 }
+
+# indicates that something should run until start/end of season
+infinity_indicators = ["00XXX00"]
 
-infinity_indicators = ["00XXX00"]  # indicates that something should run until start/end of season
-
+# According to the Standard Schedules Information Manual (IATA, March 2011)
+# the information following the characters "VV" refers to the aircraft version
+# reference code and is thereby not of interest to determine the configuration.
+# Since the script removes all spaces from the configuration string, "VV" is 
+# sufficient to separate the configuration part from the aircraft version part
+acv_splitter = "VV" 
 
 def find_season_dates(season):
     # type: (str) -> (str, str)
@@ -152,12 +159,18 @@ def _expand(record, date_format="%d%b%y", season=None):
     period_of_operation_from = record["period_of_operation_from"]
     if period_of_operation_from in infinity_indicators:
         if season:
+            log_text = (
+                "Found infinity indicator %s as start date -> "
+                "set to start of season %s"
+                % (period_of_operation_from, season)
+            )
+            logging.warning(log_text)
             period_of_operation_from = find_season_dates(season)[0]
         else:
             raise ValueError(
                 "Found infinity indicator "
                 + period_of_operation_from
-                + " in file, but no season specified. Pleas sepcify season. \n"
+                + " in file, but no season specified. Pleas specify season. \n"
                 + record["raw"]
             )
     else:
@@ -166,12 +179,18 @@ def _expand(record, date_format="%d%b%y", season=None):
     period_of_operation_to = record["period_of_operation_to"]
     if period_of_operation_to in infinity_indicators:
         if season:
+            log_text = (
+                "Found infinity indicator %s as end date -> "
+                "set to end of season %s"
+                % (period_of_operation_to, season)
+            )
+            logging.warning(log_text)
             period_of_operation_to = find_season_dates(season)[-1]
         else:
             raise ValueError(
                 "Found infinity indicator "
                 + period_of_operation_to
-                + " in file, but no season specified. Pleas sepcify season. \n"
+                + " in file, but no season specified. Pleas specify season. \n"
                 + record["raw"]
             )
     else:
@@ -586,16 +605,17 @@ def _uniformize_sim(s):
     return uniform_slots
 
 
-def read(file, iata_airport=None):
+def read(file, iata_airport=None, encoding='UTF-8'):
     """
     Reads, detects filetype, parses and processes a valid flight records file.
 
     Parameters
     ----------.
-    file : path to a slotfile.
+    file: path to a slotfile.
     airport_iata: 3 letter capital string indicating iata airport. If passed
     along with SIM file, it will return data from perspective of airport (as 
     SIR)
+    encoding: string, encoding format of the slotfile to be read
 
     Returns
     -------
@@ -604,7 +624,7 @@ def read(file, iata_airport=None):
     footer: dict, describing the footer of the slotfile.
     """
 
-    with open(file, "r") as f:
+    with open(file, "r", encoding=encoding) as f:
         text = f.read()
 
     slots = []
@@ -671,8 +691,13 @@ def _explode_aircraft_configuration_string(aircraft_configuration_string, raw_li
     if aircraft_configuration_string.isdigit():
         return {"seats": int(aircraft_configuration_string)}
 
-    string_remainder = aircraft_configuration_string.rstrip()
+    # remove unnecessary elements from aircraft_configuration_string
+    acv_string = aircraft_configuration_string.strip().replace(' ', '')
+    # split acv_string on acv_splitter, which separates relevant acv info
+    # from aircraft version reference code
+    acv_context = acv_string.split(acv_splitter)
 
+    # all possible seat class designators
     seat_class_designators = [
         "P",
         "F",
@@ -702,62 +727,62 @@ def _explode_aircraft_configuration_string(aircraft_configuration_string, raw_li
         "R",
     ]
 
-    cargo_designators = ["LL", "PP"]  # unit load devices (containers)  # pallets
+    # unit load devices (containers), number of pallets
+    cargo_designators = [
+        "LL", 
+        "PP"
+    ]  
+
+    # general designator-units
+    general_designators = [
+        "BB"
+    ]  
 
-    integer_designators = {"seats": seat_class_designators, "cargo": cargo_designators}
+    # combine all approved designators per designator-group
+    allowed_designators = {
+        **{x: "seats" for x in seat_class_designators},
+        **{y: "cargo" for y in cargo_designators},
+        **{z: "general" for z in general_designators}
+    }
 
     acv_info = {}
 
-    # seat designator should be in fixed order according to standard
-    for designator_type, designators in integer_designators.items():
-        for designator in designators:
-            if string_remainder.startswith(designator) and (  # only continue if string starts with designator and...
-                len(designator) > 1
-                or not (  # either have a multi length designator
-                    (len(string_remainder) > 1 and string_remainder[1] == string_remainder[0])
-                    or string_remainder.startswith("V V")
-                )
-            ):  #
-
-                acv_info_key = designator_type + "_" + designator
-
-                # for next iteration, remove designator from beginning of string
-                string_remainder = string_remainder[len(designator):]
-
-                # standard specifies that there may be an int following. If not return empty string (to later on destinguish from NaN if data gets put in a data frame)
-                acv_info_val = ""
-                acv_regex = re.search(r"^\d*", string_remainder).group()
-
-                # if int found, add it to total and remove it from string to process as well
-                if acv_regex:
-                    acv_info_val = int(acv_regex)
-                    if designator_type == "seats":
-                        if designator_type in acv_info.keys():
-                            acv_info[designator_type] += acv_info_val
-                        else:
-                            acv_info[designator_type] = acv_info_val
-
-                    string_remainder = string_remainder[len(acv_regex):]
-
-                # store found information
-                acv_info[acv_info_key] = acv_info_val
-
-    # remainer are general designators
-    if string_remainder.startswith("BB"):
-        acv_info["BB"] = ""
-
-    # aircraft type
-    if string_remainder.startswith("VV"):
-        acv_info["VV"] = string_remainder[2:]
-    elif string_remainder.startswith("V V"):  # aircraft type alt. Assuming it won't appear together with VV.
-        acv_info["V V"] = string_remainder[3:]
-    elif len(string_remainder.strip()):
-        log_text = (
-            "After trying to process aircraft configuration string, there should be no remainder. However, the following string remains in this instance: (%s)"
-            % string_remainder
-        )
-        if raw_line:
-            log_text += "\n Raw slot line: " + raw_line
-        logging.warning(log_text)
+    # if aircraft version reference code found in acv_string, store it in dict
+    if len(acv_context) > 1:
+        acv_info[acv_splitter] = acv_context[1]
+    # find all designator-value pairs, and loop over them to group information
+    included_designators = re.findall(r'(\w+?)(\d+)', acv_context[0])
+    for designator_pair in included_designators:
+        # verification that a designator pair includes both unit and value
+        assert len(designator_pair) == 2, \
+            "designator_pair does not contain type and number information"
+
+        designator = designator_pair[0]
+        acv_info_val = int(designator_pair[1])
+
+        # determine designator-group, and warn user if no group found
+        if designator in allowed_designators.keys():
+            acv_info_type = allowed_designators[designator]
+        else:
+            log_text = (
+                "Designator (%s) is not recognised as valid type. "
+                "Please check schedule"
+                % designator
+            )
+            if raw_line:
+                log_text += "\n Raw slot line: " + raw_line
+            logging.warning(log_text)
+            acv_info_type = "unknown"
+        acv_info_key = acv_info_type + "_" + designator            
+
+        # if designator-group is seats, add found value to seats-total
+        if acv_info_type == "seats":
+            if acv_info_type in acv_info.keys():
+                acv_info[acv_info_type] += acv_info_val
+            else:
+                acv_info[acv_info_type] = acv_info_val
+
+        # store found information
+        acv_info[acv_info_key] = acv_info_val
 
     return acv_info

test/data/aircraft_configuration_strings.yml

@@ -20,3 +20,19 @@
     seats: 189
     seats_Y: 189
     VV: 738H189
+
+- string: J50Y202O24VV10
+  aircraft_configuration:
+    seats: 276
+    seats_J: 50
+    seats_O: 24
+    seats_Y: 202
+    VV: '10'
+
+- string: J50O24Y202VV10
+  aircraft_configuration:
+    seats: 276
+    seats_J: 50
+    seats_O: 24
+    seats_Y: 202
+    VV: '10'