rda-python-common 3.0.29__py3-none-any.whl → 3.0.31__py3-none-any.whl

rda_python_common/__init__.py

@@ -22,7 +22,7 @@ object that existing callers expect.
 
 from . import PgLOG, PgUtil, PgDBI, PgFile, PgLock, PgCMD, PgSIG, PgOPT, PgSplit
 
-__version__ = "3.0.29"
+__version__ = "3.0.31"
 
 __all__ = [
    "PgLOG",

rda_python_common/pg_sig.py

@@ -13,6 +13,7 @@ import re
 import sys
 import errno
 import signal
+import select
 import time
 import subprocess
 import psutil
@@ -41,6 +42,7 @@ class PgSIG(PgDBI):
       super().__init__()  # initialize parent class
       self.VUSERS = []  # allow users to start this daemon
       self.CPIDS = {}    # allow upto 'mproc' processes at one time for daemon
+      self.CEXITS = {}   # pname -> exit code of a child process in CPIDS reaped by SIGCHLD
       self.CBIDS = {}    # allow upto 'bproc' background processes at one time for each child
       self.SDUMP = {
         'DEF': '/dev/null',
@@ -57,6 +59,7 @@ class PgSIG(PgDBI):
          'WTINC': 5,    # seconds added to the adaptive wait after each loop still waiting
          'CWTIME': 0,   # current adaptive wait (in seconds), 0 before the first wait
          'WLOOP': -1,   # loop count of the last adaptive wait sleep
+         'WPIPE': None, # (read fd, write fd) of the pipe SIGCHLD writes to wake up a wait
          'DTIME': 600,  # the daemon record refresh time (in seconds)
          'RTIME': 2400, # the web rda config unlocking and unconfigured system down waiting time (in seconds)
          'CTIME': 4800, # the lock cleaning & configued system down waiting time (in seconds)
@@ -158,6 +161,7 @@ class PgSIG(PgDBI):
       os.umask(0)
       # setup to catch signals in daemon only
       signal.signal(signal.SIGCHLD, self.clean_dead_child)
+      self.open_wake_pipe()
       signal.signal(signal.SIGQUIT, self.signal_catch)
       signal.signal(signal.SIGUSR1, self.signal_catch)
       signal.signal(signal.SIGUSR2, self.signal_catch)
@@ -556,11 +560,15 @@ class PgSIG(PgDBI):
    def clean_dead_child(self, signum, frame):
       """Reap zombie child processes in response to SIGCHLD.
 
+      The exit code of a reaped child in ``CPIDS`` is kept in ``CEXITS`` under
+      its process name (negative signal number if killed by a signal), so a
+      parent can tell whether the work it gave the child succeeded.
+
       Args:
          signum (int): The signal number received (expected to be SIGCHLD).
          frame: The current stack frame (unused).
       """
-      live = 0
+      live = wake = 0
       while True:
          try:
             dpid, status = os.waitpid(-1, os.WNOHANG)
@@ -574,7 +582,64 @@ class PgSIG(PgDBI):
               if live > 0: break   # wait twice if a process is still a live
               live += 1
             elif self.PGSIG['PPID'] < 2:
-               if dpid in self.CPIDS: del self.CPIDS[dpid]
+               if dpid in self.CPIDS:
+                  if os.WIFEXITED(status):
+                     self.CEXITS[self.CPIDS[dpid]] = os.WEXITSTATUS(status)
+                  elif os.WIFSIGNALED(status):
+                     self.CEXITS[self.CPIDS[dpid]] = -os.WTERMSIG(status)
+                  del self.CPIDS[dpid]
+                  wake = 1
+               elif dpid in self.CBIDS:
+                  del self.CBIDS[dpid]
+                  wake = 1
+      if wake: self.wake_waiter()   # a managed child is done; end any wait for it now
+
+   # open the pipe a SIGCHLD handler writes to, so a wait for processes wakes up at once
+   def open_wake_pipe(self):
+      """Open the non-blocking self-pipe that wakes ``show_wait_message()`` on SIGCHLD.
+
+      ``clean_dead_child()`` writes one byte to it when a child process in ``CPIDS``
+      or a background process in ``CBIDS`` is done, and ``show_wait_message()`` waits on it with the adaptive wait time as
+      the timeout, so a free process slot is used at once instead of after a sleep.
+      """
+      if self.PGSIG['WPIPE']: return
+      try:
+         rfd, wfd = os.pipe()
+         os.set_blocking(rfd, False)
+         os.set_blocking(wfd, False)
+      except OSError as e:
+         self.pglog("Cannot open wake pipe, wait by sleeping: {}".format(str(e)), self.LOGWRN)
+         return
+      self.PGSIG['WPIPE'] = (rfd, wfd)
+
+   # close the wake pipe, such as in a child process that inherited it
+   def close_wake_pipe(self):
+      """Close the SIGCHLD wake pipe and forget it."""
+      if not self.PGSIG['WPIPE']: return
+      for fd in self.PGSIG['WPIPE']:
+         try:
+            os.close(fd)
+         except OSError:
+            pass
+      self.PGSIG['WPIPE'] = None
+
+   # write one byte to the wake pipe to end a wait in show_wait_message()
+   def wake_waiter(self):
+      """Wake a wait in ``show_wait_message()``; a full pipe already wakes it."""
+      if not self.PGSIG['WPIPE']: return
+      try:
+         os.write(self.PGSIG['WPIPE'][1], b'x')
+      except OSError:
+         pass   # pipe full (a wake is pending already) or closed
+
+   # read out all pending wake bytes, so a past wake does not end the next wait
+   def drain_wake_pipe(self):
+      """Read out any pending bytes of the SIGCHLD wake pipe."""
+      if not self.PGSIG['WPIPE']: return
+      try:
+         while os.read(self.PGSIG['WPIPE'][0], 512): pass
+      except OSError:
+         pass   # BlockingIOError when empty
 
    # send signal to daemon and exit
    def signal_daemon(self, sname, aname, uname):
@@ -748,6 +813,7 @@ class PgSIG(PgDBI):
          self.PGSIG['PID'] = pid = os.getpid()
          self.PGSIG['MPROC'] = 1   # 1 in child process
          self.CBIDS = {}         # empty backgroud proces info in case not
+         self.close_wake_pipe()  # the wake pipe is the parent's
          self.PGSIG['DSTR'] += ": CPID {} for {}".format(pid, pname)
          self.cmdlog("CPID {} for {}".format(pid, pname))
          self.pgdisconnect(0)  # disconnect database in child
@@ -793,6 +859,7 @@ class PgSIG(PgDBI):
       if logact&self.EXITLG: logact &= ~self.EXITLG
       ccnt = i = 0
       if dowait < 0: ccnt = 1 if (pid or pname) else self.PGSIG['MPROC']
+      self.drain_wake_pipe()   # the check below covers any child done before now
       while True:
          pcnt = 0
          if not pid and pname: pid = self.pname2cpid(pname)
@@ -845,6 +912,7 @@ class PgSIG(PgDBI):
          self.check_vuser(uname, aname)
       signal.signal(signal.SIGQUIT, self.signal_catch)   # catch quit signal only
       signal.signal(signal.SIGCHLD, self.clean_dead_child)
+      self.open_wake_pipe()
       self.PGSIG['DSTR'] = dstr
       self.PGSIG['DNAME'] = aname
       self.PGSIG['PPID'] = 0
@@ -1120,8 +1188,8 @@ class PgSIG(PgDBI):
             open before starting. Defaults to 0.
 
       Returns:
-         int or str: Result from ``pgsystem`` (synchronous mode) or
-            ``record_background``.
+         int or str: Result from ``pgsystem`` (synchronous mode), or 1 when the
+            background process started and its shell pid is recorded in ``CBIDS``.
       """
       if logact is None: logact = self.LOGWRN
       if self.PGSIG['BPROC'] < 2: return self.pgsystem(cmd, logact, cmdopt)  # no background
@@ -1149,12 +1217,19 @@ class PgSIG(PgDBI):
          if not self.PGLOG['ERRFILE']:
             self.PGLOG['ERRFILE'] = re.sub(r'\.log$', '.err', self.PGLOG['LOGFILE'], 1)
          bckcmd += " 2>> {}/{}".format(self.PGLOG['LOGPATH'], self.PGLOG['ERRFILE'])
-      bckcmd += " &"
-      # shell=True is required for the redirections (>> / 2>>) and trailing '&';
-      # the '&' makes the shell fork the command and exit, so the command gets
-      # reparented to init (ppid=1), matching the lookup logic in record_background().
-      subprocess.Popen(bckcmd, shell=True)
-      return self.record_background(cmd, logact)
+      # shell=True is required for the redirections (>> / 2>>). The shell runs the
+      # command and lives as long as it does, so its pid, a direct child, is the one
+      # to track: check_process() sees it running until it is done, and SIGCHLD reaps
+      # it. A new session keeps it running if this process is interrupted, as the old
+      # '&' did. (The old way searched for the orphaned '&' command with ppid 1 in
+      # record_background(), whose match test was inverted, so it never recorded the
+      # command it had just started: nothing was throttled or waited for.)
+      try:
+         proc = subprocess.Popen(bckcmd, shell=True, start_new_session=True)
+      except Exception as e:
+         return self.pglog("{}: cannot start background process: {}".format(cmd, str(e)), act)
+      self.CBIDS[proc.pid] = cmd
+      return 1
 
    # get background process id for given bcmd
    def bcmd2cbid(self, bcmd):
@@ -1205,13 +1280,13 @@ class PgSIG(PgDBI):
             # Bug fix: cannot delete from a dict while iterating over it;
             # iterate over a copy of the keys instead.
             cbids = list(self.CBIDS)
-            for bid in cbids:
-               if self.check_process(bid):  # process is not done yet
+            for cbid in cbids:   # not bid: it would turn the next loop into a one-pid check
+               if self.check_process(cbid):  # process is not done yet
                   bcnt += 1
                else:
-                  del self.CBIDS[bid]
+                  if cbid in self.CBIDS: del self.CBIDS[cbid]   # SIGCHLD may have removed it
          if not (bcnt and dowait): break
-         self.show_wait_message(i, "{}: wait {}/{} background processes".format(self.PGSIG['DSTR'], bcnt, self.PGSIG['MPROC']), logact, dowait)
+         self.show_wait_message(i, "{}: wait {}/{} background processes".format(self.PGSIG['DSTR'], bcnt, self.PGSIG['BPROC']), logact, dowait)
          i += 1
          bcnt = 0
       return bcnt
@@ -1251,7 +1326,7 @@ class PgSIG(PgDBI):
                acmd = line[idx+len(aname):]
                if uid == commonuser:
                   acmd = re.sub(r'^\.(pl|py)\s+', '', acmd, 1)
-               if re.match(r'^{}{}'.format(aname, acmd), bcmd): continue
+               if not bcmd.startswith(aname + acmd): continue   # not the command started
                self.CBIDS[bid] = bcmd
                return 1
             except (psutil.NoSuchProcess, psutil.AccessDenied):
@@ -1293,14 +1368,26 @@ class PgSIG(PgDBI):
          loop (int): Current loop iteration count, 0 for the first sleep of a wait.
          msg (str): Message to log.
          logact (int, optional): Log action flags. Defaults to ``LOGWRN``.
-         dowait (int, optional): If non-zero, sleep for the adaptive wait time
-            from ``adaptive_wait_time()``, at most ``PGSIG['WTIME']`` seconds.
-            Defaults to 0.
+         dowait (int, optional): If non-zero, wait for the adaptive wait time
+            from ``adaptive_wait_time()``, at most ``PGSIG['WTIME']`` seconds,
+            or until a child process in ``CPIDS`` is done, whichever is first
+            (see ``open_wake_pipe()``).  Defaults to 0.
       """
       if logact is None: logact = self.LOGWRN
       if loop > 0 and (loop%30) == 0:
          self.pglog("{} at {}".format(msg, self.current_datetime()), logact)
-      if dowait: time.sleep(self.adaptive_wait_time(loop))
+      if not dowait: return
+      wtime = self.adaptive_wait_time(loop)
+      if self.PGSIG['WPIPE'] and self.PGSIG['PPID'] < 2:
+         # wake as soon as a child is done; the adaptive time is only the longest wait
+         rfd = self.PGSIG['WPIPE'][0]
+         try:
+            select.select([rfd], [], [], wtime)
+         except (OSError, ValueError):
+            time.sleep(wtime)
+         self.drain_wake_pipe()
+      else:
+         time.sleep(wtime)
 
    # get the adaptive time to sleep for one loop of a wait for processes
    def adaptive_wait_time(self, loop):

{rda_python_common-3.0.29.dist-info → rda_python_common-3.0.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_common
-Version: 3.0.29
+Version: 3.0.31
 Summary: RDA Python common library codes shared by other RDA python packages
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-common
@@ -189,7 +189,7 @@ PgLOG.pglog("hello", PgLOG.LOGWRN)
 python -c "import rda_python_common; print(rda_python_common.__version__)"
 ```
 
-You should see the installed version (currently `3.0.29`).  If the import
+You should see the installed version (currently `3.0.31`).  If the import
 fails, double-check that the active Python environment is the one where you
 ran `pip install`.
 

{rda_python_common-3.0.29.dist-info → rda_python_common-3.0.31.dist-info}/RECORD

@@ -7,7 +7,7 @@ rda_python_common/PgOPT.py,sha256=0nQPF19N-1VWwrjFHEeruVSwVDwvFKd4uowPc8dK7e4,56
 rda_python_common/PgSIG.py,sha256=0MJPH0fTtSshIsvUXkzQjReHPyCWdzHYOY5LbFSh7-A,34318
 rda_python_common/PgSplit.py,sha256=En7xcdkE4YNRcMX88qXnrUgUOnQU3Kqh8uxRIdlJhEA,9156
 rda_python_common/PgUtil.py,sha256=7hXAznAI8tYh-nJRKBIXejNe2ROQ2Wxn28OAndeg0Iw,48433
-rda_python_common/__init__.py,sha256=sBVlfOY9ijDUndeN_oeqUihFhQ4l5ZUfT91PeQTPoVE,995
+rda_python_common/__init__.py,sha256=FTPc_6PSJ2E2CjQET_-Dbs3zGy8sewMbnI7GMCtQXbk,995
 rda_python_common/pg_cmd.py,sha256=MYldUuM8mSUIT34yKQyUd0i4NL4zdSB8C6Jcc28NRxA,33809
 rda_python_common/pg_dbi.py,sha256=ASIW2vsIjMab2TMfhqJiXS7LQhKKGpKjzNMqo7RCePw,122415
 rda_python_common/pg_file.py,sha256=7NipcgMy4t67zbH2MHtRL3vxyY1FHdIgMTQ-kE0H2fA,181122
@@ -15,14 +15,14 @@ rda_python_common/pg_lock.py,sha256=31EaVDjCkcx3-n8-KnzG18R8Pz7Z6KyFsEqcml6Iq5c,
 rda_python_common/pg_log.py,sha256=erQN4YYPwiORa3OE0Jt8s05rlWsjtyIs0fJ_KLbNAQ8,82959
 rda_python_common/pg_opt.py,sha256=LxVAf47wi2STkVGSXMvV3IZphEJcoO8bvYXy6kQ5ox4,82403
 rda_python_common/pg_password.py,sha256=X-eIDwdqBhtrhrbDTNWle-0JtWsyIVZdDOZaBu7cFHM,2343
-rda_python_common/pg_sig.py,sha256=wLqg-SxvF-tu-9zlpRsiszOb141L_YbxD-SGVnrCTPg,57828
+rda_python_common/pg_sig.py,sha256=gmOIHRx-SqiFmjQorQcJoEsiXoXI-akDrYoP3SuKVfM,62032
 rda_python_common/pg_split.py,sha256=aAWKUZPmZ-LQ_fJ3DSKzPKxJw0fMDJ2fgP8ZT629M30,16375
 rda_python_common/pg_util.py,sha256=JL9NoW-VoQvsjXsUr09oBUWYJJNltU4GyQIfWlpkf90,86084
 rda_python_common/pgpassword.py,sha256=aTQaO59QokWrv2EKom4TvKhNW2Mr6aFMMBVG4DCbcKI,5023
 rda_python_common/pgpassword.usg,sha256=Wrle6A8sdlMGx3ZEAmE6TNDPOlG84Whe0T3rCNFzPfY,2013
-rda_python_common-3.0.29.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_common-3.0.29.dist-info/METADATA,sha256=51mKJd7UiXR8giX2wKBeFpDIpPd5875s4hEAJ5RifMg,14530
-rda_python_common-3.0.29.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-rda_python_common-3.0.29.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
-rda_python_common-3.0.29.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
-rda_python_common-3.0.29.dist-info/RECORD,,
+rda_python_common-3.0.31.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_common-3.0.31.dist-info/METADATA,sha256=MH_cd7VJNUJsx2lMUxE4MaKuwoRAVSbZb0kyywMbOYk,14530
+rda_python_common-3.0.31.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+rda_python_common-3.0.31.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
+rda_python_common-3.0.31.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
+rda_python_common-3.0.31.dist-info/RECORD,,