Coverage for pykickstart/options.py: 19%

# Coverage for pykickstart/options.py : 19%

## 139 statements 27 run 112 missing 0 excluded

Hot-keys on this page

r m x p toggle line displays

j k next/prev highlighted chunk

0 (zero) top of page

1 (one) first highlighted chunk

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | # # Chris Lumens <clumens@redhat.com> # # Copyright 2005-2016 Red Hat, Inc. # # This copyrighted material is made available to anyone wishing to use, modify, # copy, or redistribute it subject to the terms and conditions of the GNU # General Public License v.2. This program is distributed in the hope that it # will be useful, but WITHOUT ANY WARRANTY expressed or implied, including the # implied warranties of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. # See the GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Any Red Hat # trademarks that are incorporated in the source code or documentation are not # subject to the GNU General Public License and may only be used or replicated # with the express permission of Red Hat, Inc. # """ Specialized option handling. This module exports three classes: ExtendAction - A subclass of Action that appends a list of values to an already existing list. In this way, it's like the existing "append" action except for lists instead of single values. ExtendConstAction - A subclass of Action that appends a list of constants to an already existing list. In this way, it's like the existing "append_const" action except for lists instead of single values. KSOptionParser - A specialized subclass of ArgumentParser to be used in BaseHandler subclasses. And it exports two functions: commaSplit - A function to be used as the type= argument to any arguments that take a single string that may be split on commas, resulting in a list of strings. ksboolean - A function to be used as the type= argument to any arguments that can take a boolean. """ import warnings import textwrap from argparse import RawTextHelpFormatter, SUPPRESS from argparse import Action, ArgumentParser, ArgumentTypeError from pykickstart.errors import KickstartParseError from pykickstart.version import versionToString, versionToLongString from pykickstart.i18n import _ def commaSplit(value): return list(filter(None, [v.strip() for v in value.split(',')])) def ksboolean(value): try: if value.lower() in ("on", "yes", "true", "1"): return True elif value.lower() in ("off", "no", "false", "0"): return False else: raise ArgumentTypeError(_("invalid boolean value: %r") % value) except AttributeError: raise ArgumentTypeError(_("invalid boolean value: %r") % value) class KSHelpFormatter(RawTextHelpFormatter): """ Used in generating documentation """ def _format_usage(self, usage, actions, groups, prefix): return "::\n\n %s" % super(KSHelpFormatter, self)._format_usage(usage, actions, groups, "").strip() def _format_action(self, action): text = super(KSHelpFormatter, self)._format_action(action) parts = text.strip().split('\n') new_parts = [] new_parts.append("\n``%s``\n" % parts[0].strip()) for p in parts[1:]: if p: new_parts.append(" %s" % p.lstrip()) return self._join_parts(new_parts) def _join_parts(self, part_strings): return '\n'.join([part.rstrip(' ') for part in part_strings if part and part is not SUPPRESS]) class ExtendAction(Action): def __call__(self, parser, namespace, values, option_string=None): if getattr(namespace, self.dest, None) is not None: setattr(namespace, self.dest, getattr(namespace, self.dest) + values) else: setattr(namespace, self.dest, values) class ExtendConstAction(Action): def __call__(self, parser, namespace, values, option_string=None): if getattr(namespace, self.dest, None) is not None: setattr(namespace, self.dest, self.const + values) else: setattr(namespace, self.dest, self.const) class KSOptionParser(ArgumentParser): """A specialized subclass of argparse.ArgumentParser to handle extra option attribute checking, work error reporting into the KickstartParseError framework, and to turn off the default help. """ def __init__(self, *args, **kwargs): """Create a new KSOptionParser instance. Each KickstartCommand subclass should create one instance of KSOptionParser, providing at least the lineno attribute. version is not required. Instance attributes: version -- The version of the kickstart syntax we are checking against. """ # Overridden to allow for the version kwargs, to skip help option generation, # and to resolve conflicts instead of override earlier options. int_version = kwargs.pop("version") # fail fast if no version is specified version = versionToLongString(int_version) # always document the version addVersion = kwargs.pop('addVersion', True) # remove leading spaced from description and epilog. # fail fast if we forgot to add description kwargs['description'] = textwrap.dedent(kwargs.pop("description")) if addVersion: kwargs['description'] = "\n.. versionadded:: %s\n%s" % (version, kwargs['description']) kwargs['epilog'] = textwrap.dedent(kwargs.pop("epilog", "")) # fail fast if we forgot to add prog kwargs['prog'] = kwargs.pop("prog") # remove leading spaced from description and epilog. # fail fast if we forgot to add description kwargs['description'] = textwrap.dedent(kwargs.pop("description")) kwargs['epilog'] = textwrap.dedent(kwargs.pop("epilog", "")) # fail fast if we forgot to add prog kwargs['prog'] = kwargs.pop("prog") ArgumentParser.__init__(self, add_help=False, conflict_handler="resolve", formatter_class=KSHelpFormatter, *args, **kwargs) # NOTE: On Python 2.7 ArgumentParser has a deprecated version parameter # which always defaults to self.version = None which breaks deprecation # warnings in pykickstart. That's why we always set this value after # ArgumentParser.__init__ has been executed self.version = int_version self.lineno = None def _parse_optional(self, arg_string): def usedTooNew(action): return action.introduced and action.introduced > self.version def usedRemoved(action): return action.removed and action.removed <= self.version option_tuple = ArgumentParser._parse_optional(self, arg_string) if option_tuple is None or option_tuple[0] is None: return option_tuple action = option_tuple[0] if usedTooNew(action): mapping = {"option": action.option_strings[0], "intro": versionToString(action.introduced), "version": versionToString(self.version)} self.error(_("The %(option)s option was introduced in version %(intro)s, but you are using kickstart syntax version %(version)s.") % mapping) elif usedRemoved(action): mapping = {"option": action.option_strings[0], "removed": versionToString(action.removed), "version": versionToString(self.version)} if action.removed == self.version: self.error(_("The %(option)s option is no longer supported.") % mapping) else: self.error(_("The %(option)s option was removed in version %(removed)s, but you are using kickstart syntax version %(version)s.") % mapping) elif action.deprecated is True or (self.version and type(action.deprecated) == int and self.version >= action.deprecated): mapping = {"lineno": self.lineno, "option": action.option_strings[0]} warnings.warn(_("Ignoring deprecated option on line %(lineno)s: The %(option)s option has been deprecated and no longer has any effect. It may be removed from future releases, which will result in a fatal error from kickstart. Please modify your kickstart file to remove this option.") % mapping, DeprecationWarning) return option_tuple def add_argument(self, *args, **kwargs): introduced = kwargs.pop("introduced", None) deprecated = kwargs.pop("deprecated", False) if deprecated: version = versionToLongString(deprecated) else: # fail fast if version is missing version = versionToLongString(introduced or kwargs.pop("version")) candidate = None for action in self._actions: for arg in args: if arg in action.option_strings: candidate = action break if candidate: if deprecated: _help = candidate.help or "" _help += "\n\n .. deprecated:: %s" % version kwargs["help"] = _help else: # this is a modified argument, which is already present _help = candidate.help or "" _help += "\n\n .. versionchanged:: %s\n\n%s" % (version, kwargs.pop("help")) kwargs["help"] = _help else: # this is a new argument which is added for the first time _help = kwargs.pop("help") _help += "\n\n .. versionadded:: %s" % version # there are some argumets which are deprecated on first declaration if deprecated: _help += "\n\n .. deprecated:: %s" % version kwargs["help"] = _help notest = kwargs.pop("notest", False) removed = kwargs.pop("removed", None) action = ArgumentParser.add_argument(self, *args, **kwargs) action.deprecated = deprecated action.introduced = introduced action.notest = notest action.removed = removed return action def remove_argument(self, arg, **kwargs): candidate = None for action in self._actions: if arg in action.option_strings: candidate = action break if candidate: if not candidate.help: candidate.help = "" candidate.help += "\n\n .. versionremoved:: %s" % versionToLongString(kwargs.pop("version")) self._remove_action(candidate) self._option_string_actions.pop(arg) def error(self, message): # Overridden to turn errors into KickstartParseErrors. if self.lineno is not None: raise KickstartParseError(message, lineno=self.lineno) else: raise KickstartParseError(message) def exit(self, status=0, message=None): # Overridden because this is a library, and libraries shouldn't just # exit. That's what raising exceptions is for. pass def parse_args(self, *args, **kwargs): # pylint: disable=arguments-differ if "lineno" in kwargs: self.lineno = kwargs.pop("lineno") return ArgumentParser.parse_args(self, *args, **kwargs) def parse_known_args(self, *args, **kwargs): # pylint: disable=arguments-differ if "lineno" in kwargs: self.lineno = kwargs.pop("lineno") return ArgumentParser.parse_known_args(self, *args, **kwargs)