pyppms.system

 1"""Module representing bookable systems in PPMS."""
 2
 3# pylint: disable-msg=too-many-instance-attributes
 4# pylint: disable-msg=too-many-arguments
 5
 6from loguru import logger as log
 7
 8
 9class PpmsSystem:
10
11    """Object representing a bookable system in PPMS.
12
13    Attributes
14    ----------
15    system_id : int
16        The ID of the system in PPMS (the system's unique identifier).
17    name : str
18        The system's (human friendly) name.
19    localisation : str
20        The location of the system, corresponds to ``Room`` in the PPMS web interface.
21    system_type : str
22        The ``System Type`` field in PPMS, e.g. "`Confocal Microscopes`" or "`Virtual
23        Machine class PowerWorkstations`".
24    core_facility_ref : str
25        The core facility reference of the system, for example ``2``.
26    schedules : bool
27        Indicates whether to list this system in the (read-only) resources and schedules
28        pages of PPMS.
29    active : bool
30        Indicates whether the system is active in PPMS.
31    stats : bool
32        Indicates whether to integrate this system in the PPMS global usage statistics.
33    bookable : bool
34        Indicates whether the system is actually bookable in PPMS. A system that's not
35        bookable can still be used in incident management.
36    autonomy_required : bool
37        Indicates whether explicit permissions are required for a user for being allowed
38        to book the system. Corresponds to the field ``User right/training required`` in
39        the PPMS web interface.
40    autonomy_required_after_hours : bool
41        Corresponds to the field ``User right/training required only after hours`` in
42        the PPMS web interface. Unfortunately there is no description given what that
43        actually means - probably it refers to the "after hours" / "non-peak hours".
44    """
45
46    def __init__(self, details):
47        """Initialize the system object.
48
49        Parameters
50        ----------
51        details : dict
52            A dict with the parsed response from a `getsystems` request.
53        """
54        try:
55            self.system_id = int(details["System id"])
56        except ValueError as err:
57            log.error("Unable to parse system ID: {} - {}", details["System id"], err)
58            raise
59
60        self.name = details["Name"]
61        self.localisation = details["Localisation"]
62        self.system_type = details["Type"]
63        self.core_facility_ref = details["Core facility ref"]
64        self.schedules = details["Schedules"]
65        self.active = details["Active"]
66        self.stats = details["Stats"]
67        self.bookable = details["Bookable"]
68        self.autonomy_required = details["Autonomy Required"]
69        self.autonomy_required_after_hours = details["Autonomy Required After Hours"]
70        log.trace(
71            "PpmsSystem(system_id={}, name=[{}], localisation=[{}], system_type=[{}])",
72            self.system_id,
73            self.name,
74            self.localisation,
75            self.system_type,
76        )
77        # log.debug('PpmsSystem details: core_facility_ref={}, schedules={}, '
78        #           'active={}, stats={}, bookable={}, autonomy_required={}, '
79        #           'autonomy_required_after_hours={}', core_facility_ref,
80        #           schedules, active, stats, bookable, autonomy_required,
81        #           autonomy_required_after_hours)
82
83    def __str__(self):
84        return (
85            f"system_id: {self.system_id}, "
86            f"name: {self.name}, "
87            f"localisation: {self.localisation}, "
88            f"system_type: {self.system_type}, "
89            f"core_facility_ref: {self.core_facility_ref}, "
90            f"schedules: {self.schedules}, "
91            f"active: {self.active}, "
92            f"stats: {self.stats}, "
93            f"bookable: {self.bookable}, "
94            f"autonomy_required: {self.autonomy_required}, "
95            f"autonomy_required_after_hours: {self.autonomy_required_after_hours}"
96        )