pyppms.booking

  1"""Module representing bookings / reservations in PPMS."""
  2
  3from datetime import datetime, timedelta
  4
  5from loguru import logger as log
  6
  7from .common import time_rel_to_abs, fmt_time
  8
  9
 10class PpmsBooking:
 11
 12    """Object representing a booking (reservation) in PPMS.
 13
 14    Attributes
 15    ----------
 16    username : str
 17        The user's account / login name the booking is linked to.
 18    system_id : int
 19        The PPMS system ID to which this booking refers to.
 20    starttime : datetime.date
 21        The booking's starting time.
 22    endtime : datetime.date or NoneType
 23        The booking's ending time, can be 'None'.
 24    session : str
 25        A string referring to a session ID in PPMS, can be empty.
 26    """
 27
 28    def __init__(self, text, booking_type, system_id):
 29        r"""Initialize the booking object.
 30
 31        Parameters
 32        ----------
 33        text : str
 34            The response text of a PUMAPI `getbooking` or `nextbooking` request,
 35            should consist of three lines: username, time_delta, session.
 36            Example: ``pyppms\n42\n12345\n``
 37        booking_type : str
 38            Either ``get`` (for a currently running booking) or ``next`` (for
 39            the next upcoming booking).
 40        system_id : int or int-like
 41            The ID of the system the booking refers to.
 42        """
 43        valid = ["get", "next"]
 44        if booking_type not in valid:
 45            raise ValueError(
 46                f"Value for 'booking_type' ({booking_type}) not in {valid}!"
 47            )
 48
 49        try:
 50            lines = text.splitlines()
 51            starttime = time_rel_to_abs(lines[1])
 52            endtime = None
 53
 54            if booking_type == "get":
 55                endtime = starttime
 56                starttime = datetime.now().replace(second=0, microsecond=0)
 57
 58            self.username = lines[0]
 59            self.system_id = int(system_id)
 60            self.starttime = starttime
 61            self.endtime = endtime
 62            self.session = lines[2]
 63        except Exception as err:
 64            log.error("Parsing booking response failed ({}), text was:\n{}", err, text)
 65            raise
 66
 67        log.trace(str(self))
 68
 69    # FIXME: date is of type datetime.datetime, NOT datetime.date !!!
 70    @classmethod
 71    def from_runningsheet(cls, entry, system_id, username, date):
 72        """Alternative constructor using a (parsed) getrunningsheet response.
 73
 74        Parameters
 75        ----------
 76        entry : dict
 77            One item of a 'getrunningsheet' response processed by the
 78            parse_multiline_response function.
 79        system_id : int or int-like
 80            The system ID to which this booking refers to.
 81        username : str
 82            The user's account / login name for PPMS.
 83        date : datetime.date
 84            The date object of the *DAY* this booking is linked to. Note that
 85            the exact start- and end-time of the booking will be taken from the
 86            ``entry`` dict above.
 87
 88        Returns
 89        -------
 90        pyppms.booking.PpmsBooking
 91            The object constructed with the parsed response.
 92        """
 93        try:
 94            response = f"{username}\n0\n\n"
 95            booking = cls(response, "get", system_id)
 96            booking.starttime_fromstr(entry["Start time"], date)
 97            booking.endtime_fromstr(entry["End time"], date)
 98        except Exception as err:
 99            log.error(
100                "Parsing runningsheet entry failed ({}), text was:\n{}", err, entry
101            )
102            raise
103
104        log.trace(f"Created booking from runningsheet: {booking}")
105        return booking
106
107    def starttime_fromstr(self, time_str, date=None):
108        """Change the starting time and / or day of a booking.
109
110        Parameters
111        ----------
112        time_str : str
113            The new starting time in format ``%H:%M:%S`` (e.g. ``13:45:00``).
114        date : datetime.date, optional
115            The new starting day, by default ``None`` which will result in the
116            current date to be used.
117        """
118        if date is None:
119            date = datetime.now()
120        start = date.replace(
121            hour=int(time_str.split(":")[0]),
122            minute=int(time_str.split(":")[1]),
123            second=0,
124            microsecond=0,
125        )
126        self.starttime = start
127        log.trace("New starttime: {}", self)
128
129    def endtime_fromstr(self, time_str, date=None):
130        """Change the ending time and / or day of a booking.
131
132        Parameters
133        ----------
134        time_str : str
135            The new ending time in format ``%H:%M:%S`` (e.g. ``13:45:00``).
136        date : datetime.date, optional
137            The new ending day, by default ``None`` which will result in the
138            current date to be used.
139        """
140        if date is None:
141            date = datetime.now()
142        end = date.replace(
143            hour=int(time_str.split(":")[0]),
144            minute=int(time_str.split(":")[1]),
145            second=0,
146            microsecond=0,
147        )
148        if end.hour == 0 and end.minute == 0:
149            end = end + timedelta(days=1)
150            log.debug(f"Booking end is midnight, adjust date to {end}")
151        self.endtime = end
152        log.trace("New endtime: {}", self)
153
154    def __str__(self):
155        msg = (
156            f"PpmsBooking(username=[{self.username}], "
157            f"system_id=[{self.system_id}], "
158            f"starttime=[{fmt_time(self.starttime)}], "
159            f"endtime=[{fmt_time(self.endtime)}]"
160        )
161        if self.session:
162            msg += f", session=[{self.session}]"
163        msg += ")"
164
165        return msg
166
167    @property
168    def desc(self):
169        """Format a "short" description of the object.
170
171        Returns
172        -------
173        str
174            A string containing `username`, `system_id` and the booking times.
175        """
176        return (
177            f"{self.username}@{self.system_id} "
178            f"[{fmt_time(self.starttime)} -- {fmt_time(self.endtime)}]"
179        )