/usr/share/dh-python/dhpython/build/base.py is in dh-python 1.20140128-1ubuntu8.
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 | # Copyright © 2012-2013 Piotr Ożarowski <piotr@debian.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import logging
from functools import wraps
from glob import glob1
from os import remove, walk
from os.path import isdir, join
from subprocess import Popen, PIPE
from shutil import rmtree
from dhpython.tools import execute
try:
from shlex import quote
except ImportError:
# shlex.quote is new in Python 3.3
def quote(s):
if not s:
return "''"
return "'" + s.replace("'", "'\"'\"'") + "'"
log = logging.getLogger('dhpython')
class Base:
"""Base class for build system plugins
:attr REQUIRED_COMMANDS: list of command checked by default in :meth:is_usable,
if one of them is missing, plugin cannot be used.
:type REQUIRED_COMMANDS: list of strings
:attr REQUIRED_FILES: list of files (or glob templates) required by given
build system
:attr OPTIONAL_FILES: dictionary of glob templates (key) and score (value)
used to detect if given plugin is the best one for the job
:type OPTIONAL_FILES: dict (key is a string, value is an int)
:attr SUPPORTED_INTERPRETERS: set of interpreter templates (with or without
{version}) supported by given plugin
"""
DESCRIPTION = ''
REQUIRED_COMMANDS = []
REQUIRED_FILES = []
OPTIONAL_FILES = {}
SUPPORTED_INTERPRETERS = {'python', 'python3', 'python-dbg', 'python3-dbg',
'python{version}', 'python{version}-dbg'}
def __init__(self, cfg):
self.cfg = cfg
def __repr__(self):
return "BuildSystem(%s)" % self.NAME
@classmethod
def is_usable(cls):
for command in cls.REQUIRED_COMMANDS:
proces = Popen(['which', command], stdout=PIPE, stderr=PIPE)
out, err = proces.communicate()
if proces.returncode != 0:
raise Exception("missing command: %s" % command)
def detect(self, context):
"""Return certainty level that this plugin describes the right build system
This method is using cls.{REQUIRED,OPTIONAL}_FILES only by default,
please extend it in the plugin if more sofisticated methods can be used
for given build system.
:return: 0 <= certainty <= 100
:rtype: int
"""
result = 0
required_files_num = 0
self.DETECTED_REQUIRED_FILES = {} # can be used in the plugin later
for tpl in self.REQUIRED_FILES:
found = False
for ftpl in tpl.split('|'):
res = glob1(context['dir'], ftpl)
if res:
found = True
self.DETECTED_REQUIRED_FILES.setdefault(tpl, []).extend(res)
if found:
required_files_num += 1
# add max 50 points depending on how many required files are available
if self.REQUIRED_FILES:
result += int(required_files_num / len(self.REQUIRED_FILES) * 50)
self.DETECTED_OPTIONAL_FILES = {}
for ftpl, score in self.OPTIONAL_FILES.items():
res = glob1(context['dir'], ftpl)
if res:
result += score
self.DETECTED_OPTIONAL_FILES.setdefault(ftpl, []).extend(res)
if result > 100:
return 100
return result
def clean(self, context, args):
if self.cfg.test_tox:
tox_dir = join(args['dir'], '.tox')
if isdir(tox_dir):
try:
rmtree(tox_dir)
except Exception:
log.debug('cannot remove %s', tox_dir)
for root, dirs, file_names in walk(context['dir']):
for name in dirs:
if name == '__pycache__':
dpath = join(root, name)
log.debug('removing dir: %s', dpath)
try:
rmtree(dpath)
except Exception:
log.debug('cannot remove %s', dpath)
else:
dirs.remove(name)
for fn in file_names:
if fn.endswith(('.pyc', '.pyo')):
fpath = join(root, fn)
log.debug('removing: %s', fpath)
try:
remove(fpath)
except Exception:
log.debug('cannot remove %s', fpath)
def configure(self, context, args):
raise NotImplementedError("configure method not implemented in %s" % self.NAME)
def install(self, context, args):
raise NotImplementedError("install method not implemented in %s" % self.NAME)
def build(self, context, args):
raise NotImplementedError("build method not implemented in %s" % self.NAME)
def test(self, context, args):
if self.cfg.test_nose:
return 'cd {build_dir}; {interpreter} -m nose --with-doctest {args}'
elif self.cfg.test_pytest:
return 'cd {build_dir}; {interpreter} -m pytest {args}'
elif self.cfg.test_tox:
return 'cd {build_dir}; tox -c {dir}/tox.ini -e py{version.major}{version.minor}'
elif args['version'] == '2.7' or args['version'] >> '3.1' or args['interpreter'] == 'pypy':
return 'cd {build_dir}; {interpreter} -m unittest discover -v {args}'
def execute(self, context, args, command, log_file=None):
if log_file is False and self.cfg.really_quiet:
log_file = None
command = command.format(**args)
if 'PYTHONPATH' in args:
env = dict(context['ENV'])
env['PYTHONPATH'] = args['PYTHONPATH']
else:
env = context['ENV']
log.info(command)
return execute(command, context['dir'], env, log_file)
def shell_command(func):
@wraps(func)
def wrapped_func(self, context, args, *oargs, **kwargs):
command = kwargs.pop('command', None)
if not command:
command = func(self, context, args, *oargs, **kwargs)
if isinstance(command, int): # final result
return command
if not command:
log.warn('missing command '
'(plugin=%s, method=%s, interpreter=%s, version=%s)',
self.NAME, func.__name__,
args.get('interpreter'), args.get('version'))
return command
if self.cfg.quiet:
log_file = join(args['home_dir'], '{}_cmd.log'.format(func.__name__))
else:
log_file = False
quoted_args = dict((k, quote(v)) if k in ('dir', 'destdir')
or k.endswith('_dir') else (k, v)
for k, v in args.items())
command = command.format(**quoted_args)
output = self.execute(context, args, command, log_file)
if output['returncode'] != 0:
msg = 'exit code={}: {}'.format(output['returncode'], command)
if log_file:
msg += '\nfull command log is available in {}'.format(log_file)
raise Exception(msg)
return True
return wrapped_func
|