Skip to content

Commit

Permalink
T6695: normalize formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@natali-rs1985
natali-rs1985 committed Oct 11, 2024
1 parent 60cd669 commit 5c76607
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 98 deletions.
163 changes: 102 additions & 61 deletions python/vyos/opmode.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,71 +20,90 @@


class Error(Exception):
""" Any error that makes requested operation impossible to complete
for reasons unrelated to the user input or script logic.
"""Any error that makes requested operation impossible to complete
for reasons unrelated to the user input or script logic.
This is the base class, scripts should not use it directly
and should raise more specific errors instead,
whenever possible.
This is the base class, scripts should not use it directly
and should raise more specific errors instead,
whenever possible.
"""

pass


class UnconfiguredSubsystem(Error):
""" Requested operation is valid, but cannot be completed
because corresponding subsystem is not configured
and thus is not running.
"""Requested operation is valid, but cannot be completed
because corresponding subsystem is not configured
and thus is not running.
"""

pass


class UnconfiguredObject(UnconfiguredSubsystem):
""" Requested operation is valid but cannot be completed
because its parameter refers to an object that does not exist
in the system configuration.
"""Requested operation is valid but cannot be completed
because its parameter refers to an object that does not exist
in the system configuration.
"""

pass


class DataUnavailable(Error):
""" Requested operation is valid, but cannot be completed
because data for it is not available.
This error MAY be treated as temporary because such issues
are often caused by transient events such as service restarts.
"""Requested operation is valid, but cannot be completed
because data for it is not available.
This error MAY be treated as temporary because such issues
are often caused by transient events such as service restarts.
"""

pass


class PermissionDenied(Error):
""" Requested operation is valid, but the caller has no permission
to perform it.
"""Requested operation is valid, but the caller has no permission
to perform it.
"""

pass


class InsufficientResources(Error):
""" Requested operation and its arguments are valid but the system
does not have enough resources (such as drive space or memory)
to complete it.
"""Requested operation and its arguments are valid but the system
does not have enough resources (such as drive space or memory)
to complete it.
"""

pass


class UnsupportedOperation(Error):
""" Requested operation is technically valid but is not implemented yet. """
"""Requested operation is technically valid but is not implemented yet."""

pass


class IncorrectValue(Error):
""" Requested operation is valid, but an argument provided has an
incorrect value, preventing successful completion.
"""Requested operation is valid, but an argument provided has an
incorrect value, preventing successful completion.
"""

pass


class CommitInProgress(Error):
""" Requested operation is valid, but not possible at the time due
"""Requested operation is valid, but not possible at the time due
to a commit being in progress.
"""

pass


class InternalError(Error):
""" Any situation when VyOS detects that it could not perform
an operation correctly due to logic errors in its own code
or errors in underlying software.
"""Any situation when VyOS detects that it could not perform
an operation correctly due to logic errors in its own code
or errors in underlying software.
"""

pass


Expand All @@ -97,12 +116,14 @@ def _is_op_mode_function_name(name):
else:
return False


def _capture_output(name):
if re.match(r"^(show|generate)", name):
if re.match(r'^(show|generate)', name):
return True
else:
return False


def _get_op_mode_functions(module):
from inspect import getmembers, isfunction

Expand All @@ -113,32 +134,35 @@ def _get_op_mode_functions(module):
funcs = list(filter(lambda ft: _is_op_mode_function_name(ft[0]), funcs))

funcs_dict = {}
for (name, thunk) in funcs:
for name, thunk in funcs:
funcs_dict[name] = thunk

return funcs_dict


def _is_optional_type(t):
# Optional[t] is internally an alias for Union[t, NoneType]
# and there's no easy way to get union members it seems
if (type(t) == typing._UnionGenericAlias):
if (len(t.__args__) == 2):
if t.__args__[1] == type(None):
if type(t) is typing._UnionGenericAlias:
if len(t.__args__) == 2:
if t.__args__[1] is type(None):
return True

return False


def _get_arg_type(t):
""" Returns the type itself if it's a primitive type,
or the "real" type of typing.Optional
"""Returns the type itself if it's a primitive type,
or the "real" type of typing.Optional
Doesn't work with anything else at the moment!
Doesn't work with anything else at the moment!
"""
if _is_optional_type(t):
return t.__args__[0]
else:
return t


def _is_literal_type(t):
if _is_optional_type(t):
t = _get_arg_type(t)
Expand All @@ -148,16 +172,17 @@ def _is_literal_type(t):

return False


def _get_literal_values(t):
""" Returns the tuple of allowed values for a Literal type
"""
"""Returns the tuple of allowed values for a Literal type"""
if not _is_literal_type(t):
return tuple()
if _is_optional_type(t):
t = _get_arg_type(t)

return typing.get_args(t)


def _normalize_field_name(name):
# Convert the name to string if it is not
# (in some cases they may be numbers)
Expand All @@ -182,6 +207,7 @@ def _normalize_field_name(name):

return name


def _normalize_dict_field_names(old_dict):
new_dict = {}

Expand All @@ -191,10 +217,11 @@ def _normalize_dict_field_names(old_dict):

# Sanity check
if len(old_dict) != len(new_dict):
raise InternalError("Dictionary fields do not allow unique normalization")
raise InternalError('Dictionary fields do not allow unique normalization')
else:
return new_dict


def _normalize_field_names(value):
if isinstance(value, dict):
return _normalize_dict_field_names(value)
Expand All @@ -203,16 +230,19 @@ def _normalize_field_names(value):
else:
return value


def run(module):
from argparse import ArgumentParser

functions = _get_op_mode_functions(module)

parser = ArgumentParser()
subparsers = parser.add_subparsers(dest="subcommand")
subparsers = parser.add_subparsers(dest='subcommand')

for function_name in functions:
subparser = subparsers.add_parser(function_name, help=functions[function_name].__doc__)
subparser = subparsers.add_parser(
function_name, help=functions[function_name].__doc__
)

type_hints = typing.get_type_hints(functions[function_name])
if 'return' in type_hints:
Expand All @@ -225,62 +255,73 @@ def run(module):
# Without this, we'd get options like "--foo_bar"
opt = re.sub(r'_', '-', opt)

if _get_arg_type(th) == bool:
subparser.add_argument(f"--{opt}", action='store_true')
if _get_arg_type(th) is bool:
subparser.add_argument(f'--{opt}', action='store_true')
else:
if _is_optional_type(th):
if _is_literal_type(th):
subparser.add_argument(f"--{opt}",
choices=list(_get_literal_values(th)),
default=None)
subparser.add_argument(
f'--{opt}',
choices=list(_get_literal_values(th)),
default=None,
)
else:
subparser.add_argument(f"--{opt}",
type=_get_arg_type(th), default=None)
subparser.add_argument(
f'--{opt}',
type=_get_arg_type(th),
default=None,
)
else:
if _is_literal_type(th):
subparser.add_argument(f"--{opt}",
choices=list(_get_literal_values(th)),
required=True)
subparser.add_argument(
f'--{opt}',
choices=list(_get_literal_values(th)),
required=True,
)
else:
subparser.add_argument(f"--{opt}",
type=_get_arg_type(th), required=True)
subparser.add_argument(
f'--{opt}', type=_get_arg_type(th), required=True
)

# Get options as a dict rather than a namespace,
# so that we can modify it and pack for passing to functions
args = vars(parser.parse_args())

if not args["subcommand"]:
print("Subcommand required!")
if not args['subcommand']:
print('Subcommand required!')
parser.print_usage()
sys.exit(1)

function_name = args["subcommand"]
function_name = args['subcommand']
func = functions[function_name]

# Remove the subcommand from the arguments,
# it would cause an extra argument error when we pass the dict to a function
del args["subcommand"]
del args['subcommand']

# Show and generate commands must always get the "raw" argument,
# but other commands (clear/reset/restart/add/delete) should not,
# because they produce no output and it makes no sense for them.
if ("raw" not in args) and _capture_output(function_name):
args["raw"] = False
if ('raw' not in args) and _capture_output(function_name):
args['raw'] = False

if _capture_output(function_name):
# Show and generate commands are slightly special:
# they may return human-formatted output
# or a raw dict that we need to serialize in JSON for printing
res = func(**args)
if not args["raw"]:
if not args['raw']:
return res
else:
if not isinstance(res, dict) and not isinstance(res, list):
raise InternalError(f"Bare literal is not an acceptable raw output, must be a list or an object.\
The output was:{res}")
raise InternalError(
f'Bare literal is not an acceptable raw output, must be a list or an object.\
The output was:{res}'
)
res = decamelize(res)
res = _normalize_field_names(res)
from json import dumps

return dumps(res, indent=4)
else:
# Other functions should not return anything,
Expand Down
Loading

0 comments on commit 5c76607

Please sign in to comment.