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
|
# Copyright(c) 2009, Gentoo Foundation
#
# Copyright 2010 Brian Dolbec <brian.dolbec@gmail.com>
# Copyright(c) 2010, Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
#
# $Header: $
"""Analyse Base Module class to hold common module operation functions
"""
from __future__ import print_function
__docformat__ = 'epytext'
import errno
import sys
import time
from getopt import gnu_getopt, GetoptError
from portage import os
import gentoolkit.pprinter as pp
from gentoolkit.formatters import format_options
from gentoolkit.base import mod_usage
class ModuleBase(object):
"""Analyse base module class to parse module options print module help, etc.."""
def __init__(self):
self.module_name = None
self.options = {}
self.formatted_options = None
self.short_opts = None
self.long_opts = None
self.module_opts = {}
self.warning = None
self.need_queries = True
def print_help(self, with_description=True):
"""Print description, usage and a detailed help message.
@type with_description: bool
@param with_description: if true, print module's __doc__ string
"""
if with_description:
print()
print(__doc__.strip())
print()
if self.warning:
print()
for line in self.warning:
sys.stderr.write(pp.warn(line))
print()
print(mod_usage(mod_name=self.module_name, arg=self.arg_spec, optional=self.arg_option))
print()
print(pp.command("options"))
print(format_options( self.formatted_options ))
if self.formatted_args:
print()
print(pp.command(self.arg_spec))
print(format_options(self.formatted_args))
print()
def parse_module_options(self, module_opts):
"""Parse module options and update self.options"""
opts = (x[0] for x in module_opts)
posargs = (x[1] for x in module_opts)
for opt, posarg in zip(opts, posargs):
if opt in ('-h', '--help'):
self.print_help()
sys.exit(0)
opt_name, opt_type, opt_setting = self.module_opts[opt]
if opt_type == 'boolean':
self.options[opt_name] = opt_setting
elif opt_type == 'int':
if posarg.isdigit():
val = int(posarg)
else:
print()
err = "Module option %s requires integer (got '%s')"
sys.stdout.write(pp.error(err % (opt,posarg)))
print()
self.print_help(with_description=False)
sys.exit(2)
self.options[opt_name] = val
if self.options['quiet']:
self.options['verbose'] = False
def validate_query(self, query, depth=0):
"""check that the query meets the modules TargetSpec
If not it attempts to reduce it to a valid TargetSpec
or prints the help message and exits
"""
if depth > 1:
return []
if len(query) > 1:
query = list(set(self.arg_options).intersection(query))
#print "reduced query =", query
query = self.validate_query(query, depth+1)
if isinstance(query, list):
query = query[0]
if query not in self.arg_options:
print()
print(pp.error(
"Error starting module. Incorrect or No TargetSpec specified!"
))
print("query = ", query)
self.print_help()
sys.exit(2)
return query
def main_setup(self, input_args):
"""Parse input and prepares the program"""
try:
module_opts, queries = gnu_getopt(input_args, self.short_opts, self.long_opts)
except GetoptError as err:
sys.stderr.write(pp.error("Module %s" % err))
print()
self.print_help(with_description=False)
sys.exit(2)
self.parse_module_options(module_opts)
if self.need_queries and not queries:
self.print_help()
sys.exit(2)
return queries
# vim: set ts=4 sw=4 tw=79:
|
GitWeb