rda-python-common 2.1.8__py3-none-any.whl → 2.1.10__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__ = "2.1.8"
+__version__ = "2.1.10"
 
 __all__ = [
    "PgLOG",

rda_python_common/pg_cmd.py

@@ -389,7 +389,7 @@ class PgCMD(PgLock):
          if pgrqst: pgctl = self.get_dsrqst_control(pgrqst, logact)
       return pgctl
 
-   def get_dynamic_options(self, cmd, oindex, otype):
+   def get_dynamic_options(self, cmd, oindex, otype, hostname=None):
       """Runs cmd to retrieve dynamic option strings, retrying on timeout.
 
       Executes the command up to three times, retrying when a connection
@@ -401,6 +401,11 @@ class PgCMD(PgLock):
          oindex (int or None): Object index appended to cmd when truthy.
          otype (str or None): Object type appended to cmd when truthy;
             'R' selects the first option from a slash-separated pair.
+         hostname (str or None): If provided, the command is executed
+            remotely via ``ssh <hostname> ...`` instead of locally; the
+            leading command name is resolved to its absolute path via
+            ``command_path`` so the remote shell does not depend on its
+            own PATH.
 
       Returns:
          str: The parsed option string, or '' if the command produced no
@@ -408,6 +413,7 @@ class PgCMD(PgLock):
       """
       if oindex: cmd += " {}".format(oindex)
       if otype: cmd += ' ' + otype
+      if hostname: cmd = "ssh {} {}".format(hostname, self.command_path(cmd))
       ret = options = ''
       for loop in range(3):
          ret = self.pgsystem(cmd, self.LOGWRN, 1299)  # 1+2+16+256+1024

rda_python_common/pg_log.py

@@ -180,6 +180,7 @@ class PgLOG:
       self.BCHCMDS = {'PBS': 'qsub'}
       # global dists to cashe information
       self.COMMANDS = {}
+      self.CMDPATHS = {}    # cache of bare command name -> full path (or '' if not found)
       self.PBSHOSTS = []
       self.PBSSTATS = {}
       # set additional common PGLOG values
@@ -1197,15 +1198,19 @@ class PgLOG:
       Returns:
           String with the leading command resolved to its full path, or the
           original *cmdstr* if the command already contains a path separator
-          or cannot be found via ``shutil.which``.
+          or cannot be found via ``shutil.which``.  Results of the
+          ``shutil.which`` lookup are cached in ``self.CMDPATHS``.
       """
       if not cmdstr: return ''
-      ary = cmdstr.split(' ', 1)
-      cmd = ary[0]
-      if re.search(r'[\\/]', cmd): return cmdstr
-      optstr = (' ' + ary[1]) if len(ary) > 1 else ''
-      pcmd = shutil.which(cmd)
-      return (pcmd+optstr) if pcmd else cmdstr
+      sp = cmdstr.find(' ')
+      cmd = cmdstr if sp < 0 else cmdstr[:sp]
+      if '/' in cmd or '\\' in cmd: return cmdstr
+      pcmd = self.CMDPATHS.get(cmd)
+      if pcmd is None:
+         pcmd = shutil.which(cmd) or ''
+         self.CMDPATHS[cmd] = pcmd
+      if not pcmd: return cmdstr
+      return pcmd if sp < 0 else pcmd + cmdstr[sp:]
 
    def add_carbon_copy(self, cc=None, isstr=None, exclude=0, specialist=None):
       """Update the Cc address list in ``PGLOG['CCDADDR']``.

rda_python_common/pgpassword.py

@@ -64,23 +64,29 @@ class PgPassword(PgDBI):
       Parse ``sys.argv`` and apply CLI overrides.
 
       Recognized options:
-         -l URL    -- OpenBao URL (stored in self.PGDBI['BAOURL'])
-         -k TOKEN  -- OpenBao token name (stored in self.PGDBI['BAOTOKEN'])
-         -d NAME   -- PostgreSQL database name
-         -c NAME   -- PostgreSQL schema name
-         -u NAME   -- PostgreSQL login user name
-         -h HOST   -- PostgreSQL server host name
-         -p PORT   -- PostgreSQL port number
+         -? / --help -- show usage and exit
+         -l URL      -- OpenBao URL (stored in self.PGDBI['BAOURL'])
+         -k TOKEN    -- OpenBao token name (stored in self.PGDBI['BAOTOKEN'])
+         -d NAME     -- PostgreSQL database name
+         -c NAME     -- PostgreSQL schema name
+         -u NAME     -- PostgreSQL login user name
+         -h HOST     -- PostgreSQL server host name
+         -p PORT     -- PostgreSQL port number
 
-      If no arguments are supplied a usage message is printed and the
-      process exits with status 0. Unknown options or stray values
-      cause an immediate error exit via ``self.pglog(..., LGEREX)``.
+      With no arguments, all defaults inherited from PgDBI/PgLOG are
+      used and the password lookup proceeds. Unknown options, stray
+      values, or an option without its required value cause an
+      immediate error exit via ``self.pglog(..., LGEREX)``.
       """
       argv = sys.argv[1:]
       opt = None
-      dohelp = True
       for arg in argv:
-         if re.match(r'^-[a-zA-Z]$', arg):
+         if arg in ('-?', '-help', '--help'):
+            self.set_help_path(__file__)
+            self.show_usage("pgpassword")
+         elif re.match(r'^-[a-zA-Z]$', arg):
+            if opt:
+               self.pglog("-" + opt + ": missing option value", self.LGEREX)
             opt = arg[1:]
          elif opt:
             if opt == 'l':
@@ -91,13 +97,12 @@ class PgPassword(PgDBI):
                self.dbopt = True
                self.DBINFO[self.DBFLDS[opt]] = arg
             else:
-               self.pglog(arg + ": Unknown option", self.LGEREX)
-            dohelp = False
+               self.pglog("-" + opt + ": Unknown option", self.LGEREX)
+            opt = None
          else:
-            self.pglog(arg + ": Value provided without option", self.LGEREX)
-      if dohelp:
-         self.set_help_path(__file__)
-         self.show_usage("pgpassword")
+            self.pglog(arg + ": value provided without option", self.LGEREX)
+      if opt:
+         self.pglog("-" + opt + ": missing option value", self.LGEREX)
 
    # get the pgpassword
    def start_actions(self):
@@ -114,7 +119,7 @@ class PgPassword(PgDBI):
       self.password = self.get_baopassword()
       if not self.password: self.password = self.get_pgpassword()
 
-# main function to excecute this script
+# main function to execute this script
 def main():
    """Entry point for the ``pgpassword`` console script: print the retrieved password to stdout."""
    object = PgPassword()

rda_python_common/pgpassword.usg

@@ -0,0 +1,57 @@
+
+ Retrieve a PostgreSQL login password for use by RDA python applications.
+ The password is looked up first from OpenBao (using the URL and token
+ configured in PgDBI) and, if not found there, from the user's .pgpass
+ file.  The retrieved password is printed to stdout so that shell
+ wrappers and other RDA utilities can capture it.
+
+ Usage: pgpassword [-?] [-l OpenBaoURL] [-k TokenName] [-d DBNAME]   \
+                   [-c SCHEMA] [-u USName] [-h DBHOST] [-p DBPORT]
+
+ With no options, pgpassword retrieves the password using all defaults
+ inherited from PgDBI/PgLOG (see per-option defaults below).
+
+      - Option -?, show this usage information and exit (also -help
+          and --help);
+
+      - Option -l, OpenBao URL used to retrieve passwords. Overrides
+          the BAOURL value from the PgDBI configuration.
+          Default: https://bao.k8s.ucar.edu/
+
+      - Option -k, OpenBao token name used to authenticate the password
+          lookup. Overrides the BAOTOKEN value from the PgDBI
+          configuration.
+
+      - Option -d, PostgreSQL database name.
+          Default: rdadb
+
+      - Option -c, PostgreSQL schema name.
+          Default: dssdb
+
+      - Option -u, PostgreSQL login user name.
+          Default: dssdb (same as the -c default)
+
+      - Option -h, PostgreSQL server host name.
+          Default: value of the DSSDBHOST environment variable, or
+          rda-db.ucar.edu if DSSDBHOST is not set.
+
+      - Option -p, PostgreSQL server port number.
+          Default: 5432
+
+ If any of -d, -c, -u, -h, or -p is supplied, the values are applied
+ via default_scinfo() before the password lookup is performed.
+
+ Examples:
+
+   1. Retrieve the password for the default database/user configured
+      in PgDBI:
+
+         pgpassword
+
+   2. Retrieve the password for a specific database, schema and user:
+
+         pgpassword -d rdadb -c dssdb -u metauser
+
+   3. Retrieve the password from a custom OpenBao endpoint:
+
+         pgpassword -l https://bao.example.org -k my-token -d rdadb

{rda_python_common-2.1.8.dist-info → rda_python_common-2.1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_common
-Version: 2.1.8
+Version: 2.1.10
 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
@@ -92,7 +92,7 @@ PgLOG.pglog("hello", PgLOG.LOGWRN)
 python -c "import rda_python_common; print(rda_python_common.__version__)"
 ```
 
-You should see the installed version (currently `2.1.8`).  If the import
+You should see the installed version (currently `2.1.10`).  If the import
 fails, double-check that the active Python environment is the one where you
 ran `pip install`.
 

{rda_python_common-2.1.8.dist-info → rda_python_common-2.1.10.dist-info}/RECORD

@@ -7,21 +7,22 @@ rda_python_common/PgOPT.py,sha256=Kn4JYezZhZwAn2usiIYHoHiymGHRgsN299dxyXbKwkI,56
 rda_python_common/PgSIG.py,sha256=eTJJ3XxutsQ3JSg6uYRpH26ZmrVUup3ShqDFLWXLruA,35803
 rda_python_common/PgSplit.py,sha256=SSg5_Qu5PqP44EkqebO-V_cErNcdE2QtORgFHQ7RqlQ,8822
 rda_python_common/PgUtil.py,sha256=OqESKCd72b9g8m8jwjPJhXDtPYlW6G8oSOhwChvz2Cg,48600
-rda_python_common/__init__.py,sha256=6JXEmVcGzKGHOOqOIqeAg_fXqr5PXHlIHiLvwH5D8ac,994
-rda_python_common/pg_cmd.py,sha256=hQZaW80eFqEUoF0vZHtGuvBEWXbXdY0Nvj6rFIQGboo,32856
+rda_python_common/__init__.py,sha256=FNcDisQ9NznJzOx1igxplnMqrQulXb-D3Kqi6o8hxDY,995
+rda_python_common/pg_cmd.py,sha256=PiQaAeb7l92LceqMwSzLpz9nD5pDRHJcEZxTDn-HeCs,33255
 rda_python_common/pg_dbi.py,sha256=q6LT4a4lwo-sM2LEqgrEVkAlh886xeKiz4feqRKw-7c,116238
 rda_python_common/pg_file.py,sha256=RzQTxnht4bFOVty4qoYPREawMCUsnFIbWm2pfEez1fE,161993
 rda_python_common/pg_lock.py,sha256=31EaVDjCkcx3-n8-KnzG18R8Pz7Z6KyFsEqcml6Iq5c,32702
-rda_python_common/pg_log.py,sha256=5kasi1aucWWhlGRlvOG9MT4eHmNsPqEb09rFn_kHPjg,80669
+rda_python_common/pg_log.py,sha256=Vr0z7mujcotvHEEXNPbJRUx5gNbBWfVGZJ30ms9h7iE,80953
 rda_python_common/pg_opt.py,sha256=sXrlzFWpR2XMak6NlA0MPvErBuQnY6gHM5OsHtoeIPQ,82496
 rda_python_common/pg_password.py,sha256=X-eIDwdqBhtrhrbDTNWle-0JtWsyIVZdDOZaBu7cFHM,2343
 rda_python_common/pg_sig.py,sha256=wLKBmFNWAmxWJFC2L3SLsD4n464kzzHbIFFNBlCW6kI,52759
 rda_python_common/pg_split.py,sha256=aAWKUZPmZ-LQ_fJ3DSKzPKxJw0fMDJ2fgP8ZT629M30,16375
 rda_python_common/pg_util.py,sha256=bjp2civRIhqaBSR8oOtyRzYIZBdwB90SzmJLjRIA7fc,87280
-rda_python_common/pgpassword.py,sha256=PVbF_ereAuNf1oy17-KPBycH9-Muy2gWlry9cQIW4sg,4711
-rda_python_common-2.1.8.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_common-2.1.8.dist-info/METADATA,sha256=aiikhrncVk_IyHLmsTwFmjqC0hLD8YELRPszQZHa_f8,11090
-rda_python_common-2.1.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_common-2.1.8.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
-rda_python_common-2.1.8.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
-rda_python_common-2.1.8.dist-info/RECORD,,
+rda_python_common/pgpassword.py,sha256=aTQaO59QokWrv2EKom4TvKhNW2Mr6aFMMBVG4DCbcKI,5023
+rda_python_common/pgpassword.usg,sha256=Wrle6A8sdlMGx3ZEAmE6TNDPOlG84Whe0T3rCNFzPfY,2013
+rda_python_common-2.1.10.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_common-2.1.10.dist-info/METADATA,sha256=uA5vJ1a2J-arJe3_pMzR4PMj6fGlaWKz1ZVqJLCAhGE,11092
+rda_python_common-2.1.10.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_common-2.1.10.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
+rda_python_common-2.1.10.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
+rda_python_common-2.1.10.dist-info/RECORD,,