aims-convert 2.1__tar.gz → 2.2__tar.gz

{aims_convert-2.1 → aims_convert-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aims-convert
-Version: 2.1
+Version: 2.2
 Summary: Extract useful information from AIMS
 Home-page: https://github.com/JonHurst/aims-convert
 Author: Jon Hurst
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
 Requires-Dist: nightflight
 Requires-Dist: bs4
 Requires-Dist: html5lib
+Provides-Extra: unit-tests
+Requires-Dist: freezegun; extra == "unit-tests"
 
 # AIMS Roster Data Extraction #
 

{aims_convert-2.1 → aims_convert-2.2}/aims/cli.py

@@ -5,6 +5,7 @@ import argparse
 
 from aims.parse import parse
 import aims.output as output
+from aims.version import VERSION
 
 
 def _args():
@@ -12,14 +13,17 @@ def _args():
         description=(
             'Process an AIMS detailed roster into various useful formats.'))
     parser.add_argument('format',
-                        choices=['roster', 'efj', 'csv', 'ical'])
+                        choices=['roster', 'efj', 'csv', 'ical', 'version'])
     parser.add_argument('--ade', action="store_true")
     return parser.parse_args()
 
 
 def main() -> int:
     args = _args()
-    duties = parse(sys.stdin.read())
+    if args.format == "version":
+        print(f"Version: {VERSION}")
+        return 0
+    duties, ade = parse(sys.stdin.read())
     if args.format == "roster":
         print(output.roster(duties))
     elif args.format == "efj":
@@ -27,7 +31,9 @@ def main() -> int:
     elif args.format == "csv":
         print(output.csv(duties))
     elif args.format == "ical":
-        print(output.ical(duties, args.ade))
+        if not args.ade:
+            ade = ()
+        print(output.ical(duties, ade))
     return 0
 
 

{aims_convert-2.1 → aims_convert-2.2}/aims/data_structures.py

@@ -2,6 +2,11 @@ from typing import NamedTuple, Optional
 import datetime as dt
 
 
+class AllDayEvent(NamedTuple):
+    date: dt.date
+    code: str
+
+
 class CrewMember(NamedTuple):
     name: str
     role: str
@@ -21,9 +26,8 @@ class Sector(NamedTuple):
 
 
 class Duty(NamedTuple):
-    code: Optional[str]  # only all day event has code
     start: dt.datetime
-    finish: Optional[dt.datetime]  # all day event has None
+    finish: dt.datetime
     sectors: tuple[Sector, ...]
 
 

{aims_convert-2.1 → aims_convert-2.2}/aims/gui.py

@@ -9,8 +9,8 @@ import ctypes
 import aims.parse
 from aims.data_structures import RosterException, InputFileException
 from aims.output import csv, ical, efj
+from aims.version import VERSION
 
-VERSION = "2.1"
 
 SETTINGS_FILE = os.path.expanduser("~/.aimsgui")
 
@@ -328,7 +328,7 @@ class MainWindow(ttk.Frame):
         self.txt.insert(tk.END, "Getting registration and type info...")
         self.txt.update()
 
-        duties = aims.parse.parse(html)
+        duties, _ = aims.parse.parse(html)
         # note: normalise newlines for Text widget - will restore on output
         txt = csv(duties).replace("\r\n", "\n")
         self.txt.delete('1.0', tk.END)
@@ -338,9 +338,11 @@ class MainWindow(ttk.Frame):
         html = self.__roster_html()
         if not html:
             return
-        duties = aims.parse.parse(html)
+        duties, ade = aims.parse.parse(html)
         # note: normalise newlines for Text widget - will restore on output
-        txt = ical(duties, self.ms.with_ade.get()).replace("\r\n", "\n")
+        if not self.ms.with_ade.get():
+            ade = ()
+        txt = ical(duties, ade).replace("\r\n", "\n")
         self.txt.delete('1.0', tk.END)
         self.txt.insert(tk.END, txt, 'ical')
 
@@ -351,7 +353,7 @@ class MainWindow(ttk.Frame):
         self.txt.delete('1.0', tk.END)
         self.txt.insert(tk.END, "Working…", 'efj')
         self.txt.update()
-        duties = aims.parse.parse(html)
+        duties, _ = aims.parse.parse(html)
         txt = efj(duties)
         self.txt.delete('1.0', tk.END)
         self.txt.insert(tk.END, txt, 'efj')

{aims_convert-2.1 → aims_convert-2.2}/aims/logbook_report.py

@@ -2,7 +2,9 @@ import datetime as dt
 import re
 from typing import Optional
 
-from aims.data_structures import Duty, Sector, CrewMember
+from bs4 import BeautifulSoup  # type: ignore
+
+from aims.data_structures import Duty, Sector, CrewMember, AllDayEvent
 
 
 DATE, FLTNUM, FROM, OFF, TO, ON, TYPE, REG, BLOCK, CP = range(1, 11)
@@ -30,13 +32,13 @@ def _sector(row: tuple[str, ...]) -> Optional[Sector]:
 def _duty(sectors: tuple[Sector, ...]) -> Duty:
     lowest_off = min([X.off for X in sectors])
     highest_on = max([X.on for X in sectors])
-    return Duty(None,
-                lowest_off - dt.timedelta(hours=1),
+    return Duty(lowest_off - dt.timedelta(hours=1),
                 highest_on + dt.timedelta(minutes=30),
                 sectors)
 
 
-def duties(soup) -> tuple[Duty, ...]:
+def duties(html) -> tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]:
+    soup = BeautifulSoup(html, "html5lib")
     sectors: list[Sector] = []
     re_date = re.compile(r"^\d{2}/\d{2}/\d{2}$")
     for row in soup.find_all("tr"):
@@ -54,4 +56,4 @@ def duties(soup) -> tuple[Duty, ...]:
         else:
             groups[-1].append(sector)
         last_on = sector.on
-    return tuple(_duty(tuple(X)) for X in groups)
+    return (tuple(_duty(tuple(X)) for X in groups), ())

{aims_convert-2.1 → aims_convert-2.2}/aims/output.py

@@ -5,12 +5,15 @@ import io
 import csv as libcsv
 import datetime as dt
 import re
-from typing import Optional
+import itertools
 
-from aims.data_structures import Duty, Sector, CrewMember
+from aims.data_structures import Duty, Sector, CrewMember, AllDayEvent
 import nightflight.night as nightcalc  # type: ignore
 from nightflight.airport_nvecs import airfields as nvecs  # type: ignore
 
+UTC = Z("UTC")
+LT = Z("Europe/London")
+
 
 def clean_name(name: str) -> str:
     parts = [X.strip().capitalize() for X in name.split()]
@@ -52,46 +55,68 @@ def _night(sector: Sector) -> tuple[int, bool]:
     return (round(night_duration), night_landing)
 
 
-def _roster_sectors(
-        sectors: tuple[Sector, ...]
-) -> tuple[tuple[str, ...], int]:
-    airports: list[str] = []
+def _build_roster_string(start, end, block, string):
+    start, end = [X.replace(tzinfo=UTC).astimezone(LT)
+                  for X in (start, end)]
+    duration = int((end - start).total_seconds()) // 60
+    duration_str = f"{duration // 60}:{duration % 60:02d}"
+    block_str = f"{block // 60}:{block % 60:02d}"
+    return (f"{start:%d/%m/%Y %H:%M}-{end:%H:%M} "
+            f"{string} {block_str}/{duration_str}")
+
+
+def _roster_quasi(
+        qsectors: tuple[Sector, ...],
+        cursor: dt.datetime
+) -> tuple[tuple[str, ...], dt.datetime]:
+    retval: list[str] = []
+    name = "Brief"
+    for s in qsectors:
+        if cursor < s.off:
+            retval.append(_build_roster_string(cursor, s.off, 0, name))
+            name = "Debrief"
+        retval.append(_build_roster_string(s.off, s.on, 0, s.name))
+        cursor = s.on
+    return (tuple(retval), cursor)
+
+
+def _roster_real(
+        sectors: tuple[Sector, ...],
+        cursor: dt.datetime
+) -> tuple[str, dt.datetime]:
+    assert sectors[0].from_
+    airports: list[str] = [sectors[0].from_]
     block = 0
-    from_: Optional[str] = None
+    start = cursor
     for sector in sectors:
-        if not from_ and sector.from_:
-            from_ = sector.from_
         if sector.position:
             airports.append("[psn]")
-        elif sector.quasi:
-            if sector.from_:
-                airports.append(f"[{sector.name}]")
-            else:
-                airports.append(sector.name)
-        if sector.to:
-            airports.append(sector.to)
-        if not sector.quasi and not sector.position:
+        else:
             block += int((sector.on - sector.off).total_seconds()) // 60
-    if from_:
-        airports = [from_] + airports
-    return tuple(airports), block
+        assert sector.to
+        airports.append(sector.to)
+    cursor = sectors[-1].on + dt.timedelta(minutes=30)
+    return (
+        _build_roster_string(start, cursor, block, '-'.join(airports)),
+        cursor)
 
 
 def roster(duties: tuple[Duty, ...]) -> str:
-    UTC = Z("UTC")
-    LT = Z("Europe/London")
-    output = []
+    output: list[str] = []
     for duty in duties:
-        if not duty.finish:
+        if not duty.finish:  # an all day duty
             continue
-        start, end = [X.replace(tzinfo=UTC).astimezone(LT)
-                      for X in (duty.start, duty.finish)]
-        duration = int((end - start).total_seconds()) // 60
-        airports, block = _roster_sectors(duty.sectors)
-        duration_str = f"{duration // 60}:{duration % 60:02d}"
-        block_str = f"{block // 60}:{block % 60:02d}"
-        output.append(f"{start:%d/%m/%Y %H:%M}-{end:%H:%M} "
-                      f"{'-'.join(airports)} {block_str}/{duration_str}")
+        cursor = duty.start
+        for k, g in itertools.groupby(duty.sectors, key=lambda X: X.quasi):
+            if k:  # group of quasi sectors
+                new_output, cursor = _roster_quasi(tuple(g), cursor)
+                output += new_output
+            else:  # group of real sectors
+                new, cursor = _roster_real(tuple(g), cursor)
+                output.append(new)
+        if cursor < duty.finish:
+            output.append(
+                _build_roster_string(cursor, duty.finish, 0, "Debrief"))
     return "\n".join(output)
 
 
@@ -246,20 +271,18 @@ def _build_dict(duty: Duty) -> dict[str, str]:
     return event
 
 
-def ical(duties: tuple[Duty, ...], do_ade) -> str:
+def ical(duties: tuple[Duty, ...], ade: tuple[AllDayEvent, ...]) -> str:
     events = []
     for duty in duties:
-        if duty.finish:
-            d = _build_dict(duty)
-            events.append(vevent.format(**d))
-        elif do_ade:
-            date = duty.start.date()
-            uid = "{}{}@HURSTS.ORG.UK".format(
-                date.isoformat(), duty.code)
-            modified = ical_datetime.format(dt.datetime.utcnow())
-            events.append(advevent.format(
-                day=date,
-                ev=duty.code,
+        d = _build_dict(duty)
+        events.append(vevent.format(**d))
+    for e in ade:
+        uid = "{}{}@HURSTS.ORG.UK".format(
+            e.date.isoformat(), e.code)
+        modified = ical_datetime.format(dt.datetime.utcnow())
+        events.append(advevent.format(
+                day=e.date,
+                ev=e.code,
                 modified=modified,
                 uid=uid))
     return vcalendar.format("\r\n".join(events))

aims_convert-2.2/aims/parse.py

@@ -0,0 +1,16 @@
+from aims.data_structures import Duty, AllDayEvent, InputFileException
+import aims.roster
+import aims.logbook_report
+
+
+def parse(html: str) -> tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]:
+    # check it's an html5 file
+    html5_header = "<!DOCTYPE html><html>"
+    if html[:len(html5_header)] != html5_header:
+        raise InputFileException("HTML5 header not found.")
+    if html.find("Personal&nbsp;Crew&nbsp;Schedule&nbsp;Report") != -1:
+        return aims.roster.duties(html)
+    elif html.find("Pilot&nbsp;Logbook") != -1:
+        return aims.logbook_report.duties(html)
+    else:
+        raise InputFileException("Report type marker not found")

{aims_convert-2.1 → aims_convert-2.2}/aims/roster.py

@@ -6,9 +6,11 @@ produced by processing the roster with BeautifulSoup.
 
 import datetime as dt
 import re
-from typing import Optional
 
-from aims.data_structures import Duty, Sector, CrewMember, InputFileException
+from bs4 import BeautifulSoup  # type: ignore
+
+from aims.data_structures import (
+    Duty, Sector, CrewMember, AllDayEvent, InputFileException)
 
 
 Row = tuple[tuple[str, ...], ...]
@@ -78,7 +80,10 @@ def _sectors(data: Row, date: dt.date) -> tuple[Sector, ...]:
             if airports[0][0] == "*":  # Either ground or air positioning
                 airports[0] = airports[0][1:]
                 position = True
-            quasi = not type_  # If no type in code, assume quasi sector
+            quasi = False
+            if not type_:  # If no type in code, assume quasi sector
+                quasi = True
+                crew = ()
             retval.append(
                 Sector(name, None, type_, airports[0], airports[1],
                        _convert_timestring(times[0], date),
@@ -93,7 +98,7 @@ def _sectors(data: Row, date: dt.date) -> tuple[Sector, ...]:
     return tuple(retval)
 
 
-def _duty(row: Row) -> Optional[Duty]:
+def _duty(row: Row) -> Duty:
     """Creates a Duty object from a structured representation of an HTML row.
 
     The input object is a 12 cell tuple with each cell containing the contents
@@ -158,15 +163,10 @@ def _duty(row: Row) -> Optional[Duty]:
 
     """
     try:
-        if not row[CODES]:
-            return None
+        assert row[CODES] and row[TIMES]
         date = _convert_datestring(row[DATE][0])
-        # if there are no times, it is an all day event
-        if not row[TIMES]:
-            return Duty(row[CODES][0],
-                        dt.datetime.combine(date, dt.time()),
-                        None, ())
         if row[DSTART]:
+            assert row[DEND]
             start = _convert_timestring(row[DSTART][0], date)
             end = _convert_timestring(row[DEND][0], date)
         else:
@@ -183,18 +183,26 @@ def _duty(row: Row) -> Optional[Duty]:
                 break
             start = min(start, sector.off)
             end = max(end, sector.on)
-        return Duty(None, start, end, sectors)
+        return Duty(start, end, sectors)
+    except (IndexError, ValueError):
+        raise InputFileException(f"Bad Duty Record: {str(row)}")
+
+
+def _ade(row: Row) -> AllDayEvent:
+    try:
+        return AllDayEvent(_convert_datestring(row[DATE][0]), row[CODES][0])
     except (IndexError, ValueError):
-        raise InputFileException(f"Bad Record: {str(row)}")
+        raise InputFileException(f"Bad All Day Duty Record: {str(row)}")
 
 
-def duties(soup) -> tuple[Duty, ...]:
-    """Create a tuple of Duty objects from a BeautifulSoup of a roster.
+def duties(html: str) -> tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]:
+    """Extract the data from an AIMS vertical roster.
 
     The entire document is a single table (how retro!). The interesting part
     starts with the row two rows below the row with a cell containing the
     phrase "Schedule Details" and ends with the row above the first row with a
-    blank date field. Each row between these represents a single duty.
+    blank date field. Each row between these represents a single duty or an all
+    dat event.
 
     The date to the left of each row is the date that the duty started on. If
     duties continue past midnight, relevant times are marked with a superscript
@@ -202,25 +210,30 @@ def duties(soup) -> tuple[Duty, ...]:
     vertical roster much saner to parse than the alternatives since there are
     no concerns about missing data at the start and end of the roster period.
 
-    :param soup: The soup of a 'vertical' HTML AIMS roster, as produced by
-               processing the HTML with BeautifulSoup.
-    :return: A tuple of Duty objects encoding the roster in a standard form.
+    :param html: The html of a 'vertical' HTML AIMS roster.
+    :return: A tuple of Duty objects and a tuple of AllDayEvent objects
 
     """
+    soup = BeautifulSoup(html, "html5lib")
     rows = iter(soup.find_all("tr"))
     try:
         while "Schedule Details" not in next(rows).stripped_strings:
             pass
         next(rows)
-        retval: list[Duty] = []
+        duty_list: list[Duty] = []
+        ade_list: list[AllDayEvent] = []
         while True:
-            strings = tuple(
+            row: Row = tuple(
                 tuple(Y.replace("\xa0", " ") for Y in X.stripped_strings)
                 for X in next(rows)("td"))
-            if not strings[DATE]:  # line without date ends table
+            if not row[DATE]:  # line without date ends table
                 break
-            if duty := _duty(strings):
-                retval.append(duty)
+            if not row[CODES]:  # unpublished duty
+                continue
+            if not row[TIMES]:  # an all day event
+                ade_list.append(_ade(row))
+            elif duty := _duty(row):  # a normal duty
+                duty_list.append(duty)
+        return (tuple(duty_list), tuple(ade_list))
     except (StopIteration, IndexError):
         raise InputFileException("Duty table ended unexpectedly")
-    return tuple(retval)

aims_convert-2.2/aims/version.py

@@ -0,0 +1,4 @@
+from importlib.metadata import version
+
+
+VERSION = version("aims-convert")

{aims_convert-2.1 → aims_convert-2.2}/aims_convert.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aims-convert
-Version: 2.1
+Version: 2.2
 Summary: Extract useful information from AIMS
 Home-page: https://github.com/JonHurst/aims-convert
 Author: Jon Hurst
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
 Requires-Dist: nightflight
 Requires-Dist: bs4
 Requires-Dist: html5lib
+Provides-Extra: unit-tests
+Requires-Dist: freezegun; extra == "unit-tests"
 
 # AIMS Roster Data Extraction #
 

{aims_convert-2.1 → aims_convert-2.2}/aims_convert.egg-info/SOURCES.txt

@@ -10,12 +10,15 @@ aims/output.py
 aims/parse.py
 aims/py.typed
 aims/roster.py
+aims/version.py
 aims_convert.egg-info/PKG-INFO
 aims_convert.egg-info/SOURCES.txt
 aims_convert.egg-info/dependency_links.txt
 aims_convert.egg-info/entry_points.txt
 aims_convert.egg-info/requires.txt
 aims_convert.egg-info/top_level.txt
+tests/test_compound.py
 tests/test_logbook.py
+tests/test_output.py
 tests/test_parse.py
 tests/test_roster.py

{aims_convert-2.1 → aims_convert-2.2}/aims_convert.egg-info/requires.txt

@@ -1,3 +1,6 @@
 nightflight
 bs4
 html5lib
+
+[unit_tests]
+freezegun

{aims_convert-2.1 → aims_convert-2.2}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="aims-convert",
-    version="2.1",
+    version="2.2",
     author="Jon Hurst",
     author_email="jon.a@hursts.org.uk",
     description="Extract useful information from AIMS",
@@ -34,4 +34,7 @@ setuptools.setup(
         "console_scripts": ["aims = aims.cli:main"],
         "gui_scripts" : ["aimsgui = aims.gui:main"]
     },
+    extras_require={
+        "unit_tests": ["freezegun"]
+    },
 )

aims_convert-2.2/tests/test_compound.py

@@ -0,0 +1,34 @@
+import unittest
+from freezegun import freeze_time
+import glob
+
+import aims.parse
+import aims.output
+from aims.data_structures import InputFileException
+
+
+@freeze_time("2024-01-01")
+class Test_compound(unittest.TestCase):
+
+    def test_compound(self):
+        for f in glob.glob("files/*.htm"):
+            with open(f) as input_:
+                duties, ade = aims.parse.parse(input_.read())
+            with open(f + ".txt") as roster_file:
+                self.assertEqual(roster_file.read(),
+                                 aims.output.roster(duties) + "\n")
+            with open(f + ".ical", "rb") as ical_file:
+                self.assertEqual(
+                    ical_file.read(),
+                    (aims.output.ical(duties, ade) + "\n").encode())
+            with open(f + ".csv", "rb") as csv_file:
+                self.assertEqual(csv_file.read(),
+                                 (aims.output.csv(duties) + "\n").encode())
+            with open(f + ".efj") as efj_file:
+                self.assertEqual(efj_file.read(),
+                                 aims.output.efj(duties) + "\n")
+
+    def test_bad_file(self):
+        with open("files/README") as f:
+            with self.assertRaises(InputFileException):
+                aims.parse.parse(f.read())

{aims_convert-2.1 → aims_convert-2.2}/tests/test_logbook.py

@@ -22,7 +22,6 @@ class TestDuty(unittest.TestCase):
                    quasi=False, position=False,
                    crew=(CrewMember("TEST-2", "CP"), )))
         expected = Duty(
-            code=None,
             start=datetime.datetime(2022, 7, 23, 10, 44),
             finish=datetime.datetime(2022, 7, 23, 18, 11),
             sectors=(Sector(name='6053', reg='G-EZRY', type_='320',

aims_convert-2.2/tests/test_output.py

@@ -0,0 +1,231 @@
+import unittest
+import datetime
+from freezegun import freeze_time
+
+from aims.output import roster, efj, ical
+from aims.data_structures import Duty, Sector, CrewMember, AllDayEvent
+
+
+crew = (
+    CrewMember(name='CAPTAIN THE', role='CP'),
+    CrewMember(name='FO THE', role='FO'),
+    CrewMember(name='PU THE', role='PU'),
+    CrewMember(name='FA A', role='FA'))
+
+
+standard_duty = Duty(
+    start=datetime.datetime(2023, 6, 2, 5, 0),
+    finish=datetime.datetime(2023, 6, 2, 16, 1),
+    sectors=(
+        Sector(name='2867', reg=None, type_='320',
+               from_='BRS', to='LIS',
+               off=datetime.datetime(2023, 6, 2, 6, 0),
+               on=datetime.datetime(2023, 6, 2, 8, 36),
+               quasi=False, position=False, crew=crew),
+        Sector(name='2868', reg=None, type_='320',
+               from_='LIS', to='BRS',
+               off=datetime.datetime(2023, 6, 2, 9, 43),
+               on=datetime.datetime(2023, 6, 2, 12, 4),
+               quasi=False, position=False, crew=crew),
+        Sector(name='239', reg=None, type_='320',
+               from_='BRS', to='NCL',
+               off=datetime.datetime(2023, 6, 2, 12, 52),
+               on=datetime.datetime(2023, 6, 2, 13, 58),
+               quasi=False, position=False, crew=crew),
+        Sector(name='240', reg=None, type_='320',
+               from_='NCL', to='BRS',
+               off=datetime.datetime(2023, 6, 2, 14, 32),
+               on=datetime.datetime(2023, 6, 2, 15, 31),
+               quasi=False, position=False, crew=crew)))
+
+
+standby_duty = Duty(
+    start=datetime.datetime(2024, 7, 25, 5, 15),
+    finish=datetime.datetime(2024, 7, 25, 13, 15),
+    sectors=(
+        Sector(name='ESBY', reg=None, type_=None,
+               from_=None, to=None,
+               off=datetime.datetime(2024, 7, 25, 5, 15),
+               on=datetime.datetime(2024, 7, 25, 13, 15),
+               quasi=True, position=False, crew=()), ))
+
+
+standby_before_flight = Duty(
+    start=datetime.datetime(2023, 7, 2, 11, 45),
+    finish=datetime.datetime(2023, 7, 2, 19, 26),
+    sectors=(
+        Sector(name='LSBY', reg=None, type_=None,
+               from_='BRS', to='BRS',
+               off=datetime.datetime(2023, 7, 2, 11, 45),
+               on=datetime.datetime(2023, 7, 2, 13, 20),
+               quasi=True, position=False,
+               crew=()),
+        Sector(name='ADTY', reg=None, type_=None,
+               from_='BRS', to='BRS',
+               off=datetime.datetime(2023, 7, 2, 13, 20),
+               on=datetime.datetime(2023, 7, 2, 14, 0),
+               quasi=True, position=False,
+               crew=()),
+        Sector(name='227', reg=None, type_='319',
+               from_='BRS', to='BFS',
+               off=datetime.datetime(2023, 7, 2, 16, 14),
+               on=datetime.datetime(2023, 7, 2, 17, 23),
+               quasi=False, position=False,
+               crew=crew),
+        Sector(name='228', reg=None, type_='319',
+               from_='BFS', to='BRS',
+               off=datetime.datetime(2023, 7, 2, 17, 56),
+               on=datetime.datetime(2023, 7, 2, 18, 56),
+               quasi=False, position=False,
+               crew=crew)))
+
+
+loe_day1 = Duty(
+    start=datetime.datetime(2023, 6, 19, 14, 30),
+    finish=datetime.datetime(2023, 6, 19, 18, 0),
+    sectors=(
+        Sector(name='TAXI227', reg=None, type_=None,
+               from_='BRS', to='LGW',
+               off=datetime.datetime(2023, 6, 19, 14, 30),
+               on=datetime.datetime(2023, 6, 19, 18, 0),
+               quasi=True, position=True, crew=()),))
+
+
+loe_day2 = Duty(
+    start=datetime.datetime(2023, 6, 20, 12, 0),
+    finish=datetime.datetime(2023, 6, 20, 18, 30),
+    sectors=(
+        Sector(name='LOE', reg=None, type_=None,
+               from_=None, to=None,
+               off=datetime.datetime(2023, 6, 20, 13, 30),
+               on=datetime.datetime(2023, 6, 20, 17, 30),
+               quasi=True, position=False, crew=()),))
+
+
+loe_day3 = Duty(
+    start=datetime.datetime(2023, 6, 21, 8, 0),
+    finish=datetime.datetime(2023, 6, 21, 18, 30),
+    sectors=(
+        Sector(name='FFST', reg=None, type_=None,
+               from_='LGW', to='LGW',
+               off=datetime.datetime(2023, 6, 21, 9, 30),
+               on=datetime.datetime(2023, 6, 21, 13, 30),
+               quasi=True, position=False, crew=()),
+        Sector(name='TAXI72', reg=None, type_=None,
+               from_='LGW', to='BRS',
+               off=datetime.datetime(2023, 6, 21, 15, 0),
+               on=datetime.datetime(2023, 6, 21, 18, 30),
+               quasi=True, position=True, crew=())))
+
+
+class TestRoster(unittest.TestCase):
+
+    def test_standard(self):
+        self.assertEqual(
+            roster((standard_duty, standby_duty)),
+            "02/06/2023 06:00-17:01 BRS-LIS-BRS-NCL-BRS 7:02/11:01\n"
+            "25/07/2024 06:15-14:15 ESBY 0:00/8:00")
+
+    def test_standby_before_flight(self):
+        self.assertEqual(
+            roster((standby_before_flight, )),
+            "02/07/2023 12:45-14:20 LSBY 0:00/1:35\n"
+            "02/07/2023 14:20-15:00 ADTY 0:00/0:40\n"
+            "02/07/2023 15:00-20:26 BRS-BFS-BRS 2:09/5:26")
+
+    def test_loe(self):
+        self.assertEqual(
+            roster((loe_day1, loe_day2, loe_day3)),
+            "19/06/2023 15:30-19:00 TAXI227 0:00/3:30\n"
+            "20/06/2023 13:00-14:30 Brief 0:00/1:30\n"
+            "20/06/2023 14:30-18:30 LOE 0:00/4:00\n"
+            "20/06/2023 18:30-19:30 Debrief 0:00/1:00\n"
+            "21/06/2023 09:00-10:30 Brief 0:00/1:30\n"
+            "21/06/2023 10:30-14:30 FFST 0:00/4:00\n"
+            "21/06/2023 14:30-16:00 Debrief 0:00/1:30\n"
+            "21/06/2023 16:00-19:30 TAXI72 0:00/3:30")
+
+    def test_empty(self):
+        self.assertEqual(roster(()), "")
+
+
+class TestEFJ(unittest.TestCase):
+
+    def test_standard(self):
+        self.assertEqual(
+            efj((standard_duty, standby_duty)),
+            "2023-06-02\n"
+            "0500/1601\n"
+            "{ CP:Captain The, FO:Fo The, PU:Pu The, FA:Fa A }\n"
+            "?-????:320\n"
+            "BRS/LIS 0600/0836\n"
+            "LIS/BRS 0943/1204\n"
+            "BRS/NCL 1252/1358\n"
+            "NCL/BRS 1432/1531\n\n"
+            "2024-07-25\n"
+            "0515/1315 #ESBY\n")
+
+    def test_standby_before_flight(self):
+        self.assertEqual(
+            efj((standby_before_flight, )),
+            "2023-07-02\n"
+            "1145/1926\n"
+            "{ CP:Captain The, FO:Fo The, PU:Pu The, FA:Fa A }\n"
+            "?-????:319\n"
+            "BRS/BFS 1614/1723\n"
+            "BFS/BRS 1756/1856\n")
+
+    def test_loe(self):
+        self.assertEqual(
+            efj((loe_day1, loe_day2, loe_day3)),
+            "2023-06-19\n"
+            "1430/1800 #TAXI227\n"
+            "\n"
+            "2023-06-20\n"
+            "1200/1830 #LOE\n"
+            "\n"
+            "2023-06-21\n"
+            "0800/1830\n")
+
+    def test_empty(self):
+        self.assertEqual(efj(()), "")
+
+
+@freeze_time("2024-01-01")
+class Test_ical(unittest.TestCase):
+
+    def test_standard(self):
+        expected = ("BEGIN:VCALENDAR\r\n"
+                    "VERSION:2.0\r\n"
+                    "PRODID:hursts.org.uk\r\n"
+                    "BEGIN:VEVENT\r\n"
+                    "UID:2023-06-02T05:00:00BRSLISBRSNCLBRS@HURSTS.ORG.UK\r\n"
+                    "DTSTAMP:20240101T000000Z\r\n"
+                    "DTSTART:20230602T050000Z\r\n"
+                    "DTEND:20230602T160100Z\r\n"
+                    "SUMMARY:BRS-LIS-BRS-NCL-BRS\r\n"
+                    "DESCRIPTION:06:00z-08:36z 2867 BRS/LIS \\n\r\n"
+                    " 09:43z-12:04z 2868 LIS/BRS \\n\r\n"
+                    " 12:52z-13:58z 239 BRS/NCL \\n\r\n"
+                    " 14:32z-15:31z 240 NCL/BRS \r\n"
+                    "LAST-MODIFIED:20240101T000000Z\r\n"
+                    "END:VEVENT\r\n"
+                    "END:VCALENDAR\r\n")
+        self.assertEqual(ical((standard_duty, ), ()), expected)
+
+    def test_all_day_event(self):
+        expected = ("BEGIN:VCALENDAR\r\n"
+                    "VERSION:2.0\r\n"
+                    "PRODID:hursts.org.uk\r\n"
+                    "BEGIN:VEVENT\r\n"
+                    "UID:2024-01-02P/T@HURSTS.ORG.UK\r\n"
+                    "DTSTAMP:20240101T000000Z\r\n"
+                    "DTSTART;VALUE=DATE:20240102\r\n"
+                    "SUMMARY:P/T\r\n"
+                    "TRANSP:TRANSPARENT\r\n"
+                    "LAST-MODIFIED:20240101T000000Z\r\n"
+                    "END:VEVENT\r\n"
+                    "END:VCALENDAR\r\n")
+        self.assertEqual(
+            ical((), (AllDayEvent(datetime.date(2024, 1, 2), "P/T"), )),
+            expected)

{aims_convert-2.1 → aims_convert-2.2}/tests/test_roster.py

@@ -3,7 +3,7 @@ import datetime
 
 import aims.roster as roster
 from aims.data_structures import (
-    Duty, Sector, CrewMember, InputFileException
+    Duty, Sector, CrewMember, AllDayEvent, InputFileException
 )
 
 crew = ('CP - 0000 - CAPTAIN THE',
@@ -34,7 +34,6 @@ class Test_duty(unittest.TestCase):
                ('11:01',),
                (), crew, ())
         expected = Duty(
-            code=None,
             start=datetime.datetime(2023, 6, 2, 5, 0),
             finish=datetime.datetime(2023, 6, 2, 16, 1),
             sectors=(
@@ -61,17 +60,6 @@ class Test_duty(unittest.TestCase):
             )
         self.assertEqual(roster._duty(src), expected)
 
-    def test_all_day_event(self):
-        src = ((),
-               ('04/06/2023 Sun',),
-               ('D/O',),
-               ('Day off',),
-               (), (), (), (), (), (), (), ())
-        expected = Duty(code='D/O',
-                        start=datetime.datetime(2023, 6, 4, 0, 0),
-                        finish=None, sectors=())
-        self.assertEqual(roster._duty(src), expected)
-
     def test_loe(self):
         src = (
             ((), ('19/06/2023', 'Mon'),
@@ -89,8 +77,7 @@ class Test_duty(unittest.TestCase):
              (), ('10:30',), (), ('CP - PAX - 0000 - CAPTAIN THE',),
              ()))
         expected = (
-            Duty(code=None,
-                 start=datetime.datetime(2023, 6, 19, 14, 30),
+            Duty(start=datetime.datetime(2023, 6, 19, 14, 30),
                  finish=datetime.datetime(2023, 6, 19, 18, 0),
                  sectors=(
                      Sector(name='TAXI227', reg=None, type_=None,
@@ -98,8 +85,7 @@ class Test_duty(unittest.TestCase):
                             off=datetime.datetime(2023, 6, 19, 14, 30),
                             on=datetime.datetime(2023, 6, 19, 18, 0),
                             quasi=True, position=True, crew=()),)),
-            Duty(code=None,
-                 start=datetime.datetime(2023, 6, 20, 12, 0),
+            Duty(start=datetime.datetime(2023, 6, 20, 12, 0),
                  finish=datetime.datetime(2023, 6, 20, 18, 30),
                  sectors=(
                      Sector(name='LOE', reg=None, type_=None,
@@ -107,7 +93,7 @@ class Test_duty(unittest.TestCase):
                             off=datetime.datetime(2023, 6, 20, 13, 30),
                             on=datetime.datetime(2023, 6, 20, 17, 30),
                             quasi=True, position=False, crew=()),)),
-            Duty(code=None, start=datetime.datetime(2023, 6, 21, 8, 0),
+            Duty(start=datetime.datetime(2023, 6, 21, 8, 0),
                  finish=datetime.datetime(2023, 6, 21, 18, 30),
                  sectors=(
                      Sector(name='FFST', reg=None, type_=None,
@@ -129,8 +115,7 @@ class Test_duty(unittest.TestCase):
                (),  ('05:15 - 13:15',),  (),
                (),  ('08:00',),
                (),  (),  ())
-        expected = Duty(code=None,
-                        start=datetime.datetime(2024, 7, 25, 5, 15),
+        expected = Duty(start=datetime.datetime(2024, 7, 25, 5, 15),
                         finish=datetime.datetime(2024, 7, 25, 13, 15),
                         sectors=(
                             Sector(name='ESBY', reg=None, type_=None,
@@ -149,8 +134,7 @@ class Test_duty(unittest.TestCase):
                ('11:45 - 13:20', '13:20 - 14:00',
                 'A16:14 - A17:23', 'A17:56 - A18:56'),
                ('19:26',),  ('02:09',),  ('07:41',),  (),  crew, ())
-        expected = Duty(code=None,
-                        start=datetime.datetime(2023, 7, 2, 11, 45),
+        expected = Duty(start=datetime.datetime(2023, 7, 2, 11, 45),
                         finish=datetime.datetime(2023, 7, 2, 19, 26),
                         sectors=(
                             Sector(name='LSBY', reg=None, type_=None,
@@ -158,13 +142,13 @@ class Test_duty(unittest.TestCase):
                                    off=datetime.datetime(2023, 7, 2, 11, 45),
                                    on=datetime.datetime(2023, 7, 2, 13, 20),
                                    quasi=True, position=False,
-                                   crew=crew_result),
+                                   crew=()),
                             Sector(name='ADTY', reg=None, type_=None,
                                    from_='BRS', to='BRS',
                                    off=datetime.datetime(2023, 7, 2, 13, 20),
                                    on=datetime.datetime(2023, 7, 2, 14, 0),
                                    quasi=True, position=False,
-                                   crew=crew_result),
+                                   crew=()),
                             Sector(name='227', reg=None, type_='319',
                                    from_='BRS', to='BFS',
                                    off=datetime.datetime(2023, 7, 2, 16, 14),
@@ -189,8 +173,7 @@ class Test_duty(unittest.TestCase):
                 'A19:21 - A21:56', 'A22:33 - A00:57⁺¹/00:24'),
                ('01:27⁺¹',), ('07:08',), ('11:27',), ('M',),
                crew, ())
-        expected = Duty(code=None,
-                        start=datetime.datetime(2023, 6, 25, 14, 0),
+        expected = Duty(start=datetime.datetime(2023, 6, 25, 14, 0),
                         finish=datetime.datetime(2023, 6, 26, 1, 27),
                         sectors=(
                             Sector(name='239', reg=None, type_='320',
@@ -220,10 +203,6 @@ class Test_duty(unittest.TestCase):
                         )
         self.assertEqual(roster._duty(src), expected)
 
-    def test_not_published(self):
-        src = ((), ('01/08/2024 Thu',), (), (), (), (), (), (), (), ('D',), ())
-        self.assertEqual(roster._duty(src), None)
-
     def test_emptyrow(self):
         with self.assertRaises(InputFileException):
             roster._duty(())
@@ -232,8 +211,11 @@ class Test_duty(unittest.TestCase):
 
     def test_bad_date(self):
         with self.assertRaises(InputFileException):
-            roster._duty(((), ('31/06/2023 Sun',), ('D/O',),
-                          ('Day off',), (), (), (), (), (), (), (), ()))
+            roster._duty(((), ('32/07/2024 Thu',),
+                          ('ESBY',), ('Early Standby',),
+                          (),  ('24:00 - 13:15',),  (),
+                          (),  ('08:00',),
+                          (),  (),  ()))
 
     def test_bad_time(self):
         with self.assertRaises(InputFileException):
@@ -242,3 +224,15 @@ class Test_duty(unittest.TestCase):
                           (),  ('24:00 - 13:15',),  (),
                           (),  ('08:00',),
                           (),  (),  ()))
+
+
+class Test_ade(unittest.TestCase):
+
+    def test_simple(self):
+        src = ((),
+               ('04/06/2023 Sun',),
+               ('D/O',),
+               ('Day off',),
+               (), (), (), (), (), (), (), ())
+        self.assertEqual(roster._ade(src),
+                         AllDayEvent(datetime.date(2023, 6, 4), "D/O"))

aims_convert-2.1/aims/parse.py

@@ -1,24 +0,0 @@
-from bs4 import BeautifulSoup  # type: ignore
-
-from aims.data_structures import Duty, InputFileException
-import aims.roster
-import aims.logbook_report
-
-
-def parse(html: str) -> tuple[Duty, ...]:
-    # check it's an html5 file
-    html5_header = "<!DOCTYPE html><html>"
-    if html[:len(html5_header)] != html5_header:
-        raise InputFileException("HTML5 header not found.")
-    # make some soup
-    soup = BeautifulSoup(html, "html5lib")
-    # route the soup
-    strings = list(soup.find("body").stripped_strings)
-    if "Personal Crew Schedule Report" in strings:
-        return aims.roster.duties(soup)
-    elif "Pilot Logbook" in strings:
-        return aims.logbook_report.duties(soup)
-    else:
-        raise InputFileException(
-            "Report marker not found: \n" +
-            "; ".join(strings[:20]))