mirror of
https://github.com/certbot/certbot.git
synced 2026-06-07 07:42:08 -04:00
af1c66b28f
This PR contains the changes requested in initial pre-review comments of #7308 Move properties to class pydocs in interfaces.py Prefer class ABC register() functionality instead of class inheritance for interface classes Add apache implementation specific functions to interfaces * Move class argument definitions to class pydoc * Add apache specific functionality to the interface * Bring inheritance back * Define initialization for different ParserNode classes * Add parsernode utils to check keyword arguments and document the defaults in pydoc * Fix pydocs and make BlockNode a child of DirectiveNode * Refine docs, and remove unused __init__ from BlockNode * Split parsernode util tests to their own respective file * Skip cover for dummy calls to super * Add types to method documentation * Add documentation for children
85 lines
3 KiB
Python
85 lines
3 KiB
Python
"""ParserNode utils"""
|
|
|
|
|
|
def validate_kwargs(kwargs, required_names):
|
|
"""
|
|
Ensures that the kwargs dict has all the expected values. This function modifies
|
|
the kwargs dictionary, and hence the returned dictionary should be used instead
|
|
in the caller function instead of the original kwargs.
|
|
|
|
:param dict kwargs: Dictionary of keyword arguments to validate.
|
|
:param list required_names: List of required parameter names.
|
|
"""
|
|
|
|
validated_kwargs = dict()
|
|
for name in required_names:
|
|
try:
|
|
validated_kwargs[name] = kwargs.pop(name)
|
|
except KeyError:
|
|
raise TypeError("Required keyword argument: {} undefined.".format(name))
|
|
|
|
# Raise exception if unknown key word arguments are found.
|
|
if kwargs:
|
|
unknown = ", ".join(kwargs.keys())
|
|
raise TypeError("Unknown keyword argument(s): {}".format(unknown))
|
|
return validated_kwargs
|
|
|
|
|
|
def parsernode_kwargs(kwargs):
|
|
"""
|
|
Validates keyword arguments for ParserNode. This function modifies the kwargs
|
|
dictionary, and hence the returned dictionary should be used instead in the
|
|
caller function instead of the original kwargs.
|
|
|
|
|
|
:param dict kwargs: Keyword argument dictionary to validate.
|
|
|
|
:returns: Tuple of validated and prepared arguments.
|
|
"""
|
|
kwargs.setdefault("dirty", False)
|
|
kwargs = validate_kwargs(kwargs, ["ancestor", "dirty", "filepath"])
|
|
return kwargs["ancestor"], kwargs["dirty"], kwargs["filepath"]
|
|
|
|
|
|
def commentnode_kwargs(kwargs):
|
|
"""
|
|
Validates keyword arguments for CommentNode and sets the default values for
|
|
optional kwargs. This function modifies the kwargs dictionary, and hence the
|
|
returned dictionary should be used instead in the caller function instead of
|
|
the original kwargs.
|
|
|
|
|
|
:param dict kwargs: Keyword argument dictionary to validate.
|
|
|
|
:returns: Tuple of validated and prepared arguments and ParserNode kwargs.
|
|
"""
|
|
kwargs.setdefault("dirty", False)
|
|
kwargs = validate_kwargs(kwargs, ["ancestor", "dirty", "filepath", "comment"])
|
|
|
|
comment = kwargs.pop("comment")
|
|
return comment, kwargs
|
|
|
|
|
|
def directivenode_kwargs(kwargs):
|
|
"""
|
|
Validates keyword arguments for DirectiveNode and BlockNode and sets the
|
|
default values for optional kwargs. This function modifies the kwargs
|
|
dictionary, and hence the returned dictionary should be used instead in the
|
|
caller function instead of the original kwargs.
|
|
|
|
:param dict kwargs: Keyword argument dictionary to validate.
|
|
|
|
:returns: Tuple of validated and prepared arguments and ParserNode kwargs.
|
|
"""
|
|
|
|
kwargs.setdefault("dirty", False)
|
|
kwargs.setdefault("enabled", True)
|
|
kwargs.setdefault("parameters", ())
|
|
|
|
kwargs = validate_kwargs(kwargs, ["ancestor", "dirty", "filepath", "name",
|
|
"parameters", "enabled"])
|
|
|
|
name = kwargs.pop("name")
|
|
parameters = kwargs.pop("parameters")
|
|
enabled = kwargs.pop("enabled")
|
|
return name, parameters, enabled, kwargs
|