Skip to content

save change #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zaihuaji merged 3 commits into from
Mar 24, 2026
Merged

save change #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0f1e26
save change
Mar 24, 2026
faa38a6
PgLOG. => self.
Mar 24, 2026
7f43944
Update pg_rst.py
zaihuaji Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "rda_python_miscs"
version = "2.0.2"
version = "2.0.3"
authors = [
{ name="Zaihua Ji", email="zji@ucar.edu" },
]
Expand Down
111 changes: 58 additions & 53 deletions src/rda_python_miscs/pg_rst.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import argparse
import importlib
from os import path as op
import PgLOG
from rda_python_common.pg_LOG import PgLOG
from rda_python_common.pg_file import PgFile
from rda_python_common.pg_util import PgUtil

Expand Down Expand Up @@ -142,17 +142,17 @@ def process_docs(self, docname, opts, alias):
self.ALIAS = alias

self.parse_docs(docname)
if not self.sections: PgLOG.pglog(docname + ": empty document", PgLOG.LGWNEX)
if not self.sections: self.pglog(docname + ": empty document", self.LGWNEX)

self.DOCS['DOCNAM'] = docname
if docname in self.LINKS: self.LINKS.remove(docname)
self.DOCS['DOCLNK'] = r"({})".format('|'.join(self.LINKS))
self.DOCS['DOCTIT'] = docname.upper()
self.change_local_directory(self.DOCS['DOCDIR'], PgLOG.LGWNEX)
PgLOG.pglog("Write rst document '{}' under {}".format(docname, self.DOCS['DOCDIR']), PgLOG.LOGWRN)
self.change_local_directory(self.DOCS['DOCDIR'], self.LGWNEX)
self.pglog("Write rst document '{}' under {}".format(docname, self.DOCS['DOCDIR']), self.LOGWRN)

if op.exists("index.rst"): # write index file once
PgLOG.pglog("index.rst exists already, delete first if needs to be regenerated", PgLOG.LOGWRN)
self.pglog("index.rst exists already, delete first if needs to be regenerated", self.LOGWRN)
else:
self.write_index(self.sections[0])

Expand All @@ -176,7 +176,7 @@ def parse_docs(self, docname):
docname (str): Short document name used to locate ``<ORIGIN>/<docname>.usg``.
"""
docfile = "{}/{}.usg".format(self.DOCS['ORIGIN'], docname)
PgLOG.pglog("Parsing info for Document '{}'".format(docname), PgLOG.LOGWRN)
self.pglog("Parsing info for Document '{}'".format(docname), self.LOGWRN)
section = self.init_section('0', "Preface")
option = example = None
fh = open(docfile, 'r')
Expand Down Expand Up @@ -227,11 +227,11 @@ def parse_docs(self, docname):
# check completion of options
for opt in self.OPTS:
if opt not in self.options:
PgLOG.pglog("Missing option Entry -{} (-{}) in Document '{}'".format(opt, self.OPTS[opt][1], docname), PgLOG.LOGWRN)
self.pglog("Missing option Entry -{} (-{}) in Document '{}'".format(opt, self.OPTS[opt][1], docname), self.LOGWRN)
if self.sections:
cnt = len(self.sections)
s = 's' if cnt > 1 else ''
PgLOG.pglog("{} Section{} gathered for '{}'".format(cnt, s, docname), PgLOG.LOGWRN)
self.pglog("{} Section{} gathered for '{}'".format(cnt, s, docname), self.LOGWRN)

#
# cache section information
Expand Down Expand Up @@ -369,7 +369,7 @@ def init_option(self, secid, opt, desc):
types = ("Mode", "Info", "Info", "Action")

if opt not in self.OPTS:
PgLOG.pglog("{} -- option not defined for {}".format(opt, self.DOCS['DOCNAM']), PgLOG.LGWNEX)
self.pglog("{} -- option not defined for {}".format(opt, self.DOCS['DOCNAM']), self.LGWNEX)
option['secid'] = secid
option['opt'] = opt
ms = re.match(r'^(, | \(Alias: .*\), )(.*)', desc)
Expand Down Expand Up @@ -489,15 +489,15 @@ def template_to_rst(self, template, hash, extra=None):
matches = re.findall(r'__([A-Z]+)__', line)
if matches:
for key in matches:
if key not in hash: PgLOG.pglog("{}: not defined at {}({}) {}".format(key, line, idx, tempfile), PgLOG.LGWNEX)
if not hash[key]: PgLOG.pglog(key + ": empty content", PgLOG.LGWNEX)
if key not in hash: self.pglog("{}: not defined at {}({}) {}".format(key, line, idx, tempfile), self.LGWNEX)
if not hash[key]: self.pglog(key + ": empty content", self.LGWNEX)
line = line.replace("__{}__".format(key), hash[key])
rf.write(line + "\n")
line = tf.readline()

tf.close()
rf.close()
PgLOG.pglog("{}{}.rst created from {}.rst.temp".format(template, extra, template), PgLOG.LOGWRN)
self.pglog("{}{}.rst created from {}.rst.temp".format(template, extra, template), self.LOGWRN)

#
# create rst content for table of contents
Expand Down Expand Up @@ -778,7 +778,7 @@ def create_description(self, desc, secid, dtype):
str: RST-formatted description content.
"""
if desc == "\n": return ''
ptype = 0 # paragraph type: 0 - normal, 1 - table, 2 - synopsis
ptype = 0 # paragraph type: 0 - normal, 1 - table, 2 = synopsis
content = ''
cnt = 0
alllines = re.split(r'\n', desc)
Expand Down Expand Up @@ -1080,7 +1080,7 @@ def get_short_option(self, p):
for alias in self.ALIAS[opt]:
if re.match(r'^{}$'.format(alias), p, re.I): return opt

PgLOG.pglog("{} - unknown option for {}".format(p, self.DOCS['DOCNAM']), PgLOG.LGWNEX)
self.pglog("{} - unknown option for {}".format(p, self.DOCS['DOCNAM']), self.LGWNEX)

#
# replace with rst link for a given section title
Expand Down Expand Up @@ -1118,7 +1118,7 @@ def get_section(self, secid):
for section in self.sections:
if section['secid'] == secid: return section

PgLOG.pglog("Unknown Section ID {}".format(secid), PgLOG.LGWNEX)
self.pglog("Unknown Section ID {}".format(secid), self.LGWNEX)


# ---------------------------------------------------------------------------
Expand Down Expand Up @@ -1195,41 +1195,46 @@ def _load_opts_alias(docname):
return opts, alias, origin


if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=(
"Generate RST documentation from a structured .usg source document.\n\n"
"OPTS and ALIAS are loaded from rda_python_<docname>/<docname>.py: "
"the module is searched first for module-level OPTS/ALIAS variables, "
"then for a class defined in that module that carries both as class "
"attributes."
),
formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument(
'docname',
help=(
"Short document name, e.g. 'dsarch' or 'dsupdt'. "
"The module rda_python_<docname>/<docname>.py must be importable "
"and must define OPTS (and optionally ALIAS) either at module "
"level or as class attributes."
),
)
parser.add_argument(
'--docdir',
default=None,
metavar='DIR',
help=(
"Root directory under which the per-document RST output directory "
"is created (default: current working directory). "
"The final output lands in <docdir>/<docname>/."
),
)
args = parser.parse_args()

opts, alias, origin = _load_opts_alias(args.docname)
pg = PgRST()
pg.DOCS['ORIGIN'] = origin
if args.docdir is not None:
pg.DOCS['DOCDIR'] = args.docdir
pg.process_docs(args.docname, opts, alias)
def main():
"""Entry point for command-line usage of pg_rst.py."""
import argparse
parser = argparse.ArgumentParser(
description=(
"Convert a .usg help document to reStructuredText (.rst) using RST templates. "
"OPTS and ALIAS are loaded from rda_python_<docname>/<docname>.py: "
"the module is searched first for module-level OPTS/ALIAS variables, "
"then for a class defined in that module that carries both as class "
"attributes."
),
formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument(
'docname',
help=(
"Short document name, e.g. 'dsarch' or 'dsupdt'. "
"The module rda_python_<docname>/<docname>.py must be importable "
"and must define OPTS (and optionally ALIAS) either at module "
"level or as class attributes."
),
)
parser.add_argument(
'--docdir',
default=None,
metavar='DIR',
help=(
"Root directory under which the per-document RST output directory "
"is created (default: current working directory). "
"The final output lands in <docdir>/<docname>/."
),
)
args = parser.parse_args()

opts, alias, origin = _load_opts_alias(args.docname)
pg = PgRST()
pg.DOCS['ORIGIN'] = origin
if args.docdir is not None:
pg.DOCS['DOCDIR'] = args.docdir
pg.process_docs(args.docname, opts, alias)

if __name__ == "__main__":
main()
Loading