rda-python-dsarch 3.0.2__py3-none-any.whl → 3.0.5__py3-none-any.whl

rda_python_dsarch/PgArch.py

@@ -176,7 +176,7 @@ PgOPT.OPTS = {                         # (!= 0) - setting actions
    'OG' : [2, 'OriginGroup',   1],
    'OT' : [2, 'OriginType',    1],
    'PI' : [2, 'ParentIndex',  17],
-   'QF' : [2, 'QuasarFile',    0],
+   'QF' : [2, 'QuasarFile',    0, ''],
    'QT' : [2, 'QuasarFileType',  129, 'BD'],
    'RF' : [2, 'OriginFile',    0],
    'SF' : [2, 'SavedFile',     0],

rda_python_dsarch/__init__.py

@@ -20,7 +20,7 @@ object that existing callers expect.
 
 from . import PgArch, PgMeta
 
-__version__ = "2.0.21"
+__version__ = "2.0.22"
 
 __all__ = [
    "PgArch",

rda_python_dsarch/ds_arch.py

@@ -3846,6 +3846,7 @@ def delete_web_files():
    reorder = metatotal = metacnt = dcnt = mcnt = ocnt = wcnt = 0
    PgArch.cache_group_info(ALLCNT, 0)
    PgOPT.validate_multiple_options(ALLCNT, ["WT", 'VI', 'QF', 'LC'])
+   if 'QF' in PgOPT.params: PgOPT.params['QF'] = PgArch.get_bid_numbers(PgOPT.params['QF'])
 
    if PgLOG.PGLOG['DSCHECK']:
       bidx = PgCMD.set_dscheck_fcount(ALLCNT, PgOPT.PGOPT['extlog'])
@@ -3898,7 +3899,7 @@ def delete_web_files():
             continue
          bid = PgOPT.params['QF'][i] if 'QF' in PgOPT.params else pgrec['bid']
          if bid:
-            PgLOG.pglog(wfile + ": Web file is Quasar backed up, add option -qf '' to force delete", PgOPT.PGOPT['errlog'])
+            PgLOG.pglog(wfile + ": Web file is Quasar backed up, add option -qf 0 to force delete", PgOPT.PGOPT['errlog'])
             continue
          if PgOPT.PGOPT['GXTYP'].find(type) > -1 and ('DX' in PgOPT.params or pgrec and pgrec['meta_link'] and pgrec['meta_link'] != 'N'):
             metacnt += PgMeta.record_meta_delete('W', dsid, wfile)
@@ -4498,6 +4499,7 @@ def delete_saved_files():
    bidx = chksize = reorder = scnt = ocnt = dcnt = 0
    PgArch.cache_group_info(ALLCNT, 0)
    PgOPT.validate_multiple_options(ALLCNT, ["ST", 'VI', 'QF', 'LC'])
+   if 'QF' in PgOPT.params: PgOPT.params['QF'] = PgArch.get_bid_numbers(PgOPT.params['QF'])
 
    if PgLOG.PGLOG['DSCHECK']:
       bidx = PgCMD.set_dscheck_fcount(ALLCNT, PgOPT.PGOPT['extlog'])
@@ -4550,7 +4552,7 @@ def delete_saved_files():
             continue
          bid = PgOPT.params['QF'][i] if 'QF' in PgOPT.params else pgrec['bid']
          if bid:
-            PgLOG.pglog(sfile + ": Saved file is Quasar backed up, add option -qf '' to force delete", PgOPT.PGOPT['errlog'])
+            PgLOG.pglog(sfile + ": Saved file is Quasar backed up, add option -qf 0 to force delete", PgOPT.PGOPT['errlog'])
             continue
 
       if sdel:

rda_python_dsarch/dsarch.py

@@ -3634,6 +3634,7 @@ class DsArch(PgArch, PgMeta):
       reorder = metatotal = metacnt = dcnt = mcnt = ocnt = wcnt = 0
       self.cache_group_info(self.ALLCNT, 0)
       self.validate_multiple_options(self.ALLCNT, ["WT", 'VI', 'QF', 'LC'])
+      if 'QF' in self.params: self.params['QF'] = self.get_bid_numbers(self.params['QF'])
       if self.PGLOG['DSCHECK']:
          bidx = self.set_dscheck_fcount(self.ALLCNT, self.PGOPT['extlog'])
          if bidx > 0:
@@ -3681,7 +3682,7 @@ class DsArch(PgArch, PgMeta):
                continue
             bid = self.params['QF'][i] if 'QF' in self.params else pgrec['bid']
             if bid:
-               self.pglog(wfile + ": Web file is Quasar backed up, add option -qf '' to force delete", self.PGOPT['errlog'])
+               self.pglog(wfile + ": Web file is Quasar backed up, add option -qf 0 to force delete", self.PGOPT['errlog'])
                continue
             if self.PGOPT['GXTYP'].find(type) > -1 and ('DX' in self.params or pgrec and pgrec['meta_link'] and pgrec['meta_link'] != 'N'):
                metacnt += self.record_meta_delete('W', dsid, wfile)
@@ -4224,6 +4225,7 @@ class DsArch(PgArch, PgMeta):
       bidx = chksize = reorder = scnt = dcnt = 0
       self.cache_group_info(self.ALLCNT, 0)
       self.validate_multiple_options(self.ALLCNT, ["ST", 'VI', 'QF', 'LC'])
+      if 'QF' in self.params: self.params['QF'] = self.get_bid_numbers(self.params['QF'])
       if self.PGLOG['DSCHECK']:
          bidx = self.set_dscheck_fcount(self.ALLCNT, self.PGOPT['extlog'])
          if bidx > 0:
@@ -4260,7 +4262,7 @@ class DsArch(PgArch, PgMeta):
                continue
             bid = self.params['QF'][i] if 'QF' in self.params else pgrec['bid']
             if bid:
-               self.pglog(sfile + ": Saved file is Quasar backed up, add option -qf '' to force delete", self.PGOPT['errlog'])
+               self.pglog(sfile + ": Saved file is Quasar backed up, add option -qf 0 to force delete", self.PGOPT['errlog'])
                continue
          if sdel:
             afile = self.get_saved_path(i, self.params['SF'][i], 1, type)

rda_python_dsarch/dsarch.usg

@@ -97,19 +97,23 @@ Only Web data files are placed under DOI/Version control. Saved data
 staged on disk for internal use or NCAR user access is not version-
 controlled and remains the responsibility of the dataset owner.
 
-This user guide is generated from this file. Opening a pull request that
-modifies it in the GitHub repository https://github.com/NCAR/rda-python-dsarch
-triggers an automated workflow that converts it into the RST source files,
-syncs the rda_python_dsarch version into the documentation, and opens a new
-pull request for review in the GitHub repository
+The 'dsarch' user guide hosted on Read the Docs is generated from this
+'dsarch.usg' file. Opening a pull request that modifies this 'dsarch.usg'
+file in the GitHub repository https://github.com/NCAR/rda-python-dsarch
+triggers an automated workflow that converts the file into the RST source
+files, syncs the rda_python_dsarch version into the documentation, and opens
+a new pull request for review in the GitHub repository
 https://github.com/NCAR/gdex-docs-dsarch. Merging that pull request
-publishes the content as the 'latest' version at
+publishes the user guide as the 'latest' version at
 https://gdex-docs-dsarch.readthedocs.io, and creating a GitHub release
 there publishes it as the 'stable' version.
 
-This document first covers general 'dsarch' usage, then describes each
-Action option in detail, followed by Mode and Information (Info for
-short) options. Examples are provided throughout each section.
+The remainder of this document is organized as follows. Section 2 covers
+general usage and conventions. Section 3 describes Action options grouped
+by what they manipulate (dataset records, DOI/Version controls, groups,
+files, all-information, and webpages). Section 4 lists Mode options that
+modify how an action behaves. Section 5 lists Information options that
+pass values into an action.
 
 
 2 GENERAL DSARCH USAGE
@@ -118,59 +122,85 @@ short) options. Examples are provided throughout each section.
       or
   dsarch [-(IF|InputFile)] InputFileNames
 
-Brackets [] indicate optional elements. A pipe '|' within parentheses,
-as in (A|B), means either A or B may be used. Options fall into three
-categories:
-  Action options - specify the task to execute
-  Mode options   - modify how an action behaves
-  Info options   - supply values to the action
-
-Options may be given in short or long form (e.g., -DS or -Dataset). Some
-options have alias names; for example, -UseRDADB is an alias for -UD
-(-UseDSARCH). Option names are case-insensitive, but values following
-Info options are case-sensitive.
-
-Option -DS specifies the dataset number. It is listed separately because
-most actions require it. When -DS is the first argument after 'dsarch',
-the option name itself may be omitted — just supply the dataset number
-directly.
-
-Specify exactly one Action option per 'dsarch' invocation. Each action
-has its own set of required and optional Info options, and may accept
-specific Mode options that adjust its behavior.
-
-All options except -IF (-InputFile) may be given either on the command
-line or in input files. Input file names are specified via -IF and can
-only be supplied on the command line. See the -IF option description for
-details on how to format options in input files. One or more input files
-may be combined with command-line options. The -IF option name itself
-may be omitted when a single input file is given on the command line and
-all action and option information is contained within that file.
-
-Info options used with GET actions serve as query filters. Four special
-characters enable more precise filtering — they must be quoted or
-escaped on the command line to prevent shell interpretation:
-   '!'  - exclude matches; must appear immediately after the option name
-          (may need escaping as '\!' in some shells due to history
-          expansion)
-   '<'  - less-than comparison on the following value
-   '>'  - greater-than comparison on the following value
-   '<>' - range between two values
-
-Combining '!' and '<' as "'!' '<' OptionValue" expresses a 'greater than
-or equal to OptionValue' condition.
-
-The description of an individual option is shown when 'dsarch' is run as
+Notation:
+  []       - the enclosed element is optional.
+  (A|B)    - either A or B may be used (a short form and a long form).
+  -<OPT>   - OPT is an option name. Names are case-insensitive; values are not.
+
+Every dsarch invocation has at most one Action option, which selects the
+task to perform. Mode options change how the chosen action behaves. Info
+options carry the data the action needs (file names, group indices, dates,
+etc.). Each action documents which Info options are required and which are
+optional.
+
+Option -DS (-Dataset) supplies the dataset number. It is listed separately
+because most actions require it. When -DS is the first argument after
+'dsarch', the option name itself may be omitted — just supply the dataset
+number directly.
+
+Many options have an alias for convenience; for example, -UseRDADB is an
+alias for -UD (-UseDSARCH). Both short and long forms are accepted, and
+aliases are noted with each option.
+
+2.1 Quick Start
+
+  Show the full document, paged through 'more':
+  dsarch
+
+  Show the description of a single option:
+  dsarch -h -AW
+
+  Retrieve a dataset record from GDEXDB:
+  dsarch d260001 -GD
+
+  Set the UseDSARCH flag so the dataset can be archived:
+  dsarch d260001 -SD -UD Y
+
+  Archive a local file as a Web file:
+  dsarch d260001 -AW -LF data.nc
+
+  Retrieve the Web file records for a dataset:
+  dsarch d260001 -GW
+
+2.2 Filters and Special Characters in Queries
+
+For Get-style actions (-GD, -GV, -GG, -GS, -GW, -GH, -GQ), Info options are
+interpreted as query filters. Four characters refine those filters; quote or
+escape them on the command line so the shell does not consume them:
+
+  '!'   - negate the match. Must appear immediately after the option name
+          (may need escaping as '\!' in some shells due to history expansion).
+  '<'   - less-than comparison against the next value.
+  '>'   - greater-than comparison against the next value.
+  '<>'  - range between the next two values (inclusive).
+
+The combination "'!' '<' value" expresses 'greater than or equal to value'.
+
+2.3 Input Files
+
+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 dsarch 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. 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).
+
+As a safeguard against operating on the wrong dataset, input file names must
+begin with the dataset number in the format 'dNNNNNN.*', where '*' matches
+one or more valid filename characters.
+
+2.4 Getting Help
 
   dsarch [Option] -(h|help) [Option]
 
-The description is shown for the option placed either before or after
--(h|help). If no option is given, or 'dsarch' is run without arguments,
-the full document is displayed using the UNIX 'more' utility. A hard
-copy of this document can be printed from the saved file, dsarch.usg,
-in the rda_python_dsarch Python package.
+The description of a single option is shown when -h (-help) is given with
+that option, placed either before or after -h. With no option, or when
+'dsarch' is run without arguments, the full document is displayed through
+the UNIX 'more' utility. A printable copy of this document is the file
+dsarch.usg installed under the python package rda_python_dsarch.
 
-#The online version of this document is available at
+#The online HTML version of this document is available at
 #https://gdex-docs-dsarch.readthedocs.io
 
 
@@ -2259,7 +2289,9 @@ They come in two forms:
   parent group for a subgroup. Groups can be nested to any depth.
 
   -QF or -QuasarFile, the name of the Quasar backup (tar) file,
-  required for -AQ (-ArchiveQuasarFile).
+  required for -AQ (-ArchiveQuasarFile).  Give -QF 0 with -DL
+  (-DeleteFile) to force delete a Web or Saved file that is Quasar
+  backed up.
 
   -QT or -QuasarFileType (Alias: -QuasarType|-BackupType), the
   backup scope: 'B' (backup only) or 'D' (backup plus disaster

rda_python_dsarch/pg_arch.py

@@ -192,7 +192,7 @@ class PgArch(PgOPT, PgCMD, PgSplit):
          'OG' : [2, 'OriginGroup',   1],
          'OT' : [2, 'OriginType',    1],
          'PI' : [2, 'ParentIndex',  17],
-         'QF' : [2, 'QuasarFile',    0],
+         'QF' : [2, 'QuasarFile',    0, ''],
          'QT' : [2, 'QuasarFileType',  129, 'BD'],
          'RF' : [2, 'OriginFile',    0],
          'SF' : [2, 'SavedFile',     0],

{rda_python_dsarch-3.0.2.dist-info → rda_python_dsarch-3.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 3.0.2
+Version: 3.0.5
 Summary: RDA Python package for utility program dsarch archive RDA data
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-dsarch

rda_python_dsarch-3.0.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+rda_python_dsarch/PgArch.py,sha256=ejk31T2F2AONR7ZF3fzRJjlqZZsVnQzyE_Gjo9XvyVM,59456
+rda_python_dsarch/PgMeta.py,sha256=FV4GytgnJK00FUlyM6iHqpNd7-XTVHO1j5tZtcLTWgY,26845
+rda_python_dsarch/__init__.py,sha256=-ympZMoYfvP0lxSq06GWQemQlj4HwV9tm1JNxKpSU90,812
+rda_python_dsarch/ds_arch.py,sha256=PgS5wb4vTXJUBm7ADetCbm-eVYLqPVzQdiFEfe3QEns,233992
+rda_python_dsarch/dsarch.py,sha256=socETNVY5DamCtxxjm__zNpd6nn2nmvbvgDIaib2_ac,255283
+rda_python_dsarch/dsarch.usg,sha256=HNB9NFEkwi_EUsMjyN-hvpAao1DNtJ6WDXkgBax8imA,107740
+rda_python_dsarch/pg_arch.py,sha256=3Dg_39o92o-9lzPaij-BjTJTrwNPepf9n5jkVNRHuj0,81061
+rda_python_dsarch/pg_meta.py,sha256=FFEkphGAT--66zvMNDPfiFG4nZQpXed_yVGMARdZb-o,46981
+rda_python_dsarch-3.0.5.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_dsarch-3.0.5.dist-info/METADATA,sha256=ZXay9bDWIMzzKSdnSjMc0Kjny5JjIlyt80n9DF4IFMw,7165
+rda_python_dsarch-3.0.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_dsarch-3.0.5.dist-info/entry_points.txt,sha256=BA1iRAFIZExG0656Ri9f-_OKlSK31CuABWPQSsA9MsI,64
+rda_python_dsarch-3.0.5.dist-info/top_level.txt,sha256=-vwcMgUXbBdHscvAKB3De9zKac3m_s_FaKIdApP1FGY,18
+rda_python_dsarch-3.0.5.dist-info/RECORD,,

rda_python_dsarch-3.0.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-rda_python_dsarch/PgArch.py,sha256=d1Y87MT49tgQygLAffNff9Qs4c12KXspYyDG8liSnpQ,59452
-rda_python_dsarch/PgMeta.py,sha256=FV4GytgnJK00FUlyM6iHqpNd7-XTVHO1j5tZtcLTWgY,26845
-rda_python_dsarch/__init__.py,sha256=Y-s3WV6vKvLYuMy6oy0FB9DYNVaiEaSjZVJYBMVlD_8,812
-rda_python_dsarch/ds_arch.py,sha256=6bR0y6_rhIXyvbuYd-oZfL1YcaHhWBkojjzYz1yCrVg,233810
-rda_python_dsarch/dsarch.py,sha256=wQZS-mI4vyc7GDKOMl--_wQejx4_Wa77hegF_9deZX8,255105
-rda_python_dsarch/dsarch.usg,sha256=VWNqPYiALbglTWpQ0eWSE6TpVSjl8Xzl6MjoWZPTSAs,106715
-rda_python_dsarch/pg_arch.py,sha256=0mZGlQT9ecJr-92dloXDNtwF8EnPnY76IGLksqYsyYo,81057
-rda_python_dsarch/pg_meta.py,sha256=FFEkphGAT--66zvMNDPfiFG4nZQpXed_yVGMARdZb-o,46981
-rda_python_dsarch-3.0.2.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_dsarch-3.0.2.dist-info/METADATA,sha256=M64SImUspzEEA1GPDt1PbeAk7xdDkzFiioCe6t6rti0,7165
-rda_python_dsarch-3.0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_dsarch-3.0.2.dist-info/entry_points.txt,sha256=BA1iRAFIZExG0656Ri9f-_OKlSK31CuABWPQSsA9MsI,64
-rda_python_dsarch-3.0.2.dist-info/top_level.txt,sha256=-vwcMgUXbBdHscvAKB3De9zKac3m_s_FaKIdApP1FGY,18
-rda_python_dsarch-3.0.2.dist-info/RECORD,,