Ñò
Ã#xPc
@ sš d Z d d k Z d d k Z d d k Z d d k l Z d d k l Z d d k l Z d d k l Z d e
f d „ ƒ YZ d e f d
„ ƒ YZ
d S( s A common framework for command-line admin tools, e.g. install scripts
Handles common operations like option parsing and logging
iÿÿÿÿN( t OptionGroup( t version( t config( t ipa_log_managert ScriptErrorc B s& e Z d Z d d d „ Z d „ Z RS( sB An exception that records an error message and a return value
t i c C s- | d j o
d } n | | _ | | _ d S( NR ( t Nonet msgt rval( t selfR R ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyt __init__& s
c C s | i S( N( R ( R ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyt __str__, s ( t __name__t
__module__t __doc__R
R ( ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyR # s t AdminToolc B sË e Z d Z d Z d Z e Z d Z e ƒ Z
e d „ ƒ Z e d „ ƒ Z
e d „ ƒ Z e d „ ƒ Z e d „ ƒ Z d „ Z d „ Z d „ Z d „ Z d
„ Z d „ Z d „ Z d
„ Z d „ Z RS( sY Base class for command-line admin tools
To run the tool, call the main() classmethod with a list of command-line
arguments.
Alternatively, call run_cli() to run with command-line arguments in
sys.argv, and call sys.exit() with the return value.
Some commands actually represent multiple related tools, e.g.
``ipa-server-install`` and ``ipa-server-install --uninstall`` would be
represented by separate classes. Only their options are the same.
To handle this, AdminTool provides classmethods for option parsing
and selecting the appropriate command class.
A class-wide option parser is made by calling add_options.
The options are then parsed into options and arguments, and
get_command_class is called with those to retrieve the class.
That class is then instantiated and run.
Running consists of a few steps:
- validating options or the environment (validate_options)
- setting up logging (setup_logging)
- running the actual command (run)
Any unhandled exceptions are handled in handle_error.
And at the end, either log_success or log_failure is called.
Class attributes to define in subclasses:
command_name - shown in logs
log_file_name - if None, logging is to stderr only
needs_root - if true, non-root users can't run the tool
usage - text shown in help
c C sD t i d t i d | i d t i ƒ ƒ } | | _ | i | ƒ d S( sA Create an option parser shared across all instances of this classR t usaget formatterN( R t IPAOptionParserR t VERSIONR t IPAFormattert
option_parsert add_options( t clst parser( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyt make_parserY s c C s, | i d d d d d t d d d d ƒd
S( s1 Add command-specific options to the option parsers -ds --debugt destt debugt defaultt actiont
store_truet helps print debugging informationN( t
add_optiont False( R R ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyR a s c C s t i | i t i ƒ ƒ d S( sK Run this command with sys.argv, exit process with the return value
N( t syst exitt maint argv( R ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyt run_clig s c C su | | i j o | i ƒ | i | i | R t dictR' t classmethodR R R& R$ R) R
R* R1 R2 R3 R7 R4 R8 R9 ( ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyR 0 s( !
( R R" R? R< t optparseR t ipapythonR R R t
StandardErrorR t objectR ( ( ( s7 /usr/lib/python2.6/site-packages/ipapython/admintool.pyt s