Skip to content

Commit

Permalink
Hstouchdocupdate (#140)
Browse files Browse the repository at this point in the history 
* refactor app help, pass1

* unify arg processing for additional cmds

* clean up pyflake warnings
  • Loading branch information
@jreadey
jreadey authored Feb 28, 2023
1 parent 46a5165 commit c66ab25
Show file tree
Hide file tree
Showing 15 changed files with 1,303 additions and 1,650 deletions.
12 changes: 0 additions & 12 deletions h5pyd/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@

from __future__ import absolute_import

#from . import _conv
#_conv.register_converters()

#from . import h5a, h5d, h5ds, h5f, h5fd, h5g, h5r, h5s, h5t, h5p, h5z

#h5s.NULL = h5s._NULL # NULL is a reserved name at the Cython layer
#h5z._register_lzf()

#from .highlevel import *

from . import version
from ._hl.base import Empty
from ._hl.h5type import special_dtype, Reference, RegionReference
Expand All @@ -40,11 +30,9 @@


from .config import Config
#from . import hsinfo
__version__ = version.version



__doc__ = \
"""
This is the h5pyd package, a Python interface to the HDF REST Server.
Expand Down
301 changes: 273 additions & 28 deletions h5pyd/_apps/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,98 @@
# request a copy from [email protected]. #
##############################################################################
import os
import sys
import json
import logging

default_cfg = {
"hs_endpoint": {
"default": None,
"flags": ["-e", "--endpoint"],
"help": "server endpoint, e.g. http://hsdshdflab.hdfgroup.org",
"choices": ["ENDPOINT",]
},
"hs_username": {
"default": None,
"flags": ["-u", "--user"],
"help": "user name credential",
"choices": ["USERNAME",]
},
"hs_password": {
"default": None,
"flags": ["-p", "--password"],
"help": "password credential",
"choices": ["PASSWORD",]
},
"hs_api_key": {
"default": None,
"flags": ["--api_key",],
"help": "user api key",
"choices": ["API_KEY"]
},
"hs_bucket": {
"default": None,
"flags": ["--bucket",],
"help": "storage Bucket to use (S3 Bucket, Azure Container, or top-level directory)",
"choices": ["BUCKET",]
},

"loglevel": {
"default": "error",
"flags": ["--loglevel",],
"help": "logging verbosity",
"choices": ["debug", "info", "warning", "error"],
},
"logfile": {
"default": None,
"flags": ["--logfile",],
"help": "file to send logout to (otherwise stdout)",
"choices": ["FILENAME",]
},
"verbose": {
"default": False,
"flags": ["--verbose", "-v"],
"help": "verbose output",
},
"ignore": {
"default": False,
"flags": ["--ignore",],
"help": "don't exit on error"
}
}

hscmds = ("hsinfo", "hsconfigure", "hsls", "hstouch", "hsload", "hsget", "hsacl", "hsrm", "hsdiff")

class Config:
"""
User Config state
"""
def __init__(self, config_file=None, **kwargs):
self._cfg = {}
def __init__(self, config_file=None, custom_entries=[], **kwargs):
self._names = []
self._values = {}
self._flags = {}
self._help = {}
self._choices = {}
self._flag_map = {}

# set default entries
for defaults in (default_cfg, custom_entries):
for name in defaults:
if name in self._names:
raise ValueError(f"config {name} already set")
entry = defaults[name]
self._names.append(name)
if "default" in entry:
self._values[name] = entry["default"]
if "flags" in entry:
self._flags[name] = entry["flags"]
for flag in entry["flags"]:
self._flag_map[flag] = name
if "help" in entry:
self._help[name] = entry["help"]
if "choices" in entry:
self._choices[name] = entry["choices"]

if config_file:
self._config_file = config_file
elif os.path.isfile(".hscfg"):
Expand All @@ -38,54 +122,215 @@ def __init__(self, config_file=None, **kwargs):
continue
fields = s.split('=')
if len(fields) < 2:
print("config file: {} line: {} is not valid".format(self._config_file, line_number))
print(f"config file: {self._config_file} line: {line_number} is not valid")
continue
k = fields[0].strip()
v = fields[1].strip()
self._cfg[k] = v
if k not in self._names:
raise ValueError(f"undefined option: {name}")
if k in self._choices:
choices = self._choices[k]
if len(choices) > 1 and v not in self._choices:
raise ValueError(f"option {k} must be one of {choices}")
self._values[k] = v
# override any config values with environment variable if found
for k in self._cfg.keys():
for k in self._names:
if k.upper() in os.environ:
self._cfg[k] = os.environ[k.upper()]
v = os.environ[k.upper()]
if name in self._choices:
choices = self._choices[name]
if len(choices) > 1 and v not in self._choices:
raise ValueError(f"option {name} must be one of {choices}")
self._values[name] = v

# finally update any values that are passed in to the constructor
for k in kwargs.keys():
self._cfg[k] = kwargs[k]
for name in kwargs.keys():
if name in self._names:
v = kwargs[name]
if name in self._choices:
choices = self._choices[name]
if len(choices) > 1 and v not in self._choices:
raise ValueError(f"option {name} must be one of {choices}")
self._values[name] = kwargs[name]

def __getitem__(self, name):
""" Get a config item """
if name not in self._cfg:
if name.upper() in os.environ:
self._cfg[name] = os.environ[name.upper()]
else:
return None
return self._cfg[name]

def __setitem__(self, name, obj):
""" set config item """
self._cfg[name] = obj
if name not in self._names:
return None
return self._values[name]

def __delitem__(self, name):
""" Delete option. """
del self._cfg[name]
def setitem(self, name, value, flags=None, choices=None, help=None):
""" Set a config item """
if name not in self._names:
self._names.append(name)
self._values[name] = value
if flags is not None:
self._flags[name] = flags
for flag in flags:
self._flag_map[flag] = name
if choices is not None:
self._choices[name] = choices
if help is not None:
self._help[name] = help

def __setitem__(self, name, value):
self.setitem(name, value)

def __len__(self):
return len(self._cfg)
return len(self._names)

def __iter__(self):
""" Iterate over config names """
keys = self._cfg.keys()
for key in keys:
yield key
for name in self._names:
yield name

def __contains__(self, name):
return name in self._cfg
return name in self._names

def __repr__(self):
return json.dumps(self._cfg)
return json.dumps(self._values)

def keys(self):
return self._cfg.keys()
return self._names

def get_flags(self, name):
if name in self._flags:
return self._flags[name]
else:
return None

def get_help(self, name):
if name in self._help:
return self._help[name]
else:
return None

def get_see_also(self, this_cmd):
msg = "See also the commands: "
for cmd in hscmds:
if cmd != this_cmd:
msg += f"{cmd}, "
msg = msg[:-2] # remove trailing comma
return msg


def get_help_message(self, name):
help_text= self.get_help(name)
flags = self.get_flags(name)
choices = self.get_choices(name)
if not help_text or len(flags) == 0:
return None

msg = flags[0]
for i in range(1, len(flags)):
msg += f", {flags[i]}"
if choices:
if len(choices) == 1:
msg += f" {choices[0]}"
else:
msg += " {"
for choice in choices:
msg += f"{choice}|"
msg = msg[:-1]
msg += "}"
if len(msg) < 40:
pad = " "*(40 - len(msg))
msg += pad

msg += f" {help_text}"

return msg


def get_nargs(self, name):
choices = self._choices.get(name)
if not choices:
return 0
else:
return 1

def get_choices(self, name):
if name in self._choices:
return self._choices[name]
else:
return 0

def get_names(self):
return self._names

def set_cmd_flags(self, args, allow_post_flags=False):
""" process any command line options
return any place argument as a list
"""
options = []
argn = 0
while argn < len(args):
arg = args[argn]
val = None
if len(args) > argn + 1:
val = args[argn+1]
if not arg.startswith("-"):
options.append(arg)
argn += 1
elif options:
if allow_post_flags:
options.append(arg)
argn += 1
else:
raise ValueError("flags must be set before positional arguments")
else:
name = self._flag_map.get(arg)
if arg in ("-h", "--help"):
raise ValueError() # trigger print usage
if name not in self._names:
raise ValueError("option not found")
if not self.get_nargs(name):
# set flag
self._values[name] = True
argn += 1
else:
if not val:
raise ValueError("option value missing")
if self._choices.get(name):
choices = self._choices.get(name)

if choices and len(choices) > 1 and val not in self._choices.get(name):
raise ValueError(f"option value must be one of {self._choices.get(name)}")
self._values[name] = val
argn += 2
return options

def get_loglevel(self):
val = self._values["loglevel"]
val = val.upper()
choices = ("DEBUG", "INFO", "WARNING", "ERROR")
if val == "DEBUG":
loglevel = logging.DEBUG
elif val == "INFO":
loglevel = logging.INFO
elif val in ("WARN", "WARNING"):
loglevel = logging.WARNING
elif val == "ERROR":
loglevel = logging.ERROR
else:
raise ValueError(f"loglevel must be one of {choices}")
return loglevel

def get_cmd(self):
""" return command argument used to invoke"""
cmd = sys.argv[0].split('/')[-1]
if cmd.endswith(".py"):
cmd = "python " + cmd
return cmd

def print(self, msg):
if self._values.get("logfile"):
# write msg to logfile as info
logging.info(msg)
if self._values.get("verbose"):
print(msg)





Expand Down
Loading

0 comments on commit c66ab25

Please sign in to comment.