Simplification des MODE_CHOICES ET STATUS_CHOICES dans AgentSurvey et dans Agent - CLEANUP

Etienne Pallier
1 parent 55831fe5
Showing 2 changed files with 38 additions and 71 deletions Show diff stats
src/core/pyros_django/agent/Agent.py
src/core/pyros_django/common/models.py
@@ -607,7 +607,7 @@ class Agent:
         self.unit = None
         self.TEST_COMMANDS = None
-        #print(AgentSurvey.MODE_IDLE)
+        #print(AgentSurvey.MODE_CHOICES.IDLE)
         #sys.exit()
         # Agent is by default in mode ATTENTIVE (most active mode)
@@ -642,7 +642,7 @@ class Agent:
         self.TEST_COMMANDS = iter(self.TEST_COMMANDS_LIST)
         ##self.RUN_IN_THREAD = RUN_IN_THREAD
-        self._set_status(AgentSurvey.STATUS_LAUNCH)
+        self._set_status(AgentSurvey.STATUS_CHOICES.LAUNCHED)
         ####self._set_idle()
         # Create 1st survey if none
@@ -964,7 +964,7 @@ class Agent:
         """
         ("in run()")
-        self._set_and_log_status(AgentSurvey.STATUS_LAUNCH)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.LAUNCHED)
         #return
@@ -1041,7 +1041,7 @@ class Agent:
     def _main_loop(self, nb_iter:int=None, FOR_REAL:bool=True):
-        self._set_and_log_status(AgentSurvey.STATUS_MAIN_LOOP)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.IN_MAIN_LOOP)
         self._main_loop_start(nb_iter)
         #if not self.DO_MAIN_LOOP: return 
@@ -1074,15 +1074,17 @@ class Agent:
             cmd = self._process_next_command_if_exists()
             #print(cmd)
         except (
+            # PENDING (non running) cmd exceptions
             CmdUnimplementedException, CmdBadArgsException, CmdUnknownException,
+            # RUNNING cmd exceptions
             CmdExecErrorException, CmdExecTimeoutException, CmdExecKilledException
         ) as e :
-            print(e)
+            #print(e)
             log.error(f"EXCEPTION on Agent command '{e.cmd_name}'")
             if isinstance(e.cmd, AgentCmd) :
                 cmd = e.cmd
                 if type(e) is CmdUnimplementedException:
-                    if cmd.name is not "get_specific_cmds":
+                    if cmd.name != "get_specific_cmds":
                         cmd.set_as_unimplemented("EXCEPTION: command known but unimplemented")
                 if type(e) in (CmdBadArgsException, CmdUnknownException):
                     cmd.set_as_invalid("EXCEPTION: command unknown or bad args")
@@ -1164,7 +1166,7 @@ class Agent:
             self.DO_MAIN_LOOP = False
             return
-        ##self._set_status(AgentSurvey.STATUS_MAIN_LOOP)
+        ##self._set_status(AgentSurvey.STATUS_CHOICES.IN_MAIN_LOOP)
         self.show_mode_and_status()
         self.main_loop_start()
@@ -1205,7 +1207,7 @@ class Agent:
     def _process_next_command_if_exists(self)->Union[AgentCmd,None]:
         ''' Processing the next pending command if exists '''
-        self._set_and_log_status(AgentSurvey.STATUS_GET_NEXT_COMMAND)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.IN_GET_NEXT_CMD)
         #print()
         #print()
@@ -1283,7 +1285,7 @@ class Agent:
                 self._cleanup_before_exit()
                 if cmd.name != 'do_restart_loop':
                     self.DO_RESTART_LOOP = False
-                self._set_status(AgentSurvey.STATUS_EXIT)
+                self._set_status(AgentSurvey.STATUS_CHOICES.EXITING)
                 # log last agent mode & status
                 self._log_agent_state()
                 #cmd.set_result('EXITING')
@@ -1391,7 +1393,7 @@ class Agent:
         print()
         log.info("*"*10+ " ROUTINE PROCESSING BEFORE (START) "+ "*"*10+ '\n')
-        self._set_and_log_status(AgentSurvey.STATUS_ROUTINE_BEFORE_PROCESS)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.IN_ROUTINE_BEF)
         self.routine_process_before_body()
         print()
@@ -1413,7 +1415,7 @@ class Agent:
         print()
         log.info("*"*10+ " ROUTINE PROCESSING AFTER (START) "+ "*"*10+ '\n')
-        self._set_and_log_status(AgentSurvey.STATUS_ROUTINE_AFTER_PROCESS)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.IN_ROUTINE_AFT)
         self.routine_process_after_body()
         print()
@@ -1543,9 +1545,9 @@ class Agent:
         return self.mode
     # Test mode
-    def IS_MODE_IDLE(self): return self.get_mode() == AgentSurvey.MODE_IDLE
-    def IS_MODE_ROUTINE(self): return self.get_mode() == AgentSurvey.MODE_ROUTINE
-    def IS_MODE_ATTENTIVE(self): return self.get_mode() == AgentSurvey.MODE_ATTENTIVE
+    def IS_MODE_IDLE(self): return self.get_mode() == AgentSurvey.MODE_CHOICES.IDLE
+    def IS_MODE_ROUTINE(self): return self.get_mode() == AgentSurvey.MODE_CHOICES.ROUTINE
+    def IS_MODE_ATTENTIVE(self): return self.get_mode() == AgentSurvey.MODE_CHOICES.ATTENTIVE
     # @deprecated
     def IS_IDLE(self): return self.IS_MODE_IDLE()
     # @deprecated
@@ -1559,19 +1561,20 @@ class Agent:
         self.mode = mode
     def _set_mode_idle(self):
-        self._set_mode(AgentSurvey.MODE_IDLE)
+        self._set_mode(AgentSurvey.MODE_CHOICES.IDLE)
     # @deprecated
     def set_idle(self):
         self._set_mode_idle()
     def _set_mode_routine(self):
-        self._set_mode(AgentSurvey.MODE_ROUTINE)
+        self._set_mode(AgentSurvey.MODE_CHOICES.ROUTINE)
     # @deprecated
     def set_routine(self):
         self._set_mode_routine()
     def _set_mode_attentive(self):
-        self._set_mode(AgentSurvey.MODE_ATTENTIVE)
+        #self._set_mode(AgentSurvey.MODE_ATTENTIVE)
+        self._set_mode(AgentSurvey.MODE_CHOICES.ATTENTIVE)
     # @deprecated
     def set_attentive(self):
         self._set_mode_attentive()
@@ -1649,7 +1652,7 @@ class Agent:
     def init(self):
         #log.debug("*** Initializing... ***")
         log.info("*** INITIALIZING... ***")
-        self._set_and_log_status(AgentSurvey.STATUS_INIT)
+        self._set_and_log_status(AgentSurvey.STATUS_CHOICES.INITIALIZING)
         if self.TEST_MODE: self.set_delay(2)
@@ -1830,7 +1833,7 @@ class Agent:
         which is relevant to this agent.
         Commands are read in chronological order
         """
-        self._set_status(AgentSurvey.STATUS_GET_NEXT_COMMAND)
+        self._set_status(AgentSurvey.STATUS_CHOICES.IN_GET_NEXT_CMD)
         log.info("Looking for a new command to process (sent by another agent):")
         # 1) Get all pending commands for me (return if None)
@@ -328,60 +328,22 @@ class AgentSurvey(models.Model):
     - MODE_ATTENTIVE : idem ROUTINE + executes Agent level SPECIFIC commands (commands specific to this agent, that only this agent understands and can execute)
     Default mode is MODE_ATTENTIVE (most active mode)
     '''
-    #MODE_ACTIVE = "ACTIVE"
-    MODE_IDLE = "IDLE"
-    MODE_ROUTINE = "ROUTINE"
-    MODE_ATTENTIVE = "ATTENTIVE"    
-    '''
-    (MODE_ACTIVE, 'Active mode'),
-    (MODE_IDLE, 'Idle mode'),
-    '''
-    '''
-    (MODE_IDLE, 'IDLE'),
-    (MODE_ROUTINE, 'ROUTINE'),
-    (MODE_ATTENTIVE, 'ATTENTIVE'),
-    '''
-    MODE_CHOICES = (
-        (MODE_IDLE, MODE_IDLE),
-        (MODE_ROUTINE, MODE_ROUTINE),
-        (MODE_ATTENTIVE, MODE_ATTENTIVE),
+    MODE_CHOICES = Choices(
+        "IDLE",  
+        "ROUTINE",  
+        "ATTENTIVE",
     )
-
     # --- STATUSES ---
-
-    #STATUSES = Choices('new', 'verified', 'published')
-    STATUS_LAUNCH = "LAUNCHED"
-    STATUS_INIT = "INITIALIZING"
-    STATUS_MAIN_LOOP = "IN_MAIN_LOOP"
-    STATUS_ROUTINE_BEFORE_PROCESS = "IN_ROUTINE_BEF"
-    STATUS_GET_NEXT_COMMAND = "IN_GET_NEXT_CMD"
-    STATUS_ROUTINE_AFTER_PROCESS = "IN_ROUTINE_AFT"
-    STATUS_EXIT = "EXITING"
-    # NEW
-    ##STATUS_RESTART = "RESTARTING"
-    #STATUS_GENERAL_PROCESS = "IN_GENERAL_PROCESS"
-    ###STATUS_SPECIFIC_PROCESS = "IN_SPECIFIC_PROCESS"
-    '''
-    STATUS_CHOICES = (
-        (STATUS_LAUNCH, "LAUNCHED"),
-        (STATUS_INIT, "INITIALIZING"),
-        (STATUS_MAIN_LOOP, "IN_MAIN_LOOP"),
-        (STATUS_ROUTINE_BEFORE_PROCESS, "IN_ROUTINE_BEF"),
-        (STATUS_GET_NEXT_COMMAND, "IN_GET_NEXT_CMD"),
-        (STATUS_ROUTINE_AFTER_PROCESS, "IN_ROUTINE_AFT"),
-        (STATUS_EXIT, "EXITING"),
-    )
-    '''
-    STATUS_CHOICES = (
-        #(STATUS_LAUNCH, "LAUNCHED"),
-        (STATUS_LAUNCH, STATUS_LAUNCH),
-        (STATUS_INIT, STATUS_INIT),
-        (STATUS_MAIN_LOOP, STATUS_MAIN_LOOP),
-        (STATUS_ROUTINE_BEFORE_PROCESS, STATUS_ROUTINE_BEFORE_PROCESS),
-        (STATUS_GET_NEXT_COMMAND, STATUS_GET_NEXT_COMMAND),
-        (STATUS_ROUTINE_AFTER_PROCESS, STATUS_ROUTINE_AFTER_PROCESS),
-        (STATUS_EXIT, STATUS_EXIT),
+    ''' Agent steps '''
+    STATUS_CHOICES = Choices(
+        'LAUNCHED',
+        'INITIALIZING',
+        'IN_MAIN_LOOP',
+        'IN_ROUTINE_BEF',
+        'IN_GET_NEXT_CMD',
+        'IN_ROUTINE_AFT',
+        'EXITING',
     )
     name = models.CharField(max_length=50, unique=True)
@@ -392,7 +354,9 @@ class AgentSurvey(models.Model):
     validity_duration = models.PositiveIntegerField(default=90)
     #validity_duration = models.DurationField(default=90)
     mode = models.CharField('agent mode', max_length=15,
-                            blank=True, choices=MODE_CHOICES)
+                            blank=True, choices=MODE_CHOICES,
+                            #default = MODE_CHOICES.ATTENTIVE
+    )
     status = models.CharField(
         max_length=15, blank=True, choices=STATUS_CHOICES)
     iteration = models.IntegerField(blank=True, null=True)