/usr/lib/python2.7/dist-packages/gbp/config.py is in git-buildpackage 0.6.9.
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 | # vim: set fileencoding=utf-8 :
#
# (C) 2006,2007,2010-2012 Guido Guenther <agx@sigxcpu.org>
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""handles command line and config file option parsing for the gbp commands"""
from optparse import OptionParser, OptionGroup, Option, OptionValueError
from ConfigParser import SafeConfigParser, NoSectionError
from copy import copy
import os.path
try:
from gbp.version import gbp_version
except ImportError:
gbp_version = "[Unknown version]"
import gbp.tristate
no_upstream_branch_msg = """
Repository does not have branch '%s' for upstream sources. If there is none see
file:///usr/share/doc/git-buildpackage/manual-html/gbp.import.html#GBP.IMPORT.CONVERT
on howto create it otherwise use --upstream-branch to specify it.
"""
def expand_path(option, opt, value):
value = os.path.expandvars(value)
return os.path.expanduser(value)
def check_tristate(option, opt, value):
try:
val = gbp.tristate.Tristate(value)
except TypeError:
raise OptionValueError(
"option %s: invalid value: %r" % (opt, value))
else:
return val
class GbpOption(Option):
TYPES = Option.TYPES + ('path', 'tristate')
TYPE_CHECKER = copy(Option.TYPE_CHECKER)
TYPE_CHECKER['path'] = expand_path
TYPE_CHECKER['tristate'] = check_tristate
class GbpOptionParser(OptionParser):
"""
Handles commandline options and parsing of config files
@ivar command: the gbp command we store the options for
@type command: string
@ivar prefix: prefix to prepend to all commandline options
@type prefix: string
@ivar config: current configuration parameters
@type config: dict
@cvar defaults: defaults value of an option if not in the config file or
given on the command line
@type defaults: dict
@cvar help: help messages
@type help: dict
@cvar def_config_files: list of default config files we parse
@type def_config_files: list
"""
defaults = { 'debian-branch' : 'master',
'upstream-branch' : 'upstream',
'upstream-tree' : 'TAG',
'pristine-tar' : 'False',
'pristine-tar-commit': 'False',
'filter-pristine-tar' : 'False',
'sign-tags' : 'False',
'force-create' : 'False',
'no-create-orig' : 'False',
'keyid' : '',
'posttag' : '',
'postbuild' : '',
'prebuild' : '',
'postexport' : '',
'postimport' : '',
'hooks' : 'True',
'debian-tag' : 'debian/%(version)s',
'upstream-tag' : 'upstream/%(version)s',
'import-msg' : 'Imported Upstream version %(version)s',
'commit-msg' : 'Update changelog for %(version)s release',
'filter' : [],
'snapshot-number' : 'snapshot + 1',
'git-log' : '--no-merges',
'export' : 'HEAD',
'export-dir' : '',
'overlay' : 'False',
'tarball-dir' : '',
'ignore-new' : 'False',
'ignore-branch' : 'False',
'meta' : 'False',
'meta-closes' : 'Closes|LP',
'full' : 'False',
'id-length' : '0',
'git-author' : 'False',
'ignore-regex' : '',
'compression' : 'auto',
'compression-level': '9',
'remote-url-pattern' : 'ssh://git.debian.org/git/collab-maint/%(pkg)s.git',
'multimaint' : 'True',
'multimaint-merge': 'False',
'pbuilder' : 'False',
'qemubuilder' : 'False',
'dist' : 'sid',
'arch' : '',
'interactive' : 'True',
'color' : 'auto',
'color-scheme' : '',
'customizations' : '',
'spawn-editor' : 'release',
'patch-numbers' : 'True',
'notify' : 'auto',
'merge' : 'True',
'track' : 'True',
'author-is-committer': 'False',
'author-date-is-committer-date': 'False',
'create-missing-branches': 'False',
'submodules' : 'False',
'time-machine' : 1,
'pbuilder-autoconf' : 'True',
'pbuilder-options': '',
'template-dir': '',
'remote-config': '',
'allow-unauthenticated': 'False',
'symlink-orig': 'True',
'purge': 'True',
}
help = {
'debian-branch':
("Branch the Debian package is being developed on, "
"default is '%(debian-branch)s'"),
'upstream-branch':
"Upstream branch, default is '%(upstream-branch)s'",
'upstream-tree':
("Where to generate the upstream tarball from "
"(tag or branch), default is '%(upstream-tree)s'"),
'debian-tag':
("Format string for debian tags, "
"default is '%(debian-tag)s'"),
'upstream-tag':
("Format string for upstream tags, "
"default is '%(upstream-tag)s'"),
'sign-tags':
"Whether to sign tags, default is '%(sign-tags)s'",
'keyid':
"GPG keyid to sign tags with, default is '%(keyid)s'",
'import-msg':
("Format string for commit message used to commit "
"the upstream tarball, default is '%(import-msg)s'"),
'commit-msg':
("Format string for commit messag used to commit, "
"the changelog, default is '%(commit-msg)s'"),
'pristine-tar':
("Use pristine-tar to create orig tarball, "
"default is '%(pristine-tar)s'"),
'pristine-tar-commit':
("When generating a tarball commit it to the pristine-tar branch '%(pristine-tar-commit)s' "
"default is '%(pristine-tar-commit)s'"),
'filter-pristine-tar':
"Filter pristine-tar when filter option is used, default is '%(filter-pristine-tar)s'",
'filter':
"Files to filter out during import (can be given multiple times), default is %(filter)s",
'git-author':
"Use name and email from git-config for changelog trailer, default is '%(git-author)s'",
'full':
"Include the full commit message instead of only the first line, default is '%(full)s'",
'meta':
"Parse meta tags in commit messages, default is '%(meta)s'",
'ignore-new':
"Build with uncommited changes in the source tree, default is '%(ignore-new)s'",
'ignore-branch':
("Build although debian-branch != current branch, "
"default is '%(ignore-branch)s'"),
'overlay':
("extract orig tarball when using export-dir option, "
"default is '%(overlay)s'"),
'remote-url-pattern':
("Remote url pattern to create the repo at, "
"default is '%(remote-url-pattern)s'"),
'multimaint':
"Note multiple maintainers, default is '%(multimaint)s'",
'multimaint-merge':
("Merge commits by maintainer, "
"default is '%(multimaint-merge)s'"),
'pbuilder':
("Invoke git-pbuilder for building, "
"default is '%(pbuilder)s'"),
'dist':
("Build for this distribution when using git-pbuilder, "
"default is '%(dist)s'"),
'arch':
("Build for this architecture when using git-pbuilder, "
"default is '%(arch)s'"),
'qemubuilder':
("Invoke git-pbuilder with qemubuilder for building, "
"default is '%(qemubuilder)s'"),
'interactive':
"Run command interactively, default is '%(interactive)s'",
'color':
"Whether to use colored output, default is '%(color)s'",
'color-scheme':
("Colors to use in output (when color is enabled), format "
"is '<debug>:<info>:<warning>:<error>', e.g. "
"'cyan:34::'. Numerical values and color names are "
"accepted, empty fields indicate using the default."),
'spawn-editor':
("Whether to spawn an editor after adding the "
"changelog entry, default is '%(spawn-editor)s'"),
'patch-numbers':
("Whether to number patch files, "
"default is %(patch-numbers)s"),
'notify':
("Whether to send a desktop notification after the build, "
"default is '%(notify)s'"),
'merge':
("After the import merge the result to the debian branch, "
"default is '%(merge)s'"),
'track':
("Set up tracking for remote branches, "
"default is '%(track)s'"),
'author-is-committer':
("Use the authors's name also as the comitter's name, "
"default is '%(author-is-committer)s'"),
'author-date-is-committer-date':
("Use the authors's date as the comitter's date, "
"default is '%(author-date-is-committer-date)s'"),
'create-missing-branches':
("Create missing branches automatically, "
"default is '%(create-missing-branches)s'"),
'submodules':
("Transparently handle submodules in the upstream tree, "
"default is '%(submodules)s'"),
'postimport':
("hook run after a successful import, "
"default is '%(postimport)s'"),
'hooks':
("Enable running all hooks, default is %(hooks)s"),
'time-machine':
("don't try head commit only to apply the patch queue "
"but look TIME_MACHINE commits back, "
"default is '%(time-machine)d'"),
'pbuilder-autoconf':
("Wheter to configure pbuilder automatically, "
"default is '%(pbuilder-autoconf)s'"),
'pbuilder-options':
("Options to pass to pbuilder, "
"default is '%(pbuilder-options)s'"),
'template-dir':
("Template directory used by git init, "
"default is '%(template-dir)s'"),
'remote-config':
("Remote defintion in gbp.conf used to create the remote "
"repository, default is '%(remote-config)s'"),
'allow-unauthenticated':
("Don't verify integrity of downloaded source, "
"default is '%(allow-unauthenticated)s'"),
'symlink-orig':
("Whether to creat a symlink from the upstream tarball "
"to the orig.tar.gz if needed, default is "
"'%(symlink-orig)s'"),
'purge':
"Purge exported package build directory. Default is '%(purge)s'",
}
def_config_files = [ '/etc/git-buildpackage/gbp.conf',
'~/.gbp.conf',
'.gbp.conf',
'debian/gbp.conf',
'.git/gbp.conf' ]
@classmethod
def get_config_files(klass):
"""
Get list of config files from the I{GBP_CONF_FILES} environment
variable.
@return: list of config files we need to parse
@rtype: C{list}
>>> conf_backup = os.getenv('GBP_CONF_FILES')
>>> if conf_backup is not None: del os.environ['GBP_CONF_FILES']
>>> files = GbpOptionParser.get_config_files()
# Remove the ~-expanded one
>>> del files[1]
>>> files
['/etc/git-buildpackage/gbp.conf', '.gbp.conf', 'debian/gbp.conf', '.git/gbp.conf']
>>> os.environ['GBP_CONF_FILES'] = 'test1:test2'
>>> GbpOptionParser.get_config_files()
['test1', 'test2']
>>> del os.environ['GBP_CONF_FILES']
>>> if conf_backup is not None: os.environ['GBP_CONF_FILES'] = conf_backup
"""
envvar = os.environ.get('GBP_CONF_FILES')
files = envvar.split(':') if envvar else klass.def_config_files
return [ os.path.expanduser(f) for f in files ]
def _parse_config_files(self):
"""
Parse the possible config files and set appropriate values
default values
"""
parser = SafeConfigParser()
# Fill in the built in values
self.config = dict(self.__class__.defaults)
# Update with the values from the defaults section. This is needed
# in case the config file doesn't have a [<command>] section at all
parser.read(self.config_files)
self.config.update(dict(parser.defaults()))
# Make sure we read any legacy sections prior to the real subcommands
# section i.e. read [gbp-pull] prior to [pull]
if (self.command.startswith('gbp-') or
self.command.startswith('git-')):
oldcmd = self.command
if parser.has_section(oldcmd):
self.config.update(dict(parser.items(oldcmd, raw=True)))
cmd = self.command[4:]
else:
for prefix in ['gbp', 'git']:
oldcmd = '%s-%s' % (prefix, self.command)
if parser.has_section(oldcmd):
self.config.update(dict(parser.items(oldcmd, raw=True)))
cmd = self.command
# Update with command specific settings
if parser.has_section(cmd):
self.config.update(dict(parser.items(cmd, raw=True)))
for section in self.sections:
if parser.has_section(section):
self.config.update(dict(parser.items(section, raw=True)))
else:
raise NoSectionError("Mandatory section [%s] does not exist."
% section)
# filter can be either a list or a string, always build a list:
if self.config['filter']:
if self.config['filter'].startswith('['):
self.config['filter'] = eval(self.config['filter'])
else:
self.config['filter'] = [ self.config['filter'] ]
else:
self.config['filter'] = []
def __init__(self, command, prefix='', usage=None, sections=[]):
"""
@param command: the command to build the config parser for
@type command: C{str}
@param prefix: A prefix to add to all command line options
@type prefix: C{str}
@param usage: a usage description
@type usage: C{str}
@param sections: additional (non optional) config file sections
to parse
@type sections: C{list} of C{str}
"""
self.command = command
self.sections = sections
self.prefix = prefix
self.config = {}
self.config_files = self.get_config_files()
self._parse_config_files()
OptionParser.__init__(self, option_class=GbpOption,
usage=usage, version='%s %s' % (self.command,
gbp_version))
def _is_boolean(self, dummy, *unused, **kwargs):
"""is option_name a boolean option"""
ret = False
try:
if kwargs['action'] in [ 'store_true', 'store_false' ]:
ret=True
except KeyError:
ret=False
return ret
def _get_bool_default(self, option_name):
"""
get default for boolean options
this way we can handle no-foo=True and foo=False
"""
if option_name.startswith('no-'):
pos = option_name[3:]
neg = option_name
else:
pos = option_name
neg = "no-%s" % option_name
try:
default = self.config[pos]
except KeyError:
default = self.config[neg]
if default.lower() in ["true", "1" ]:
val = 'True'
elif default.lower() in ["false", "0" ]:
val = 'False'
else:
raise ValueError("Boolean options must be True or False")
return eval(val)
def get_default(self, option_name, **kwargs):
"""get the default value"""
if self._is_boolean(self, option_name, **kwargs):
default = self._get_bool_default(option_name)
else:
default = self.config[option_name]
return default
def add_config_file_option(self, option_name, dest, help=None, **kwargs):
"""
set a option for the command line parser, the default is read from the config file
@param option_name: name of the option
@type option_name: string
@param dest: where to store this option
@type dest: string
@param help: help text
@type help: string
"""
if not help:
help = self.help[option_name]
OptionParser.add_option(self, "--%s%s" % (self.prefix, option_name), dest=dest,
default=self.get_default(option_name, **kwargs),
help=help % self.config, **kwargs)
def add_boolean_config_file_option(self, option_name, dest):
self.add_config_file_option(option_name=option_name, dest=dest, action="store_true")
neg_help = "negates '--%s%s'" % (self.prefix, option_name)
self.add_config_file_option(option_name="no-%s" % option_name, dest=dest, help=neg_help, action="store_false")
class GbpOptionGroup(OptionGroup):
def add_config_file_option(self, option_name, dest, help=None, **kwargs):
"""
set a option for the command line parser, the default is read from the config file
@param option_name: name of the option
@type option_name: string
@param dest: where to store this option
@type dest: string
@param help: help text
@type help: string
"""
if not help:
help = self.parser.help[option_name]
OptionGroup.add_option(self, "--%s%s" % (self.parser.prefix, option_name), dest=dest,
default=self.parser.get_default(option_name, **kwargs),
help=help % self.parser.config, **kwargs)
def add_boolean_config_file_option(self, option_name, dest):
self.add_config_file_option(option_name=option_name, dest=dest, action="store_true")
neg_help = "negates '--%s%s'" % (self.parser.prefix, option_name)
self.add_config_file_option(option_name="no-%s" % option_name, dest=dest, help=neg_help, action="store_false")
class GbpOptionParserDebian(GbpOptionParser):
"""
Handles commandline options and parsing of config files for Debian tools
"""
defaults = dict(GbpOptionParser.defaults)
defaults.update( {
'builder' : 'debuild -i -I',
'cleaner' : '/bin/true',
} )
# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·:
|