/usr/lib/python3/dist-packages/plainbox/impl/clitools.py is in python3-plainbox 0.25-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 | # This file is part of Checkbox.
#
# Copyright 2012-2014 Canonical Ltd.
# Written by:
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty 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 Checkbox. If not, see <http://www.gnu.org/licenses/>.
"""
:mod:`plainbox.impl.clitools` -- support code for command line utilities
========================================================================
.. warning::
THIS MODULE DOES NOT HAVE STABLE PUBLIC API
"""
import abc
import argparse
import errno
import inspect
import logging
import os
import pdb
import sys
from plainbox.i18n import bindtextdomain
from plainbox.i18n import dgettext
from plainbox.i18n import gettext as _
from plainbox.i18n import textdomain
from plainbox.impl._argparse import LegacyHelpFormatter
from plainbox.impl.logging import adjust_logging
from plainbox.impl.secure.plugins import IPlugInCollection
from plainbox.impl.secure.plugins import now
logger = logging.getLogger("plainbox.clitools")
class CommandBase(metaclass=abc.ABCMeta):
"""
Simple interface class for sub-commands of :class:`ToolBase`.
Command objects like this are consumed by `ToolBase` subclasses to
implement hierarchical command system. The API supports arbitrary many sub
commands in arbitrary nesting arrangement.
Subcommands need to be registered inside the :meth:`register_parser()`,
either manually by calling add_parser() on the passed subparsers instance,
or by calling the helper :meth:`add_subcommand()` method. By common
convention each subclass of CommandBase adds exactly one subcommand to the
parser.
"""
@abc.abstractmethod
def invoked(self, ns):
"""
Implement what should happen when the command gets invoked
The ns is the namespace produced by argument parser
"""
@abc.abstractmethod
def register_parser(self, subparsers):
"""
Implement what should happen to register the additional parser for this
command. The subparsers argument is the return value of
ArgumentParser.add_subparsers()
"""
# This method is optional
def register_arguments(self, parser):
"""
Implement to customize which arguments need to be added to a parser.
This method differs from register_parser() in that it allows commands
which implement it to be invoked directly from a tool class (without
being a subcommand that needs to be selected). If implemented it should
be used from within :meth:`register_parser()` to ensure identical
behavior in both cases (subcommand and tool-level command)
"""
raise NotImplementedError("register_arguments() not customized")
def autopager(self):
"""
Enable automatic pager.
This invokes :func:`autopager()` which wraps execution in a pager
program so that long output is not a problem to read. Do not call this
in interactive commands.
"""
autopager()
def get_command_name(self):
"""
Get the name of the command, as seen on command line.
:returns:
self.name, if defined
:returns:
lower-cased class name, with the string "command" stripped out
"""
try:
return self.name
except AttributeError:
name = self.__class__.__name__.lower()
if name.endswith("command"):
name = name.replace("command", "")
return name
def get_localized_docstring(self):
"""
Get a cleaned-up, localized copy of docstring of this class.
"""
if self.__class__.__doc__ is not None:
return inspect.cleandoc(
dgettext(self.get_gettext_domain(), self.__class__.__doc__))
def get_command_help(self):
"""
Get a single-line help string associated with this command, as seen on
command line.
:returns:
self.help, if defined
:returns:
The first line of the docstring of this class, if any
:returns:
None, otherwise
"""
try:
return self.help
except AttributeError:
pass
try:
return self.get_localized_docstring().splitlines()[0]
except (AttributeError, ValueError, IndexError):
pass
def get_command_description(self):
"""
Get a multi-line description string associated with this command, as
seen on command line.
The description is printed after command usage but before argument and
option definitions.
:returns:
self.description, if defined
:returns:
A substring of the class docstring between the first line (which
goes to :meth:`get_command_help()`) and the string ``@EPILOG@``, if
present, or the end of the docstring, if any.
:returns:
None, otherwise
"""
try:
return self.description
except AttributeError:
pass
try:
return '\n'.join(
self.get_localized_docstring().splitlines()[1:]
).split('@EPILOG@', 1)[0].strip()
except (AttributeError, IndexError, ValueError):
pass
def get_command_epilog(self):
"""
Get a multi-line description string associated with this command, as
seen on command line.
The epilog is printed after the definitions of arguments and options
:returns:
self.epilog, if defined
:returns:
A substring of the class docstring between the string ``@EPILOG``
and the end of the docstring, if defined
:returns:
None, otherwise
"""
try:
return self.epilog
except AttributeError:
pass
try:
return '\n'.join(
self.get_localized_docstring().splitlines()[1:]
).split('@EPILOG@', 1)[1].strip()
except (AttributeError, IndexError, ValueError):
pass
def get_gettext_domain(self):
"""
Get the gettext translation domain associated with this command.
The domain will be used to translate the description, epilog and help
string, as obtained by their respective methods.
:returns:
self.gettext_domain, if defined
:returns:
None, otherwise. Note that it will cause the string to be
translated with the globally configured domain.
"""
try:
return self.gettext_domain
except AttributeError:
pass
def add_subcommand(self, subparsers):
"""
Add a parser to the specified subparsers instance.
:returns:
The new parser for the added subcommand
This command works by convention, depending on
:meth:`get_command_name(), :meth:`get_command_help()`,
:meth:`get_command_description()` and :meth:`get_command_epilog()`.
"""
help = self.get_command_help()
description = self.get_command_description()
epilog = self.get_command_epilog()
name = self.get_command_name()
parser = subparsers.add_parser(
name, help=help, description=description, epilog=epilog,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.set_defaults(command=self)
return parser
class ToolBase(metaclass=abc.ABCMeta):
"""
Base class for implementing programs with hierarchical subcommands
The tools support a variety of sub-commands, logging and debugging support.
If argcomplete module is available and used properly in the shell then
advanced tab-completion is also available.
There are three methods to implement for a basic tool. Those are:
1. :meth:`get_exec_name()` -- to know how the tool will be called
2. :meth:`get_exec_version()` -- to know how the version of the tool
3. :meth:`add_subcommands()` -- to add some actual commands to execute
This class has some complex control flow to support important and
interesting use cases. It is important to know that input is parsed with
two parsers, the early parser and the full parser. The early parser
quickly checks for a fraction of supported arguments and uses that data to
initialize environment before construction of a full parser is possible.
The full parser sees the reminder of the input and does not re-parse things
that where already handled.
"""
_RELEASELEVEL_TO_TOKEN = {
"alpha": "a",
"beta": "b",
"candidate": "c",
}
def __init__(self):
"""
Initialize all the variables, real stuff happens in main()
"""
self._setup_logging_from_environment()
self._early_parser = None # set in _early_init()
self._parser = None # set in main()
logger.debug(_("Constructed %r"), self)
def _setup_logging_from_environment(self):
if not os.getenv("PLAINBOX_DEBUG", ""):
return
adjust_logging(
level=os.getenv("PLAINBOX_LOG_LEVEL", "DEBUG"),
trace_list=os.getenv("PLAINBOX_TRACE", "").split(","),
debug_console=os.getenv("PLAINBOX_DEBUG", "") == "console")
logger.debug(_("Activated early logging via environment variables"))
def main(self, argv=None):
"""
Run as if invoked from command line directly
"""
# Another try/catch block for catching KeyboardInterrupt
# This one is really only meant for the early init abort
# (when someone runs main but bails out before we really
# get to the point when we do something useful and setup
# all the exception handlers).
try:
logger.debug(_("Tool initialization (early mode)"))
self.early_init()
logger.debug(_("Parsing command line arguments (early mode)"))
early_ns = self._early_parser.parse_args(argv)
logger.debug(
_("Command line parsed to (early mode): %r"), early_ns)
logger.debug(_("Tool initialization (late mode)"))
self.late_init(early_ns)
# Construct the full command line argument parser
logger.debug(_("Parser construction"))
self._parser = self.construct_parser(early_ns)
# parse the full command line arguments, this is also where we
# do argcomplete-dictated exit if bash shell completion
# is requested
logger.debug(_("Parsing command line arguments"))
ns = self._parser.parse_args(argv)
logger.debug(_("Command line parsed to: %r"), ns)
logger.debug(_("Tool initialization (final steps)"))
self.final_init(ns)
logger.debug(_("Tool initialization complete"))
except KeyboardInterrupt:
pass
else:
logger.debug(_("Dispatching command..."))
return self.dispatch_and_catch_exceptions(ns)
@classmethod
def format_version_tuple(cls, version_tuple):
major, minor, micro, releaselevel, serial = version_tuple
version = "%s.%s" % (major, minor)
if micro != 0:
version += ".%s" % micro
token = cls._RELEASELEVEL_TO_TOKEN.get(releaselevel)
if token:
version += "%s%d" % (token, serial)
if releaselevel == "dev":
version += ".dev"
return version
@classmethod
@abc.abstractmethod
def get_exec_name(cls):
"""
Get the name of this executable
"""
@classmethod
@abc.abstractmethod
def get_exec_version(cls):
"""
Get the version reported by this executable
"""
@abc.abstractmethod
def add_subcommands(self, subparsers, early_ns):
"""
Add top-level subcommands to the argument parser.
:param subparsers:
The argparse subparsers object. Use it to register additional
command line syntax parsers and to add your commands there.
:param early_ns:
A namespace from parsing by the special early parser. The early
parser may be used to quickly guess the command that needs to be
loaded, despite not really being able to parse everything the full
parser can. Using this as a hint one can optimize the command
loading process to skip loading commands that would not be
executed.
This can be overridden by subclasses to use a different set of
top-level subcommands.
"""
def early_init(self):
"""
Do very early initialization. This is where we initialize stuff even
without seeing a shred of command line data or anything else.
"""
self.setup_i18n()
self._early_parser = self.construct_early_parser()
def setup_i18n(self):
"""
Setup i18n and l10n system.
"""
domain = self.get_gettext_domain()
if domain is not None:
textdomain(domain)
bindtextdomain(domain, self.get_locale_dir())
def get_gettext_domain(self):
"""
Get the name of the gettext domain that should be used by this tool.
The value returned will be used to select translations to
global calls to gettext() and ngettext() everywhere in
python.
"""
return None
def get_locale_dir(self):
"""
Get the path of the gettext translation catalogs for this tool.
This value is used to bind the domain returned by
:meth:`get_gettext_domain()` to a specific directory. By default None
is returned, which means that standard, system-wide locations are used.
"""
return None
def late_init(self, early_ns):
"""
Initialize with early command line arguments being already parsed
"""
adjust_logging(
level=early_ns.log_level, trace_list=early_ns.trace,
debug_console=early_ns.debug_console)
def final_init(self, ns):
"""
Do some final initialization just before the command gets
dispatched. This is empty here but maybe useful for subclasses.
"""
def construct_early_parser(self):
"""
Create a parser that captures some of the early data we need to
be able to have a real parser and initialize the rest.
"""
parser = argparse.ArgumentParser(add_help=False)
# Fake --help and --version
parser.add_argument("-h", "--help", action="store_const", const=None)
parser.add_argument("--version", action="store_const", const=None)
self.add_early_parser_arguments(parser)
# A catch-all net for everything else
parser.add_argument("rest", nargs="...")
return parser
def create_parser_object(self):
"""
Construct a bare parser object.
This method is responsible for creating the main parser object and
adding --version and other basic top-level properties to it (but not
any of the commands).
It exists as a separate method in case some special customization is
required, so that subclasses can still use standard version of
:meth:`construct_parser()`.
:returns:
argparse.ArgumentParser instance.
"""
parser = argparse.ArgumentParser(
prog=self.get_exec_name(),
formatter_class=LegacyHelpFormatter)
# NOTE: help= is provided explicitly as argparse doesn't wrap
# everything with _() correctly (depending on version)
parser.add_argument(
"--version", action="version", version=self.get_exec_version(),
help=_("show program's version number and exit"))
return parser
def construct_parser(self, early_ns=None):
parser = self.create_parser_object()
# Add all the things really parsed by the early parser so that it
# shows up in --help and bash tab completion.
self.add_early_parser_arguments(parser)
subparsers = parser.add_subparsers()
self.add_subcommands(subparsers, early_ns)
self.enable_argcomplete_if_possible(parser)
return parser
def enable_argcomplete_if_possible(self, parser):
# Enable argcomplete if it is available.
try:
import argcomplete
except ImportError:
pass
else:
argcomplete.autocomplete(parser)
def add_early_parser_arguments(self, parser):
group = parser.add_argument_group(
title=_("logging and debugging"))
# Add the --log-level argument
group.add_argument(
"-l", "--log-level",
action="store",
choices=('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'),
default=None,
help=argparse.SUPPRESS)
# Add the --verbose argument
group.add_argument(
"-v", "--verbose",
dest="log_level",
action="store_const",
const="INFO",
# TRANSLATORS: please keep --log-level=INFO untranslated
help=_("be more verbose (same as --log-level=INFO)"))
# Add the --debug flag
group.add_argument(
"-D", "--debug",
dest="log_level",
action="store_const",
const="DEBUG",
# TRANSLATORS: please keep DEBUG untranslated
help=_("enable DEBUG messages on the root logger"))
# Add the --debug flag
group.add_argument(
"-C", "--debug-console",
action="store_true",
# TRANSLATORS: please keep DEBUG untranslated
help=_("display DEBUG messages in the console"))
# Add the --trace flag
group.add_argument(
"-T", "--trace",
metavar=_("LOGGER"),
action="append",
default=[],
# TRANSLATORS: please keep DEBUG untranslated
help=_("enable DEBUG messages on the specified logger "
"(can be used multiple times)"))
# Add the --pdb flag
group.add_argument(
"-P", "--pdb",
action="store_true",
default=False,
# TRANSLATORS: please keep pdb untranslated
help=_("jump into pdb (python debugger) when a command crashes"))
# Add the --debug-interrupt flag
group.add_argument(
"-I", "--debug-interrupt",
action="store_true",
default=False,
# TRANSLATORS: please keep SIGINT/KeyboardInterrupt and --pdb
# untranslated
help=_("crash on SIGINT/KeyboardInterrupt, useful with --pdb"))
def dispatch_command(self, ns):
# Argh the horrror!
#
# Since CPython revision cab204a79e09 (landed for python3.3)
# http://hg.python.org/cpython/diff/cab204a79e09/Lib/argparse.py
# the argparse module behaves differently than it did in python3.2
#
# In practical terms subparsers are now optional in 3.3 so all of the
# commands are no longer required parameters.
#
# To compensate, on python3.3 and beyond, when the user just runs
# plainbox without specifying the command, we manually, explicitly do
# what python3.2 did: call parser.error(_('too few arguments'))
if (sys.version_info[:2] >= (3, 3)
and getattr(ns, "command", None) is None):
self._parser.error(argparse._("too few arguments"))
else:
return ns.command.invoked(ns)
def dispatch_and_catch_exceptions(self, ns):
try:
return self.dispatch_command(ns)
except SystemExit:
# Don't let SystemExit be caught in the logic below, we really
# just want to exit when that gets thrown.
# TRANSLATORS: please keep SystemExit untranslated
logger.debug(_("caught SystemExit, exiting"))
# We may want to raise SystemExit as it can carry a status code
# along and we cannot just consume that.
raise
except BaseException as exc:
logger.debug(_("caught %r, deciding on what to do next"), exc)
# For all other exceptions (and I mean all), do a few checks
# and perform actions depending on the command line arguments
# By default we want to re-raise the exception
action = 'raise'
# We want to ignore IOErrors that are really EPIPE
if isinstance(exc, IOError):
if exc.errno == errno.EPIPE:
action = 'ignore'
# We want to ignore KeyboardInterrupt unless --debug-interrupt
# was passed on command line
elif isinstance(exc, KeyboardInterrupt):
if ns.debug_interrupt:
action = 'debug'
else:
action = 'ignore'
else:
# For all other execptions, debug if requested
if ns.pdb:
action = 'debug'
logger.debug(_("action for exception %r is %s"), exc, action)
if action == 'ignore':
return 0
elif action == 'raise':
logging.getLogger("plainbox.crashes").fatal(
_("Executable %r invoked with %r has crashed"),
self.get_exec_name(), ns, exc_info=1)
raise
elif action == 'debug':
logger.error(_("caught runaway exception: %r"), exc)
logger.error(_("starting debugger..."))
pdb.post_mortem()
return 1
class LazyLoadingToolMixIn(metaclass=abc.ABCMeta):
"""
Mix-in class for ToolBase that improves responsiveness by loading
subcommands lazily on demand and using some heuristic that works well in
the common case of running one command.
Unlike the original, this implementation uses a custom version of
add_subcommands() which uses the ``early_ns`` argument as a hint to not
load or register commands that are not going to be needed.
In practice ``tool --help`` doesn't benefit much but ``tool <cmd>`` can now
be much, much faster (and more responsive) as it only loads that one
command.
Concrete subclasses must implement the :meth:`get_command_collection()`
method which must return a IPlugInCollection (ideally the
LazyPlugInCollection that contains extra optimizations for low-cost key
enumeration and one-at-a-time value loading).
"""
@abc.abstractmethod
def get_command_collection(self) -> IPlugInCollection:
"""
Get a (lazy) collection of all subcommands.
This method returns a IPlugInCollection that maps command name to
CommandBase subclass, such as :class:`PlainBoxCommand`.
The name of each plug in object **must** match the command name.
"""
def add_subcommands(
self,
subparsers: argparse._SubParsersAction,
early_ns: "Maybe[argparse.Namespace]"=None,
) -> None:
"""
Add top-level subcommands to the argument parser.
:param subparsers:
A part of argparse that can be used to create additional parsers
for specific subcommands.
:param early_ns:
(optional) An argparse namespace from earlier parsing. If it is not
None, it must have the ``rest`` attribute which is used as a list
of hints.
.. note::
This method is customized by LazyLoadingToolMixIn and should not be
overriden directly. To register your commands use
:meth:`get_command_collection()`
"""
if early_ns is not None:
self.add_subcommands_with_hints(subparsers, early_ns.rest)
else:
self.add_subcommands_without_hints(
subparsers, self.get_command_collection())
def add_subcommands_with_hints(
self, subparsers: argparse._SubParsersAction,
hint_list: "List[str]"
) -> None:
"""
Add top-level subcommands to the argument parser, using a list of
hints.
:param subparsers:
A part of argparse that can be used to create additional parsers
for specific subcommands.
:param hint_list:
A list of strings that should be used as hints.
This method tries to optimize the time needed to register and setup all
of the subcommands by looking at a list of hints in search for the
(likely) command that will be executed.
Things that look like options are ignored. The first element of
``hint_list`` that matches a known command name, as provided by
meth:`get_command_collection()`, is used as a sign that that command
will be executed and all other commands don't have to be loaded or
initialized. If no hints are found (e.g. when running ``tool --help``)
the slower fallback mode is used and all subcommands are added.
.. note::
This method is customized by LazyLoadingToolMixIn and should not be
overriden directly. To register your commands use
:meth:`get_command_collection()`
"""
logger.debug(
_("Trying to load exactly the right command: %r"), hint_list)
command_collection = self.get_command_collection()
for hint in hint_list:
# Skip all the things that look like additional options
if hint.startswith('-'):
continue
# Break on the first hint that we can load
try:
plugin = command_collection.get_by_name(hint)
except KeyError:
continue
else:
command = plugin.plugin_object
logger.debug("Registering single command %r", command)
start = now()
command.register_parser(subparsers)
logger.debug(_("Cost of registering guessed command: %f"),
now() - start)
break
else:
logger.debug("Falling back to loading all commands")
self.add_subcommands_without_hints(subparsers, command_collection)
def add_subcommands_without_hints(
self, subparsers: argparse._SubParsersAction,
command_collection: IPlugInCollection,
) -> None:
"""
Add top-level subcommands to the argument parser (fallback mode)
:param subparsers:
A part of argparse that can be used to create additional parsers
for specific subcommands.
:param command_collection:
A collection of commands that was obtaioned from
:meth:`get_command_collection()` earlier.
This method is called when hint-based optimization cannot be used and
all commands need to be loaded and initialized.
.. note::
This method is customized by LazyLoadingToolMixIn and should not be
overriden directly. To register your commands use
:meth:`get_command_collection()`
"""
command_collection.load()
logger.debug(
_("Cost of loading all top-level commands: %f"),
command_collection.get_total_time())
start = now()
for command in command_collection.get_all_plugin_objects():
logger.debug("Registering command %r", command)
command.register_parser(subparsers)
logger.debug(
_("Cost of registering all top-level commands: %f"),
now() - start)
class SingleCommandToolMixIn:
"""
Mix-in class for ToolBase to implement single-command dispatch.
This effectively turns the tool into a single-command tool. The only method
that needs to be implemented is the get_command() method.
"""
@abc.abstractmethod
def get_command(self):
"""
Get the command to register
The return value must be a CommandBase instance that implements the
:meth:`CommandBase.register_arguments()` method.
"""
def add_subcommands(self, subparsers, early_ns):
"""
Overridden version of add_subcommands()
This method does nothing. It is here because ToolBase requires it.
"""
def construct_parser(self, early_ns=None):
"""
Overridden version of construct_parser()
This method sets the single subcommand as default. This allows the
whole tool to be started without arguments and do the right thing while
still supporting optional sub-commands and true (and rich) built-in
help.
"""
parser = self.create_parser_object()
# Add all the things really parsed by the early parser so that it
# shows up in --help and bash tab completion.
self.add_early_parser_arguments(parser)
# Customize parser with command details
self.customize_parser(parser)
# Enable argcomplete if it is available.
self.enable_argcomplete_if_possible(parser)
return parser
def customize_parser(self, parser):
# Instantiate the command to use
cmd = self.get_command()
# Set top-level parser description and epilog
parser.epilog = cmd.get_command_epilog()
parser.description = cmd.get_command_description()
# Directly register the command
cmd.register_arguments(parser)
def autopager(pager_list=['sensible-pager', 'less', 'more']):
"""
Enable automatic pager
:param pager_list:
List of pager programs to try.
:returns:
Nothing immedaitely if auto-pagerification cannot be turned on.
This is true when running on windows or when sys.stdout is not
a tty.
This function executes the following steps:
* A pager is selected
* A pipe is created
* The current process forks
* The parent uses execlp() and becomes the pager
* The child/python carries on the execution of python code.
* The parent/pager stdin is connected to the childs stdout.
* The child/python stderr is connected to parent/pager stdin only when
sys.stderr is connected to a tty
.. note::
Pager selection is influenced by the pager environment variable. if set
it will be prepended to the pager_list. This makes the expected
behavior of allowing users to customize their environment work okay.
.. warning::
This function must not be used for interactive commands. Doing so
will prevent users from feeding any input to plainbox as all input
will be "stolen" by the pager process.
"""
# If stdout is not connected to a tty or when running on win32, just return
if not sys.stdout.isatty() or sys.platform == "win32":
return
# Check if the user has a PAGER set, if so, consider that the prime
# candidate for the effective pager.
pager = os.getenv('PAGER')
if pager is not None:
pager_list = [pager] + pager_list
# Find the best pager based on user preferences and built-in knowledge
try:
pager_name, pager_pathname = find_exec(pager_list)
except LookupError:
# If none of the pagers are installed, just return
return
# Flush any pending output
sys.stdout.flush()
sys.stderr.flush()
# Create a pipe that we'll use to glue ourselves to the pager
read_end, write_end = os.pipe()
# Fork so that we can have a pager process
if os.fork() == 0:
# NOTE: this is where plainbox will run
# Rewire stdout and stderr (if a tty) to the pipe
os.dup2(write_end, sys.stdout.fileno())
if sys.stderr.isatty():
os.dup2(write_end, sys.stderr.fileno())
# Close the unused end of the pipe
os.close(read_end)
else:
# NOTE: this is where the pager will run
# Rewire stdin to the pipe
os.dup2(read_end, sys.stdin.fileno())
# Close the unused end of the pipe
os.close(write_end)
# Execute the pager
os.execl(pager_pathname, pager_name)
def find_exec(name_list):
"""
Find the first executable from name_list in PATH
:param name_list:
List of names of executable programs to look for, in the order
of preference. Only basenames should be passed here (not absolute
pathnames)
:returns:
Tuple (name, pathname), if the executable can be found
:raises:
LookupError if none of the names in name_list are executable
programs in PATH
"""
path_list = os.get_exec_path()
for name in name_list:
for path in path_list:
pathname = os.path.join(path, name)
if os.access(pathname, os.X_OK):
return (name, pathname)
raise LookupError(
_("Unable to find any of the executables {}").format(
", ".join(name_list)))
|