Hide keyboard shortcuts

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

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

# -*- Mode: Python -*- 

# pygobject - Python bindings for the GObject library 

# Copyright (C) 2006 Johannes Hoelzl 

# 

# glib/option.py: GOption command line parser 

# 

# This library is free software; you can redistribute it and/or 

# modify it under the terms of the GNU Lesser General Public 

# License as published by the Free Software Foundation; either 

# version 2.1 of the License, or (at your option) any later version. 

# 

# This library 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 

# Lesser General Public License for more details. 

# 

# You should have received a copy of the GNU Lesser General Public 

# License along with this library; if not, see <http://www.gnu.org/licenses/>. 

 

"""GOption command line parser 

 

Extends optparse to use the GOptionGroup, GOptionEntry and GOptionContext 

objects. So it is possible to use the gtk, gnome_program and gstreamer command 

line groups and contexts. 

 

Use this interface instead of the raw wrappers of GOptionContext and 

GOptionGroup in glib. 

""" 

 

import sys 

import optparse 

from optparse import OptParseError, OptionError, OptionValueError, \ 

BadOptionError, OptionConflictError 

from .module import get_introspection_module 

 

if sys.version_info >= (3, 0): 

_basestring = str 

_bytes = lambda s: s.encode() 

else: 

_basestring = basestring 

_bytes = str 

 

from gi import _gi 

from gi._error import GError 

GLib = get_introspection_module('GLib') 

 

OPTION_CONTEXT_ERROR_QUARK = GLib.quark_to_string(GLib.option_error_quark()) 

 

__all__ = [ 

"OptParseError", 

"OptionError", 

"OptionValueError", 

"BadOptionError", 

"OptionConflictError", 

"Option", 

"OptionGroup", 

"OptionParser", 

"make_option", 

] 

 

 

class Option(optparse.Option): 

"""Represents a command line option 

 

To use the extended possibilities of the GOption API Option 

(and make_option) are extended with new types and attributes. 

 

Types: 

filename The supplied arguments are read as filename, GOption 

parses this type in with the GLib filename encoding. 

 

:ivar optional_arg: 

This does not need a arguement, but it can be supplied. 

:ivar hidden: 

The help list does not show this option 

:ivar in_main: 

This option apears in the main group, this should only 

be used for backwards compatibility. 

 

Use Option.REMAINING as option name to get all positional arguments. 

 

.. NOTE:: 

Every argument to an option is passed as utf-8 coded string, the only 

exception are options which use the 'filename' type, its arguments 

are passed as strings in the GLib filename encoding. 

 

For further help, see optparse.Option. 

""" 

TYPES = optparse.Option.TYPES + ( 

'filename', 

) 

 

ATTRS = optparse.Option.ATTRS + [ 

'hidden', 

'in_main', 

'optional_arg', 

] 

 

REMAINING = '--' + GLib.OPTION_REMAINING 

 

def __init__(self, *args, **kwargs): 

optparse.Option.__init__(self, *args, **kwargs) 

if not self._long_opts: 

raise ValueError("%s at least one long option name.") 

 

if len(self._long_opts) < len(self._short_opts): 

raise ValueError( 

"%s at least more long option names than short option names.") 

 

if not self.help: 

raise ValueError("%s needs a help message.", self._long_opts[0]) 

 

def _set_opt_string(self, opts): 

if self.REMAINING in opts: 

self._long_opts.append(self.REMAINING) 

optparse.Option._set_opt_string(self, opts) 

if len(self._short_opts) > len(self._long_opts): 

raise OptionError("goption.Option needs more long option names " 

"than short option names") 

 

def _to_goptionentries(self): 

flags = 0 

 

if self.hidden: 

flags |= GLib.OptionFlags.HIDDEN 

 

if self.in_main: 

flags |= GLib.OptionFlags.IN_MAIN 

 

if self.takes_value(): 

if self.optional_arg: 

flags |= GLib.OptionFlags.OPTIONAL_ARG 

else: 

flags |= GLib.OptionFlags.NO_ARG 

 

if self.type == 'filename': 

flags |= GLib.OptionFlags.FILENAME 

 

for (long_name, short_name) in zip(self._long_opts, self._short_opts): 

yield (long_name[2:], _bytes(short_name[1]), flags, self.help, self.metavar) 

 

for long_name in self._long_opts[len(self._short_opts):]: 

yield (long_name[2:], _bytes('\0'), flags, self.help, self.metavar) 

 

 

class OptionGroup(optparse.OptionGroup): 

"""A group of command line options. 

 

:param str name: 

The groups name, used to create the --help-{name} option 

:param str description: 

Shown as title of the groups help view 

:param str help_description: 

Shown as help to the --help-{name} option 

:param list option_list: 

The options used in this group, must be option.Option() 

:param dict defaults: 

A dicitionary of default values 

:param translation_domain: 

Sets the translation domain for gettext(). 

 

.. NOTE:: 

This OptionGroup does not exactly map the optparse.OptionGroup 

interface. There is no parser object to supply, but it is possible 

to set default values and option_lists. Also the default values and 

values are not shared with the OptionParser. 

 

To pass a OptionGroup into a function which expects a GOptionGroup (e.g. 

gnome_program_init() ). OptionGroup.get_option_group() can be used. 

 

For further help, see optparse.OptionGroup. 

""" 

def __init__(self, name, description, help_description="", 

option_list=None, defaults=None, 

translation_domain=None): 

optparse.OptionContainer.__init__(self, Option, 'error', description) 

self.name = name 

self.parser = None 

self.help_description = help_description 

if defaults: 

self.defaults = defaults 

 

self.values = None 

 

self.translation_domain = translation_domain 

 

if option_list: 

for option in option_list: 

self.add_option(option) 

 

def _create_option_list(self): 

self.option_list = [] 

self._create_option_mappings() 

 

def _to_goptiongroup(self, parser): 

def callback(option_name, option_value, group): 

if option_name.startswith('--'): 

opt = self._long_opt[option_name] 

else: 

opt = self._short_opt[option_name] 

 

try: 

opt.process(option_name, option_value, self.values, parser) 

except OptionValueError: 

error = sys.exc_info()[1] 

gerror = GError(str(error)) 

gerror.domain = OPTION_CONTEXT_ERROR_QUARK 

gerror.code = GLib.OptionError.BAD_VALUE 

gerror.message = str(error) 

raise gerror 

 

group = _gi.OptionGroup(self.name, self.description, 

self.help_description, callback) 

if self.translation_domain: 

group.set_translation_domain(self.translation_domain) 

 

entries = [] 

for option in self.option_list: 

entries.extend(option._to_goptionentries()) 

 

group.add_entries(entries) 

 

return group 

 

def get_option_group(self, parser=None): 

""" Returns the corresponding GOptionGroup object. 

 

Can be used as parameter for gnome_program_init(), gtk_init(). 

""" 

self.set_values_to_defaults() 

return self._to_goptiongroup(parser) 

 

def set_values_to_defaults(self): 

for option in self.option_list: 

default = self.defaults.get(option.dest) 

if isinstance(default, _basestring): 

opt_str = option.get_opt_string() 

self.defaults[option.dest] = option.check_value( 

opt_str, default) 

self.values = optparse.Values(self.defaults) 

 

 

class OptionParser(optparse.OptionParser): 

"""Command line parser with GOption support. 

 

:param bool help_enabled: 

The --help, --help-all and --help-{group} options are enabled (default). 

:param bool ignore_unknown_options: 

Do not throw a exception when a option is not knwon, the option 

will be in the result list. 

 

.. NOTE:: 

The OptionParser interface is not the exactly the same as the 

optparse.OptionParser interface. Especially the usage parameter 

is only used to show the metavar of the arguements. 

 

OptionParser.add_option_group() does not only accept OptionGroup instances 

but also glib.OptionGroup, which is returned by gtk_get_option_group(). 

 

Only glib.option.OptionGroup and glib.option.Option instances should 

be passed as groups and options. 

 

For further help, see optparse.OptionParser. 

""" 

 

def __init__(self, *args, **kwargs): 

if 'option_class' not in kwargs: 

kwargs['option_class'] = Option 

self.help_enabled = kwargs.pop('help_enabled', True) 

self.ignore_unknown_options = kwargs.pop('ignore_unknown_options', 

False) 

optparse.OptionParser.__init__(self, add_help_option=False, 

*args, **kwargs) 

 

def set_usage(self, usage): 

if usage is None: 

self.usage = '' 

elif usage.startswith("%prog"): 

self.usage = usage[len("%prog"):] 

else: 

self.usage = usage 

 

def _to_goptioncontext(self, values): 

if self.description: 

parameter_string = self.usage + " - " + self.description 

else: 

parameter_string = self.usage 

context = _gi.OptionContext(parameter_string) 

context.set_help_enabled(self.help_enabled) 

context.set_ignore_unknown_options(self.ignore_unknown_options) 

 

for option_group in self.option_groups: 

if isinstance(option_group, _gi.OptionGroup): 

g_group = option_group 

else: 

g_group = option_group.get_option_group(self) 

context.add_group(g_group) 

 

def callback(option_name, option_value, group): 

if option_name.startswith('--'): 

opt = self._long_opt[option_name] 

else: 

opt = self._short_opt[option_name] 

opt.process(option_name, option_value, values, self) 

 

main_group = _gi.OptionGroup(None, None, None, callback) 

main_entries = [] 

for option in self.option_list: 

main_entries.extend(option._to_goptionentries()) 

main_group.add_entries(main_entries) 

context.set_main_group(main_group) 

 

return context 

 

def add_option_group(self, *args, **kwargs): 

if isinstance(args[0], _basestring): 

optparse.OptionParser.add_option_group(self, 

OptionGroup(self, *args, **kwargs)) 

return 

elif len(args) == 1 and not kwargs: 

if isinstance(args[0], OptionGroup): 

if not args[0].parser: 

args[0].parser = self 

if args[0].parser is not self: 

raise ValueError("invalid OptionGroup (wrong parser)") 

if isinstance(args[0], _gi.OptionGroup): 

self.option_groups.append(args[0]) 

return 

optparse.OptionParser.add_option_group(self, *args, **kwargs) 

 

def _get_all_options(self): 

options = self.option_list[:] 

for group in self.option_groups: 

if isinstance(group, optparse.OptionGroup): 

options.extend(group.option_list) 

return options 

 

def _process_args(self, largs, rargs, values): 

context = self._to_goptioncontext(values) 

 

# _process_args() returns the remaining parameters in rargs. 

# The prepended program name is used to all g_set_prgname() 

# The program name is cut away so it doesn't appear in the result. 

rargs[:] = context.parse([sys.argv[0]] + rargs)[1:] 

 

def parse_args(self, args=None, values=None): 

old_args = args or [] 

try: 

options, args = optparse.OptionParser.parse_args( 

self, args, values) 

except GError: 

error = sys.exc_info()[1] 

if error.domain != OPTION_CONTEXT_ERROR_QUARK: 

raise 

if error.code == GLib.OptionError.BAD_VALUE: 

raise OptionValueError(error.message) 

elif error.code == GLib.OptionError.UNKNOWN_OPTION: 

raise BadOptionError(error.message) 

elif error.code == GLib.OptionError.FAILED: 

raise OptParseError(error.message) 

else: 

raise 

 

for group in self.option_groups: 

for key, value in group.values.__dict__.items(): 

options.ensure_value(key, value) 

 

args = args[2:-len(old_args)] 

return options, args 

 

 

make_option = Option