rda-python-dscheck 2.0.7__py3-none-any.whl → 2.0.8__py3-none-any.whl

rda_python_dscheck/__init__.py

@@ -1 +1,27 @@
+"""rda_python_dscheck: dataset check (dscheck) utility package.
 
+This package exposes two parallel APIs:
+
+1. Legacy module-based API (back-compat). Import the capitalized
+   submodule and call its module-level functions, e.g.::
+
+       from rda_python_dscheck import PgCheck
+
+2. Class-based API (preferred for new code). Import the class from the
+   lower-case module and either instantiate or subclass it, e.g.::
+
+       from rda_python_dscheck.pg_check import PgCheck
+
+The legacy submodule is eagerly imported below so that
+``from rda_python_dscheck import PgCheck`` continues to return the module
+object that existing callers expect.
+"""
+
+from . import PgCheck
+
+__version__ = "2.0.8"
+
+__all__ = [
+   "PgCheck",
+   "__version__",
+]

rda_python_dscheck/dscheck.usg

@@ -80,7 +80,7 @@ into an action.
 Notation:
   []       - the enclosed element is optional.
   (A|B)    - either A or B may be used (a short form and a long form).
-  -OPT     - an option name. Names are case-insensitive; values are not.
+  -<OPT>   - OPT is an option name. Names are case-insensitive; values are not.
 
 Every dscheck invocation has at most one Action option, which selects the
 task to perform. Mode options change how the chosen action behaves. Info
@@ -95,26 +95,25 @@ are accepted, and aliases are noted with each option.
 2.1 Quick Start
 
   Show the full document, paged through 'more':
-    dscheck
+  dscheck
 
   Show the description of a single option:
-    dscheck -h -AC
-    dscheck -AC -h
+  dscheck -h -AC
 
   List your own daemon control records:
-    dscheck -GD
+  dscheck -GD
 
   List your own active check records:
-    dscheck -GC
+  dscheck -GC
 
   Add a deferred run of a script on PBS:
-    dscheck -AC -CM myscript.sh -HN PBS
+  dscheck -AC -CM myscript.sh -HN PBS
 
   Email yourself the status of all your active checks:
-    dscheck -EC
+  dscheck -EC
 
   Start the dscheck daemon (typical for the operator):
-    dscheck -PC -DM start
+  dscheck -PC -DM start
 
 2.2 Filters and Special Characters in Queries
 
@@ -135,20 +134,9 @@ Every option except -IF (-InputFile) may be supplied either on the command
 line or in an input file. -IF is itself only valid on the command line.
 A single dscheck invocation may combine command-line options with one or
 more input files. If the only options are inside a single input file, the
--IF prefix may be omitted:
-
-  dscheck mycheck.in
-
-See the description of -IF in Section 5.2 for the input-file format
-(comments, action/mode markers, single-value assignments, and tabular
-multi-value assignments, including delimiter overrides).
-
-2.4 Getting Help
-
-  dscheck                         # full document, displayed via 'more'
-  dscheck -(h|help)               # full document
-  dscheck [Option] -(h|help)      # description of [Option]
-  dscheck -(h|help) [Option]      # same as above
+-IF prefix may be omitted. See the description of -IF in Section 5.2 for
+the input-file format (comments, action/mode markers, single-value assignments,
+and tabular multi-value assignments, including delimiter overrides).
 
 A printable copy of this document is the file dscheck.usg installed under
 the python package rda_python_dscheck.
@@ -224,16 +212,6 @@ Delete Daemon Control - remove daemon control records by index.
     CM = ALL    - apply to any command not otherwise configured for this
                   specialist.
 
-  Example - configure schuster on PBS for any command, with up to 4
-  concurrent checks at priority 1 (lower number = higher priority), driven
-  from input file daemon.ctl:
-
-    dscheck -SD -ND -IF daemon.ctl
-
-  <<Content of input file daemon.ctl>>
-  DaemonIndex<:>Specialist<:>Command<:>Hostname<:>ProcessLimit<:>Priority<:>
-  0<:>schuster<:>ALL<:>PBS<:>4<:>1<:>
-
 
 3.1.2 Get Daemon Control
   -GD or -GetDaemon, retrieves daemon control records. With no Info-option
@@ -364,7 +342,7 @@ Unlock Check - clear leftover lock information after an abnormal exit.
 
   Add the executable 'test3' for deferred execution on PBS:
 
-    dscheck -AC -CM test3 -HN PBS
+  dscheck -AC -CM test3 -HN PBS
 
   The command 'test3' must be executable from the working directory on
   the PBS machine.
@@ -571,6 +549,7 @@ Available actions:
          [-(MO|Modules)  ModuleList]
          [-(EV|Environments)  EnvironmentPairList]
          [-(QS|QsubOptions)  PBSBatchOptions]
+         [-(SH|SSHHostname) RemoteHostname]
          [-(DB|Debug) DebugModeInfo]
 
 
@@ -665,6 +644,11 @@ multiple values is an error.
   -ON or -OrderNames, a string of single-letter field codes that
   controls the sort order of -GC (-GetCheck) output.
 
+  -SH or -SSHHostname, used with -SO (-SetOptions): remote host name on
+  which the dynamic-option command should run. When supplied, the command
+  is invoked via 'ssh <hostname> ...' instead of locally. Defaults to
+  running locally when omitted.
+
   -AO or -ActOption, the token that marks Action and Mode options in
   input files. Defaults to '<!>'.
 

rda_python_dscheck/pg_check.py

@@ -62,6 +62,7 @@ class PgCheck(PgOPT, PgCMD):
          'MT': [1, 'MaxrunTime',     0],
          'OF': [1, 'OutputFile',     0],
          'ON': [1, 'OrderNames',     0],
+         'SH': [1, 'SSHHostname',    0],
          'AO': [1, 'ActOption',      1],  # default to <!>
          'WI': [1, 'WaitInterval',   1],
          'AN': [2, 'ActionName',     0],
@@ -680,7 +681,8 @@ class PgCheck(PgOPT, PgCMD):
       if not pgrec or options != pgrec[optname]: return options
       record = {}
       errmsg = ''
-      record[optname] = options = self.get_dynamic_options(options[1:], pgcheck['oindex'], pgcheck['otype'])
+      sshhost = self.params.get('SH')
+      record[optname] = options = self.get_dynamic_options(options[1:], pgcheck['oindex'], pgcheck['otype'], sshhost)
       if not options and self.PGLOG['SYSERR']:
          record['status'] = pgcheck['status'] = 'E'
          record['pid'] = 0

rda_python_dscheck-2.0.8.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: rda_python_dscheck
+Version: 2.0.8
+Summary: RDA python package to add and process batch jobs
+Author-email: Zaihua Ji <zji@ucar.edu>
+Project-URL: Homepage, https://github.com/NCAR/rda-python-dscheck
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rda_python_common
+Dynamic: license-file
+
+# dscheck
+
+Python project to add and process batch jobs for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
+
+The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dscheck.readthedocs.io).
+
+## Source layout
+
+The package lives under `src/rda_python_dscheck/`.  The three files most
+relevant to setup and customization are:
+
+- **`dscheck.py`** — entry point installed as the `setuid_dscheck`
+  console script.  Defines the `DsCheck` class which subclasses
+  `PgCheck`, parses command-line options via `self.parsing_input`, and
+  dispatches to the appropriate action handler (`add_check_info`,
+  `process_check`, `get_check_info`, `set_dscheck_options`, ...).
+  Build new actions by adding a method here and routing to it from
+  `start_actions()`.
+
+- **`pg_check.py`** — defines the `PgCheck` class (inherits from
+  `PgCMD` in `rda_python_common`).  Holds the master `OPTS` option
+  table, the `ALIAS` map for long/alias names, the `TBLHASH` table
+  field maps for `dscheck` and `dsdaemon`, and the helper methods
+  shared by every action (option validation, dynamic batch-option
+  resolution, daemon control, host/specialist resolution, etc.).
+  Add or change options here, then document them in `dscheck.usg`.
+
+- **`dscheck.usg`** — single source of truth for the user-facing
+  documentation displayed by `dscheck -?` and rendered as the
+  [user guide](https://gdex-docs-dscheck.readthedocs.io).  Section 3
+  lists Action options, Section 4 lists Mode options, and Section 5
+  lists Single- and Multi-Value Info options.  When you add a new
+  option to `OPTS` in `pg_check.py`, add a matching entry to the
+  appropriate subsection of this file and (if relevant) to the
+  per-action usage block in Section 3.
+
+### Installing from PyPI
+
+The package is published on [PyPI](https://pypi.org/project/rda_python_dscheck/),
+so the regular install command is:
+
+```bash
+pip install rda_python_dscheck
+```
+
+To upgrade an existing install to the latest published release:
+
+```bash
+pip install --upgrade rda_python_dscheck
+```
+
+This pulls in `rda_python_common` (which provides `PgCMD`, `PgLOG`,
+`PgDBI`, ...) and registers the `setuid_dscheck` console script.
+
+### Installing for development
+
+For local changes, clone the repo and install in editable mode so that
+edits are picked up immediately without reinstalling:
+
+```bash
+git clone https://github.com/NCAR/rda-python-dscheck.git
+cd rda-python-dscheck
+pip install -e .
+```
+
+## Documentation sync
+
+The user guide rendered at
+[gdex-docs-dscheck.readthedocs.io](https://gdex-docs-dscheck.readthedocs.io) is
+generated from `src/rda_python_dscheck/dscheck.usg` in this repository.  When a
+pull request that modifies `dscheck.usg` is merged here, an automated workflow
+converts the updated `dscheck.usg` into the RST-format source files in the
+[gdex-docs-dscheck](https://github.com/NCAR/gdex-docs-dscheck) repository and
+opens a pull request there with the regenerated docs, ready for review and
+merge.  No manual RST editing is required — keep all user-facing content in
+`dscheck.usg` and let the sync produce the docs.
+

rda_python_dscheck-2.0.8.dist-info/RECORD

@@ -0,0 +1,12 @@
+rda_python_dscheck/PgCheck.py,sha256=lvh0XSWJID9J9fjqmDtpq6xW2ULC-bChAxAkm8MFzbk,64217
+rda_python_dscheck/__init__.py,sha256=4Wtgj9ephcxz20cPTI4SZ_XCuCM0oqtfq9wL8kcVr3Y,734
+rda_python_dscheck/ds_check.py,sha256=-js5Ex1k7V8ziE_k-ld5Z0l44QGYhvQtdYri9vsqNJA,24303
+rda_python_dscheck/dscheck.py,sha256=-vv7gw4xYIa1xofWo-o3972dDnR_FQZxZz6_S_kCCuk,24805
+rda_python_dscheck/dscheck.usg,sha256=zvghJK0XKXlSNopI1G8PYorRVUkpXoZLmFWQGqGAmBQ,31662
+rda_python_dscheck/pg_check.py,sha256=ftmXSGXWeusQPV9FA6-3_fzhbfDCGfDIgjAK5yxi2jA,67476
+rda_python_dscheck-2.0.8.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_dscheck-2.0.8.dist-info/METADATA,sha256=WDn3PoFKAR6BkmOE16Rfhz9Hbt2kw4mAwm_GyZTZfpE,3689
+rda_python_dscheck-2.0.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_dscheck-2.0.8.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
+rda_python_dscheck-2.0.8.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
+rda_python_dscheck-2.0.8.dist-info/RECORD,,

rda_python_dscheck-2.0.7.dist-info/METADATA

@@ -1,22 +0,0 @@
-Metadata-Version: 2.4
-Name: rda_python_dscheck
-Version: 2.0.7
-Summary: RDA python package to add and process batch jobs
-Author-email: Zaihua Ji <zji@ucar.edu>
-Project-URL: Homepage, https://github.com/NCAR/rda-python-dscheck
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: rda_python_common
-Dynamic: license-file
-
-# dscheck
-
-Python project to add and process batch jobs for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
-
-The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dscheck.readthedocs.io).
-

rda_python_dscheck-2.0.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-rda_python_dscheck/PgCheck.py,sha256=lvh0XSWJID9J9fjqmDtpq6xW2ULC-bChAxAkm8MFzbk,64217
-rda_python_dscheck/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-rda_python_dscheck/ds_check.py,sha256=-js5Ex1k7V8ziE_k-ld5Z0l44QGYhvQtdYri9vsqNJA,24303
-rda_python_dscheck/dscheck.py,sha256=-vv7gw4xYIa1xofWo-o3972dDnR_FQZxZz6_S_kCCuk,24805
-rda_python_dscheck/dscheck.usg,sha256=upCHGwRcjrLoue4Z9nE3pMDZ3s09Qq1ujEH2eJhb2cg,32036
-rda_python_dscheck/pg_check.py,sha256=Riv1nJYocSKLDsOIIYmOmkKlWZLKDrA1uPpbUEYo1uo,67388
-rda_python_dscheck-2.0.7.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_dscheck-2.0.7.dist-info/METADATA,sha256=ezkK1sDQXrTcaTtHRlemEpeBOBQDmCOcHFLwuJainQk,812
-rda_python_dscheck-2.0.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_dscheck-2.0.7.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
-rda_python_dscheck-2.0.7.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
-rda_python_dscheck-2.0.7.dist-info/RECORD,,