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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
#################################################################################
# LAYMAN CONFIGURATION
#################################################################################
# File: argsparser.py
#
# Handles layman command line interface configuration
#
# Copyright:
# (c) 2005 - 2009 Gunnar Wrobel
# (c) 2009 Sebastian Pipping
# (c) 2010 - 2011 Brian Dolbec
# Distributed under the terms of the GNU General Public License v2
#
# Author(s):
# Gunnar Wrobel <wrobel@gentoo.org>
# Sebastian Pipping <sebastian@pipping.org>
# Brian Dolbec <brian.dolbec@gmail.com>
#
'''Defines the configuration options and provides parsing functionality.'''
__version__ = "$Id: config.py 286 2007-01-09 17:48:23Z wrobel $"
#===============================================================================
#
# Dependencies
#
#-------------------------------------------------------------------------------
import sys
from optparse import OptionParser, OptionGroup
from layman.config import BareConfig
from layman.constants import OFF
from layman.version import VERSION
_USAGE = """
layman (-a|-d|-s|-i) (OVERLAY|ALL)
layman -f [-o URL]
layman (-l|-L|-S)"""
class ArgsParser(BareConfig):
'''Handles the configuration and option parser.'''
def __init__(self, args=None, stdout=None, stdin=None, stderr=None):
'''
Creates and describes all possible polymeraZe options and creates
a Message object.
>>> import os.path
>>> here = os.path.dirname(os.path.realpath(__file__))
>>> sys.argv.append('--config')
>>> sys.argv.append(here + '/../etc/layman.cfg')
>>> sys.argv.append('--overlay_defs')
>>> sys.argv.append('')
>>> a = ArgsParser()
>>> a['overlays']
'\\nhttp://www.gentoo.org/proj/en/overlays/repositories.xml'
>>> sorted(a.keys())
['bzr_addopts', 'bzr_command', 'bzr_postsync', 'bzr_syncopts', 'cache', 'config', 'configdir', 'cvs_addopts', 'cvs_command', 'cvs_postsync', 'cvs_syncopts', 'darcs_addopts', 'darcs_command', 'darcs_postsync', 'darcs_syncopts', 'g-common_command', 'g-common_generateopts', 'g-common_postsync', 'g-common_syncopts', 'git_addopts', 'git_command', 'git_postsync', 'git_syncopts', 'installed', 'local_list', 'make_conf', 'mercurial_addopts', 'mercurial_command', 'mercurial_postsync', 'mercurial_syncopts', 'nocheck', 'overlay_defs', 'overlays', 'proxy', 'quietness', 'rsync_command', 'rsync_postsync', 'rsync_syncopts', 'storage', 'svn_addopts', 'svn_command', 'svn_postsync', 'svn_syncopts', 't/f_options', 'tar_command', 'tar_postsync', 'umask', 'width']
'''
BareConfig.__init__(self, stdout=stdout, stderr=stderr, stdin=stdin)
if args == None:
args = sys.argv
# get a couple BareConfig items
self.defaults = self.get_defaults()
self.output = self.get_option('output')
self.parser = OptionParser(
usage = _USAGE,
version = VERSION)
#-----------------------------------------------------------------
# Main Options
group = OptionGroup(self.parser,
'<Actions>')
group.add_option('-a',
'--add',
action = 'append',
help = 'Add the given overlay from the cached remote li'
'st to your locally installed overlays.. Specify "ALL" '
'to add all overlays from the remote list.')
group.add_option('-d',
'--delete',
action = 'append',
help = 'Remove the given overlay from your locally inst'
'alled overlays. Specify "ALL" to remove all overlays')
group.add_option('-s',
'--sync',
action = 'append',
help = 'Update the specified overlay. Use "ALL" as para'
'meter to synchronize all overlays')
group.add_option('-i',
'--info',
action = 'append',
help = 'Display information about the specified overlay'
'.')
group.add_option('-S',
'--sync-all',
action = 'store_true',
help = 'Update all overlays.')
group.add_option('-L',
'--list',
action = 'store_true',
help = 'List the contents of the remote list.')
group.add_option('-l',
'--list-local',
action = 'store_true',
help = 'List the locally installed overlays.')
group.add_option('-f',
'--fetch',
action = 'store_true',
help = 'Fetch a remote list of overlays. This option is'
' deprecated. The fetch operation will be performed by '
'default when you run sync, sync-all, or list.')
group.add_option('-n',
'--nofetch',
action = 'store_true',
help = 'Do not fetch a remote list of overlays.')
group.add_option('-p',
'--priority',
action = 'store',
help = 'Use this with the --add switch to set the prior'
'ity of the added overlay. This will influence the sort'
'ing order of the overlays in the PORTDIR_OVERLAY varia'
'ble.')
self.parser.add_option_group(group)
#-----------------------------------------------------------------
# Additional Options
group = OptionGroup(self.parser,
'<Path options>')
group.add_option('-c',
'--config',
action = 'store',
help = 'Path to the config file [default: ' \
+ self.defaults['config'] + '].')
group.add_option('-O',
'--overlay_defs',
action = 'store',
help = 'Path to aditional overlay.xml files [default: '\
+ self.defaults['overlay_defs'] + '].')
group.add_option('-o',
'--overlays',
action = 'append',
help = 'The list of overlays [default: ' \
+ self.defaults['overlays'] + '].')
self.parser.add_option_group(group)
#-----------------------------------------------------------------
# Output Options
group = OptionGroup(self.parser,
'<Output options>')
group.add_option('-v',
'--verbose',
action = 'store_true',
help = 'Increase the amount of output and describe the '
'overlays.')
group.add_option('-q',
'--quiet',
action = 'store_true',
help = 'Yield no output. Please be careful with this op'
'tion: If the processes spawned by layman when adding o'
'r synchronizing overlays require any input layman will'
' hang without telling you why. This might happen for e'
'xample if your overlay resides in subversion and the S'
'SL certificate of the server needs acceptance.')
group.add_option('-N',
'--nocolor',
action = 'store_true',
help = 'Remove color codes from the layman output.')
group.add_option('-Q',
'--quietness',
action = 'store',
type = 'int',
default = '4',
help = 'Set the level of output (0-4). Default: 4. Once'
' you set this below 2 the same warning as given for --'
'quiet applies! ')
group.add_option('-W',
'--width',
action = 'store',
type = 'int',
default = '0',
help = 'Sets the screen width. This setting is usually '
'not required as layman is capable of detecting the '
'available number of columns automatically.')
group.add_option('-k',
'--nocheck',
action = 'store_true',
help = 'Do not check overlay definitions and do not i'
'ssue a warning if description or contact information'
' are missing.')
group.add_option('--debug-level',
action = 'store',
type = 'int',
help = 'A value between 0 and 10. 0 means no debugging '
'messages will be selected, 10 selects all debugging me'
'ssages. Default is "4".')
self.parser.add_option_group(group)
#-----------------------------------------------------------------
# Debug Options
#self.output.cli_opts(self.parser)
# Parse the command line first since we need to get the config
# file option.
if len(args) == 1:
self.output.notice('Usage:%s' % _USAGE)
sys.exit(0)
(self.options, remain_args) = self.parser.parse_args(args)
# remain_args starts with something like "bin/layman" ...
if len(remain_args) > 1:
self.parser.error("ArgsParser(): Unhandled parameters: %s"
% ', '.join(('"%s"' % e) for e in remain_args[1:]))
# handle debugging
#self.output.cli_handle(self.options)
if (self.options.__dict__.has_key('debug_level') and
self.options.__dict__['debug_level']):
dbglvl = int(self.options.__dict__['debug_level'])
if dbglvl < 0:
dbglvl = 0
if dbglvl > 10:
dbglvl = 10
self.output.set_debug_level(dbglvl)
if self.options.__dict__['nocolor']:
self.output.set_colorize(OFF)
# Set only alternate config settings from the options
if self.options.__dict__['config'] is not None:
self.defaults['config'] = self.options.__dict__['config']
self.output.debug('ARGSPARSER: Got config file at ' + \
self.defaults['config'], 8)
else: # fix the config path
self.defaults['config'] = self.defaults['config'] \
% {'configdir': self.defaults['configdir']}
if self.options.__dict__['overlay_defs'] is not None:
self.defaults['overlay_defs'] = self.options.__dict__['overlay_defs']
self.output.debug('ARGSPARSER: Got overlay_defs location at ' + \
self.defaults['overlay_defs'], 8)
# Now parse the config file
self.output.debug('ARGSPARSER: Reading config file at ' + \
self.defaults['config'], 8)
self.read_config(self.defaults)
# handle quietness
if self.options.__dict__['quiet']:
self.set_option('quiet', True)
elif self.options.__dict__['quietness']:
self.set_option('quietness', self.options.__dict__['quietness'])
def __getitem__(self, key):
if key == 'overlays':
overlays = ''
if (key in self.options.__dict__.keys()
and not self.options.__dict__[key] is None):
overlays = '\n'.join(self.options.__dict__[key])
if self.config.has_option('MAIN', 'overlays'):
overlays += '\n' + self.config.get('MAIN', 'overlays')
if len(overlays):
return overlays
self.output.debug('ARGSPARSER: Retrieving options option: %s' % key, 9)
if (key in self.options.__dict__.keys()
and not self.options.__dict__[key] is None):
return self.options.__dict__[key]
self.output.debug('ARGSPARSER: Retrieving config option: %s' % key, 9)
if self.config.has_option('MAIN', key):
if key in self._defaults['t/f_options']:
return self.t_f_check(self.config.get('MAIN', key))
return self.config.get('MAIN', key)
self.output.debug('ARGSPARSER: Retrieving option: %s' % key, 9)
if key in self._options.keys():
return self._options[key]
if key in self.defaults.keys():
return self.defaults[key]
self.output.debug('ARGSPARSER: Retrieving option failed. returning None', 9)
return None
def keys(self):
'''Special handler for the configuration keys.'''
self.output.debug('ARGSPARSER: Retrieving keys', 9)
keys = [i for i in self.options.__dict__.keys()
if not self.options.__dict__[i] is None]
self.output.debug('ARGSPARSER: Retrieving keys 2', 9)
keys += [name for name, _ in self.config.items('MAIN')
if not name in keys]
self.output.debug('ARGSPARSER: Retrieving keys 3', 9)
keys += [i for i in self.defaults.keys()
if not i in keys]
self.output.debug('ARGSPARSER: Returning keys', 9)
return keys
#===============================================================================
#
# Testing
#
#-------------------------------------------------------------------------------
if __name__ == '__main__':
import doctest
doctest.testmod(sys.modules[__name__])
|
