From 280c3f18172ae398cac9e83c5bea35b64b704f7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederik=20=E2=80=9CFreso=E2=80=9D=20S=2E=20Olesen?= Date: Fri, 28 Apr 2017 10:55:03 +0200 Subject: [PATCH 1/4] Remove "misc/pep8.py" (outdated PEP8 style checker) pep8.py was added in 2012. Since then, we now have flake8 and a number of other really good PEP 8 (and other style, best practice, etc.) code checkers/linters. It doesn't make sense to track this directly in the repository. If we want to do automated code style/sanity checking, we should add a dependency on an actually maintained program/script rather than keeping it locally in the repository. --- misc/pep8.py | 874 --------------------------------------------------- 1 file changed, 874 deletions(-) delete mode 100644 misc/pep8.py diff --git a/misc/pep8.py b/misc/pep8.py deleted file mode 100644 index 860ba7d..0000000 --- a/misc/pep8.py +++ /dev/null @@ -1,874 +0,0 @@ -#!/usr/bin/python -# pep8.py - Check Python source code formatting, according to PEP 8 -# Copyright (C) 2006 Johann C. Rocholl -# -# 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. - -""" -Check Python source code formatting, according to PEP 8: -http://www.python.org/dev/peps/pep-0008/ - -For usage and a list of options, try this: -$ python pep8.py -h - -This program and its regression test suite live here: -http://svn.browsershots.org/trunk/devtools/pep8/ -http://trac.browsershots.org/browser/trunk/devtools/pep8/ - -Groups of errors and warnings: -E errors -W warnings -100 indentation -200 whitespace -300 blank lines -400 imports -500 line length -600 deprecation -700 statements - -You can add checks to this program by writing plugins. Each plugin is -a simple function that is called for each line of source code, either -physical or logical. - -Physical line: -- Raw line of text from the input file. - -Logical line: -- Multi-line statements converted to a single line. -- Stripped left and right. -- Contents of strings replaced with 'xxx' of same length. -- Comments removed. - -The check function requests physical or logical lines by the name of -the first argument: - -def maximum_line_length(physical_line) -def extraneous_whitespace(logical_line) -def blank_lines(logical_line, blank_lines, indent_level, line_number) - -The last example above demonstrates how check plugins can request -additional information with extra arguments. All attributes of the -Checker object are available. Some examples: - -lines: a list of the raw lines from the input file -tokens: the tokens that contribute to this logical line -line_number: line number in the input file -blank_lines: blank lines before this one -indent_char: first indentation character in this file (' ' or '\t') -indent_level: indentation (with tabs expanded to multiples of 8) -previous_indent_level: indentation on previous line -previous_logical: previous logical line - -The docstring of each check function shall be the relevant part of -text from PEP 8. It is printed if the user enables --show-pep8. - -""" - -import os -import sys -import re -import time -import inspect -import tokenize -from optparse import OptionParser -from keyword import iskeyword -from fnmatch import fnmatch - -__version__ = '0.2.0' -__revision__ = '$Rev$' - -default_exclude = '.svn,CVS,*.pyc,*.pyo' - -indent_match = re.compile(r'([ \t]*)').match -raise_comma_match = re.compile(r'raise\s+\w+\s*(,)').match - -operators = """ -+ - * / % ^ & | = < > >> << -+= -= *= /= %= ^= &= |= == <= >= >>= <<= -!= <> : -in is or not and -""".split() - -options = None -args = None - - -############################################################################## -# Plugins (check functions) for physical lines -############################################################################## - - -def tabs_or_spaces(physical_line, indent_char): - """ - Never mix tabs and spaces. - - The most popular way of indenting Python is with spaces only. The - second-most popular way is with tabs only. Code indented with a mixture - of tabs and spaces should be converted to using spaces exclusively. When - invoking the Python command line interpreter with the -t option, it issues - warnings about code that illegally mixes tabs and spaces. When using -tt - these warnings become errors. These options are highly recommended! - """ - indent = indent_match(physical_line).group(1) - for offset, char in enumerate(indent): - if char != indent_char: - return offset, "E101 indentation contains mixed spaces and tabs" - - -def tabs_obsolete(physical_line): - """ - For new projects, spaces-only are strongly recommended over tabs. Most - editors have features that make this easy to do. - """ - indent = indent_match(physical_line).group(1) - if indent.count('\t'): - return indent.index('\t'), "W191 indentation contains tabs" - - -def trailing_whitespace(physical_line): - """ - JCR: Trailing whitespace is superfluous. - """ - physical_line = physical_line.rstrip('\n') # chr(10), newline - physical_line = physical_line.rstrip('\r') # chr(13), carriage return - physical_line = physical_line.rstrip('\x0c') # chr(12), form feed, ^L - stripped = physical_line.rstrip() - if physical_line != stripped: - return len(stripped), "W291 trailing whitespace" - - -def trailing_blank_lines(physical_line, lines, line_number): - """ - JCR: Trailing blank lines are superfluous. - """ - if physical_line.strip() == '' and line_number == len(lines): - return 0, "W391 blank line at end of file" - - -def missing_newline(physical_line): - """ - JCR: The last line should have a newline. - """ - if physical_line.rstrip() == physical_line: - return len(physical_line), "W292 no newline at end of file" - - -def maximum_line_length(physical_line): - """ - Limit all lines to a maximum of 79 characters. - - There are still many devices around that are limited to 80 character - lines; plus, limiting windows to 80 characters makes it possible to have - several windows side-by-side. The default wrapping on such devices looks - ugly. Therefore, please limit all lines to a maximum of 79 characters. - For flowing long blocks of text (docstrings or comments), limiting the - length to 72 characters is recommended. - """ - length = len(physical_line.rstrip()) - if length > 79: - return 79, "E501 line too long (%d characters)" % length - - -############################################################################## -# Plugins (check functions) for logical lines -############################################################################## - - -def blank_lines(logical_line, blank_lines, indent_level, line_number, - previous_logical): - """ - Separate top-level function and class definitions with two blank lines. - - Method definitions inside a class are separated by a single blank line. - - Extra blank lines may be used (sparingly) to separate groups of related - functions. Blank lines may be omitted between a bunch of related - one-liners (e.g. a set of dummy implementations). - - Use blank lines in functions, sparingly, to indicate logical sections. - """ - if line_number == 1: - return # Don't expect blank lines before the first line - if previous_logical.startswith('@'): - return # Don't expect blank lines after function decorator - if (logical_line.startswith('def ') or - logical_line.startswith('class ') or - logical_line.startswith('@')): - if indent_level > 0 and blank_lines != 1: - return 0, "E301 expected 1 blank line, found %d" % blank_lines - if indent_level == 0 and blank_lines != 2: - return 0, "E302 expected 2 blank lines, found %d" % blank_lines - if blank_lines > 2: - return 0, "E303 too many blank lines (%d)" % blank_lines - - -def extraneous_whitespace(logical_line): - """ - Avoid extraneous whitespace in the following situations: - - - Immediately inside parentheses, brackets or braces. - - - Immediately before a comma, semicolon, or colon. - """ - line = logical_line - for char in '([{': - found = line.find(char + ' ') - if found > -1: - return found + 1, "E201 whitespace after '%s'" % char - for char in '}])': - found = line.find(' ' + char) - if found > -1 and line[found - 1] != ',': - return found, "E202 whitespace before '%s'" % char - for char in ',;:': - found = line.find(' ' + char) - if found > -1: - return found, "E203 whitespace before '%s'" % char - - -def missing_whitespace(logical_line): - """ - JCR: Each comma, semicolon or colon should be followed by whitespace. - """ - line = logical_line - for index in range(len(line) - 1): - char = line[index] - if char in ',;:' and line[index + 1] != ' ': - before = line[:index] - if char == ':' and before.count('[') > before.count(']'): - continue # Slice syntax, no space required - return index, "E231 missing whitespace after '%s'" % char - - -def indentation(logical_line, previous_logical, indent_char, - indent_level, previous_indent_level): - """ - Use 4 spaces per indentation level. - - For really old code that you don't want to mess up, you can continue to - use 8-space tabs. - """ - if indent_char == ' ' and indent_level % 4: - return 0, "E111 indentation is not a multiple of four" - indent_expect = previous_logical.endswith(':') - if indent_expect and indent_level <= previous_indent_level: - return 0, "E112 expected an indented block" - if indent_level > previous_indent_level and not indent_expect: - return 0, "E113 unexpected indentation" - - -def whitespace_before_parameters(logical_line, tokens): - """ - Avoid extraneous whitespace in the following situations: - - - Immediately before the open parenthesis that starts the argument - list of a function call. - - - Immediately before the open parenthesis that starts an indexing or - slicing. - """ - prev_type = tokens[0][0] - prev_text = tokens[0][1] - prev_end = tokens[0][3] - for index in range(1, len(tokens)): - token_type, text, start, end, line = tokens[index] - if (token_type == tokenize.OP and - text in '([' and - start != prev_end and - prev_type == tokenize.NAME and - (index < 2 or tokens[index - 2][1] != 'class') and - (not iskeyword(prev_text))): - return prev_end, "E211 whitespace before '%s'" % text - prev_type = token_type - prev_text = text - prev_end = end - - -def whitespace_around_operator(logical_line): - """ - Avoid extraneous whitespace in the following situations: - - - More than one space around an assignment (or other) operator to - align it with another. - """ - line = logical_line - for operator in operators: - found = line.find(' ' + operator) - if found > -1: - return found, "E221 multiple spaces before operator" - found = line.find(operator + ' ') - if found > -1: - return found, "E222 multiple spaces after operator" - found = line.find('\t' + operator) - if found > -1: - return found, "E223 tab before operator" - found = line.find(operator + '\t') - if found > -1: - return found, "E224 tab after operator" - - -def whitespace_around_comma(logical_line): - """ - Avoid extraneous whitespace in the following situations: - - - More than one space around an assignment (or other) operator to - align it with another. - - JCR: This should also be applied around comma etc. - """ - line = logical_line - for separator in ',;:': - found = line.find(separator + ' ') - if found > -1: - return found + 1, "E241 multiple spaces after '%s'" % separator - found = line.find(separator + '\t') - if found > -1: - return found + 1, "E242 tab after '%s'" % separator - - -def imports_on_separate_lines(logical_line): - """ - Imports should usually be on separate lines. - """ - line = logical_line - if line.startswith('import '): - found = line.find(',') - if found > -1: - return found, "E401 multiple imports on one line" - - -def compound_statements(logical_line): - """ - Compound statements (multiple statements on the same line) are - generally discouraged. - """ - line = logical_line - found = line.find(':') - if -1 < found < len(line) - 1: - before = line[:found] - if (before.count('{') <= before.count('}') and # {'a': 1} (dict) - before.count('[') <= before.count(']') and # [1:2] (slice) - not re.search(r'\blambda\b', before)): # lambda x: x - return found, "E701 multiple statements on one line (colon)" - found = line.find(';') - if -1 < found: - return found, "E702 multiple statements on one line (semicolon)" - - -def python_3000_has_key(logical_line): - """ - The {}.has_key() method will be removed in the future version of - Python. Use the 'in' operation instead, like: - d = {"a": 1, "b": 2} - if "b" in d: - print d["b"] - """ - pos = logical_line.find('.has_key(') - if pos > -1: - return pos, "W601 .has_key() is deprecated, use 'in'" - - -def python_3000_raise_comma(logical_line): - """ - When raising an exception, use "raise ValueError('message')" - instead of the older form "raise ValueError, 'message'". - - The paren-using form is preferred because when the exception arguments - are long or include string formatting, you don't need to use line - continuation characters thanks to the containing parentheses. The older - form will be removed in Python 3000. - """ - match = raise_comma_match(logical_line) - if match: - return match.start(1), "W602 deprecated form of raising exception" - - -############################################################################## -# Helper functions -############################################################################## - - -def expand_indent(line): - """ - Return the amount of indentation. - Tabs are expanded to the next multiple of 8. - - >>> expand_indent(' ') - 4 - >>> expand_indent('\\t') - 8 - >>> expand_indent(' \\t') - 8 - >>> expand_indent(' \\t') - 8 - >>> expand_indent(' \\t') - 16 - """ - result = 0 - for char in line: - if char == '\t': - result = result / 8 * 8 + 8 - elif char == ' ': - result += 1 - else: - break - return result - - -############################################################################## -# Framework to run all checks -############################################################################## - - -def message(text): - """Print a message.""" - # print >> sys.stderr, options.prog + ': ' + text - # print >> sys.stderr, text - print text - - -def find_checks(argument_name): - """ - Find all globally visible functions where the first argument name - starts with argument_name. - """ - checks = [] - function_type = type(find_checks) - for name, function in globals().iteritems(): - if type(function) is function_type: - args = inspect.getargspec(function)[0] - if len(args) >= 1 and args[0].startswith(argument_name): - checks.append((name, function, args)) - checks.sort() - return checks - - -def mute_string(text): - """ - Replace contents with 'xxx' to prevent syntax matching. - - >>> mute_string('"abc"') - '"xxx"' - >>> mute_string("'''abc'''") - "'''xxx'''" - >>> mute_string("r'abc'") - "r'xxx'" - """ - start = 1 - end = len(text) - 1 - # String modifiers (e.g. u or r) - if text.endswith('"'): - start += text.index('"') - elif text.endswith("'"): - start += text.index("'") - # Triple quotes - if text.endswith('"""') or text.endswith("'''"): - start += 2 - end -= 2 - return text[:start] + 'x' * (end - start) + text[end:] - - -class Checker: - """ - Load a Python source file, tokenize it, check coding style. - """ - - def __init__(self, filename): - self.filename = filename - self.lines = file(filename).readlines() - self.physical_checks = find_checks('physical_line') - self.logical_checks = find_checks('logical_line') - options.counters['physical lines'] = \ - options.counters.get('physical lines', 0) + len(self.lines) - - def readline(self): - """ - Get the next line from the input buffer. - """ - self.line_number += 1 - if self.line_number > len(self.lines): - return '' - return self.lines[self.line_number - 1] - - def readline_check_physical(self): - """ - Check and return the next physical line. This method can be - used to feed tokenize.generate_tokens. - """ - line = self.readline() - if line: - self.check_physical(line) - return line - - def run_check(self, check, argument_names): - """ - Run a check plugin. - """ - arguments = [] - for name in argument_names: - arguments.append(getattr(self, name)) - return check(*arguments) - - def check_physical(self, line): - """ - Run all physical checks on a raw input line. - """ - self.physical_line = line - if self.indent_char is None and len(line) and line[0] in ' \t': - self.indent_char = line[0] - for name, check, argument_names in self.physical_checks: - result = self.run_check(check, argument_names) - if result is not None: - offset, text = result - self.report_error(self.line_number, offset, text, check) - - def build_tokens_line(self): - """ - Build a logical line from tokens. - """ - self.mapping = [] - logical = [] - length = 0 - previous = None - for token in self.tokens: - token_type, text = token[0:2] - if token_type in (tokenize.COMMENT, tokenize.NL, - tokenize.INDENT, tokenize.DEDENT, - tokenize.NEWLINE): - continue - if token_type == tokenize.STRING: - text = mute_string(text) - if previous: - end_line, end = previous[3] - start_line, start = token[2] - if end_line != start_line: # different row - if self.lines[end_line - 1][end - 1] not in '{[(': - logical.append(' ') - length += 1 - elif end != start: # different column - fill = self.lines[end_line - 1][end:start] - logical.append(fill) - length += len(fill) - self.mapping.append((length, token)) - logical.append(text) - length += len(text) - previous = token - self.logical_line = ''.join(logical) - assert self.logical_line.lstrip() == self.logical_line - assert self.logical_line.rstrip() == self.logical_line - - def check_logical(self): - """ - Build a line from tokens and run all logical checks on it. - """ - options.counters['logical lines'] = \ - options.counters.get('logical lines', 0) + 1 - self.build_tokens_line() - first_line = self.lines[self.mapping[0][1][2][0] - 1] - indent = first_line[:self.mapping[0][1][2][1]] - self.previous_indent_level = self.indent_level - self.indent_level = expand_indent(indent) - if options.verbose >= 2: - print self.logical_line[:80].rstrip() - for name, check, argument_names in self.logical_checks: - if options.verbose >= 3: - print ' ', name - result = self.run_check(check, argument_names) - if result is not None: - offset, text = result - if type(offset) is tuple: - original_number, original_offset = offset - else: - for token_offset, token in self.mapping: - if offset >= token_offset: - original_number = token[2][0] - original_offset = (token[2][1] - + offset - token_offset) - self.report_error(original_number, original_offset, - text, check) - self.previous_logical = self.logical_line - - def check_all(self): - """ - Run all checks on the input file. - """ - self.file_errors = 0 - self.line_number = 0 - self.indent_char = None - self.indent_level = 0 - self.previous_logical = '' - self.blank_lines = 0 - self.tokens = [] - parens = 0 - for token in tokenize.generate_tokens(self.readline_check_physical): - # print tokenize.tok_name[token[0]], repr(token) - self.tokens.append(token) - token_type, text = token[0:2] - if token_type == tokenize.OP and text in '([{': - parens += 1 - if token_type == tokenize.OP and text in '}])': - parens -= 1 - if token_type == tokenize.NEWLINE and not parens: - self.check_logical() - self.blank_lines = 0 - self.tokens = [] - if token_type == tokenize.NL and not parens: - if len(self.tokens) <= 1: - # The physical line contains only this token. - self.blank_lines += 1 - self.tokens = [] - if token_type == tokenize.COMMENT: - source_line = token[4] - token_start = token[2][1] - if source_line[:token_start].strip() == '': - self.blank_lines = 0 - if text.endswith('\n') and not parens: - # The comment also ends a physical line. This works around - # Python < 2.6 behaviour, which does not generate NL after - # a comment which is on a line by itself. - self.tokens = [] - return self.file_errors - - def report_error(self, line_number, offset, text, check): - """ - Report an error, according to options. - """ - if options.quiet == 1 and not self.file_errors: - message(self.filename) - self.file_errors += 1 - code = text[:4] - options.counters[code] = options.counters.get(code, 0) + 1 - options.messages[code] = text[5:] - if options.quiet: - return - if options.testsuite: - base = os.path.basename(self.filename)[:4] - if base == code: - return - if base[0] == 'E' and code[0] == 'W': - return - if ignore_code(code): - return - if options.counters[code] == 1 or options.repeat: - message("%s:%s:%d: %s" % - (self.filename, line_number, offset + 1, text)) - if options.show_source: - line = self.lines[line_number - 1] - message(line.rstrip()) - message(' ' * offset + '^') - if options.show_pep8: - message(check.__doc__.lstrip('\n').rstrip()) - - -def input_file(filename): - """ - Run all checks on a Python source file. - """ - if excluded(filename) or not filename_match(filename): - return {} - if options.verbose: - message('checking ' + filename) - options.counters['files'] = options.counters.get('files', 0) + 1 - errors = Checker(filename).check_all() - if options.testsuite and not errors: - message("%s: %s" % (filename, "no errors found")) - return errors - - -def input_dir(dirname): - """ - Check all Python source files in this directory and all subdirectories. - """ - dirname = dirname.rstrip('/') - if excluded(dirname): - return 0 - errors = 0 - for root, dirs, files in os.walk(dirname): - if options.verbose: - message('directory ' + root) - options.counters['directories'] = \ - options.counters.get('directories', 0) + 1 - dirs.sort() - for subdir in dirs: - if excluded(subdir): - dirs.remove(subdir) - files.sort() - for filename in files: - errors += input_file(os.path.join(root, filename)) - return errors - - -def excluded(filename): - """ - Check if options.exclude contains a pattern that matches filename. - """ - basename = os.path.basename(filename) - for pattern in options.exclude: - if fnmatch(basename, pattern): - # print basename, 'excluded because it matches', pattern - return True - - -def filename_match(filename): - """ - Check if options.filename contains a pattern that matches filename. - If options.filename is unspecified, this always returns True. - """ - if not options.filename: - return True - for pattern in options.filename: - if fnmatch(filename, pattern): - return True - - -def ignore_code(code): - """ - Check if options.ignore contains a prefix of the error code. - """ - for ignore in options.ignore: - if code.startswith(ignore): - return True - - -def get_error_statistics(): - """Get error statistics.""" - return get_statistics("E") - - -def get_warning_statistics(): - """Get warning statistics.""" - return get_statistics("W") - - -def get_statistics(prefix=''): - """ - Get statistics for message codes that start with the prefix. - - prefix='' matches all errors and warnings - prefix='E' matches all errors - prefix='W' matches all warnings - prefix='E4' matches all errors that have to do with imports - """ - stats = [] - keys = options.messages.keys() - keys.sort() - for key in keys: - if key.startswith(prefix): - stats.append('%-7s %s %s' % - (options.counters[key], key, options.messages[key])) - return stats - - -def print_statistics(prefix=''): - """Print overall statistics (number of errors and warnings).""" - for line in get_statistics(prefix): - print line - - -def print_benchmark(elapsed): - """ - Print benchmark numbers. - """ - print '%-7.2f %s' % (elapsed, 'seconds elapsed') - keys = ['directories', 'files', - 'logical lines', 'physical lines'] - for key in keys: - if key in options.counters: - print '%-7d %s per second (%d total)' % ( - options.counters[key] / elapsed, key, - options.counters[key]) - - -def process_options(arglist=None): - """ - Process options passed either via arglist or via command line args. - """ - global options, args - usage = "%prog [options] input ..." - parser = OptionParser(usage) - parser.add_option('-v', '--verbose', default=0, action='count', - help="print status messages, or debug with -vv") - parser.add_option('-q', '--quiet', default=0, action='count', - help="report only file names, or nothing with -qq") - parser.add_option('--exclude', metavar='patterns', default=default_exclude, - help="skip matches (default %s)" % default_exclude) - parser.add_option('--filename', metavar='patterns', - help="only check matching files (e.g. *.py)") - parser.add_option('--ignore', metavar='errors', default='', - help="skip errors and warnings (e.g. E4,W)") - parser.add_option('--repeat', action='store_true', - help="show all occurrences of the same error") - parser.add_option('--show-source', action='store_true', - help="show source code for each error") - parser.add_option('--show-pep8', action='store_true', - help="show text of PEP 8 for each error") - parser.add_option('--statistics', action='store_true', - help="count errors and warnings") - parser.add_option('--benchmark', action='store_true', - help="measure processing speed") - parser.add_option('--testsuite', metavar='dir', - help="run regression tests from dir") - parser.add_option('--doctest', action='store_true', - help="run doctest on myself") - options, args = parser.parse_args(arglist) - if options.testsuite: - args.append(options.testsuite) - if len(args) == 0: - parser.error('input not specified') - options.prog = os.path.basename(sys.argv[0]) - options.exclude = options.exclude.split(',') - for index in range(len(options.exclude)): - options.exclude[index] = options.exclude[index].rstrip('/') - if options.filename: - options.filename = options.filename.split(',') - if options.ignore: - options.ignore = options.ignore.split(',') - else: - options.ignore = [] - options.counters = {} - options.messages = {} - - return options, args - - -def _main(): - """ - Parse options and run checks on Python source. - """ - options, args = process_options() - if options.doctest: - import doctest - return doctest.testmod() - start_time = time.time() - errors = 0 - for path in args: - if os.path.isdir(path): - errors += input_dir(path) - else: - errors += input_file(path) - elapsed = time.time() - start_time - if options.statistics: - print_statistics() - if options.benchmark: - print_benchmark(elapsed) - return errors > 0 - -if __name__ == '__main__': - sys.exit(_main()) From 182684dc12571386b26feb4e90b58ba96b9eae54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederik=20=E2=80=9CFreso=E2=80=9D=20S=2E=20Olesen?= Date: Fri, 28 Apr 2017 11:07:37 +0200 Subject: [PATCH 2/4] Remove "misc/show-coverage.py" Was added in 2009 and not updated since. There are several Python coverage tools out there, and the current ./COVERAGE doesn't seem to be generated using this script either. --- misc/show-coverage.py | 87 ------------------------------------------- 1 file changed, 87 deletions(-) delete mode 100644 misc/show-coverage.py diff --git a/misc/show-coverage.py b/misc/show-coverage.py deleted file mode 100644 index 4b562c7..0000000 --- a/misc/show-coverage.py +++ /dev/null @@ -1,87 +0,0 @@ -import os -import sys - -class Presentation: - def __init__(self, name, lines, covered): - self.name = name - self.lines = lines - self.covered = covered - - if self.covered == 0: - self.percent = 0 - else: - self.percent = 100 * self.covered / float(self.lines) - - def show(self, maxlen=20): - format = '%%-%ds %%3d %%%% (%%4d / %%4d)' % maxlen - print format % (self.name, self.percent, self.covered, self.lines) - - -class Coverage: - def __init__(self): - self.files = [] - self.total_lines = 0 - self.total_covered = 0 - - def _strip_filename(self, filename): - filename = os.path.basename(filename) - if filename.endswith('.cover'): - filename = filename[:-6] - return filename - - def add_file(self, file): - self.files.append(file) - - def show_results(self): - if not hasattr(self, 'files'): - print 'No coverage data' - return - - self.maxlen = max(map(lambda f: len(self._strip_filename(f)), - self.files)) - print 'Coverage report:' - print '-' * (self.maxlen + 23) - for file in self.files: - self.show_one(file) - print '-' * (self.maxlen + 23) - - p = Presentation('Total', self.total_lines, self.total_covered) - p.show(self.maxlen) - - def show_one(self, filename): - f = open(filename) - lines = [line for line in f.readlines() - if (':' in line or line.startswith('>>>>>>')) and - not line.strip().startswith('#') and - not line.endswith(':\n')] - - uncovered_lines = [line for line in lines - if line.startswith('>>>>>>')] - if not lines: - return - - filename = self._strip_filename(filename) - - p = Presentation(filename, - len(lines), - len(lines) - len(uncovered_lines)) - p.show(self.maxlen) - - self.total_lines += p.lines - self.total_covered += p.covered - -def main(args): - c = Coverage() - files = args[1:] - files.sort() - for file in files: - if 'flumotion.test' in file: - continue - if '__init__' in file: - continue - c.add_file(file) - - c.show_results() - -if __name__ == '__main__': - sys.exit(main(sys.argv)) From 0055e5367e7994fe26f44948083e70a08f174f01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederik=20=E2=80=9CFreso=E2=80=9D=20S=2E=20Olesen?= Date: Fri, 28 Apr 2017 22:53:32 +0200 Subject: [PATCH 3/4] Remove "misc/pycheckerrc" Not actually used by anything in the current codebase and PyChecker doesn't seem to be the recommended Python code style checker or linting tool currently. If we need a configuration file for another tool later on, we can make one then based on current need and wants. --- misc/pycheckerrc | 244 ----------------------------------------------- 1 file changed, 244 deletions(-) delete mode 100644 misc/pycheckerrc diff --git a/misc/pycheckerrc b/misc/pycheckerrc deleted file mode 100644 index 697f40f..0000000 --- a/misc/pycheckerrc +++ /dev/null @@ -1,244 +0,0 @@ -# -*- python -*- -# .pycheckrc file created by PyChecker v0.8.14 @ Thu Oct 21 19:22:09 2004 -# -# It should be placed in your home directory (value of $HOME). -# If $HOME is not set, it will look in the current directory. -# - -# list of evil C extensions that crash the interpreter -evil = [] - -# unused imports -importUsed = 1 - -# unused imports from __init__.py -packageImportUsed = 1 - -# module imports itself -reimportSelf = 0 - -# reimporting a module -moduleImportErrors = 0 - -# module does import and from ... import -mixImport = 0 - -# unused local variables, except tuples -localVariablesUsed = 1 - -# all unused local variables, including tuples -unusedLocalTuple = 0 - -# all unused class data members -membersUsed = 0 - -# all unused module variables -allVariablesUsed = 0 - -# unused private module variables -privateVariableUsed = 0 - -# report each occurrence of global warnings -reportAllGlobals = 0 - -# functions called with named arguments (like keywords) -namedArgs = 0 - -# Attributes (members) must be defined in __init__() -onlyCheckInitForMembers = 0 - -# Subclass.__init__() not defined -initDefinedInSubclass = 0 - -# Baseclass.__init__() not called -baseClassInitted = 0 - -# Subclass needs to override methods that only throw exceptions -abstractClasses = 0 - -# Return None from __init__() -returnNoneFromInit = 1 - -# unreachable code -unreachableCode = 0 - -# a constant is used in a conditional statement -constantConditions = 1 - -# 1 is used in a conditional statement (if 1: or while 1:) -constant1 = 0 - -# check if iterating over a string -stringIteration = 1 - -# check improper use of string.find() -# This is new in pychecker 0.8.14 which is not installed everywhere -#stringFind = 1 - -# Calling data members as functions -callingAttribute = 0 - -# class attribute does not exist -# FIXME: need to fix bug in pychecker so we can disable this per admin_gtk -# class -# classAttrExists = 1 -classAttrExists = 0 - -# First argument to methods -methodArgName = 'self' - -# First argument to classmethods -# classmethodArgNames = ['cls', 'klass'] - -# unused method/function arguments -argumentsUsed = 0 - -# unused method/function variable arguments -varArgumentsUsed = 0 - -# ignore if self is unused in methods -ignoreSelfUnused = 0 - -# check if overridden methods have the same signature -checkOverridenMethods = 0 - -# check if __special__ methods exist and have the correct signature -checkSpecialMethods = 1 - -# check if function/class/method names are reused -redefiningFunction = 1 - -# check if using unary positive (+) which is usually meaningless -unaryPositive = 1 - -# check if modify (call method) on a parameter that has a default value -modifyDefaultValue = 1 - -# check if variables are set to different types -inconsistentTypes = 0 - -# check if unpacking a non-sequence -unpackNonSequence = 1 - -# check if unpacking sequence with the wrong length -unpackLength = 1 - -# check if raising or catching bad exceptions -badExceptions = 1 - -# check if statement appears to have no effect -noEffect = 1 - -# check if using (expr % 1), it has no effect on integers and strings -modulo1 = 1 - -# check if using (expr is const-literal), doesn't always work on integers and strings -isLiteral = 1 - -# check consistent return values -checkReturnValues = 1 - -# check if using implict and explicit return values -checkImplicitReturns = 0 - -# check that attributes of objects exist -checkObjectAttrs = 1 - -# various warnings about incorrect usage of __slots__ -slots = 1 - -# using properties with classic classes -classicProperties = 1 - -# check if __slots__ is empty -emptySlots = 1 - -# check if using integer division -intDivide = 1 - -# check if local variable shadows a global -# disabled because it doesn't give useful output: -# test_input/test24.py:11: Local variable (shadow) shadows global defined on line 0 in file -shadows = 0 - -# check if a variable shadows a builtin -shadowBuiltins = 1 - -# check if input() is used -usesInput = 1 - -# check if the exec statement is used -usesExec = 0 - -# ignore warnings from files under standard library -ignoreStandardLibrary = 1 - -# ignore warnings from the list of modules -blacklist = [ - 'gtk', 'twisted', 'twisted.python', 'pyexpat', - 'zope.interface', 'zope.interface.declarations', - 'zope.interface.interface', - '_interface_coptimizations', -#warning: couldn't find real module for class xml.parsers.expat.ExpatError (module name: xml.parsers.expat) - 'xml.parsers.expat', - 'unittest', - 'whipper.extern.log.log', -] - -# ignore global variables not used if name is one of these values -variablesToIgnore = ['__version__', '__warningregistry__', '__all__', '__credits__', '__test__', '__author__', '__email__', '__revision__'] - -# ignore unused locals/arguments if name is one of these values -unusedNames = ['_', 'empty', 'unused', 'dummy'] - -# ignore use of deprecated modules/functions -deprecated = 1 - -# maximum lines in a function -maxLines = 250 - -# maximum branches in a function -maxBranches = 50 - -# maximum returns in a function -maxReturns = 10 - -# maximum # of arguments to a function -maxArgs = 10 - -# maximum # of locals in a function -maxLocals = 40 - -# maximum # of identifier references (Law of Demeter) -maxReferences = 5 - -# no module doc strings -noDocModule = 0 - -# no class doc strings -noDocClass = 0 - -# no function/method doc strings -noDocFunc = 0 - -# print internal checker parse structures -printParse = 0 - -# turn on debugging for checker -debug = 0 - -# suppressions work like this -suppressions = { - # FIXME: Consumption has a get_next with steps=None - 'flumotion.wizard.steps.Consumption': "no-override", - # FIXME: the import there is for registering steps; do an actual method - 'flumotion.wizard.wizard.Wizard': "no-import", -# 'flumotion.twisted.defer.defer_generator': "self=wrapperself", -# deferToThread imports reactor, which e.g. flumotion.worker.checks.video010 -# does as well - 'twisted.internet.threads.deferToThread' : "no-shadow", - # FIXME: doing this inline doesn't seem to work - 'flumotion.component.producers.looper.admin_gtk.py': 'no-classattr', - # Catching a non-Exception object (KeyboardInterrupt) - 'unittest': 'no-badexcept', -} From f0692ba7d7e871cd36a69e2bb8a0f236db0df3f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederik=20=E2=80=9CFreso=E2=80=9D=20S=2E=20Olesen?= Date: Fri, 28 Apr 2017 22:55:24 +0200 Subject: [PATCH 4/4] Remove "misc/whipper-uninstalled" A script that sets up an environment for running whipper without actually installing it. With the clean ups that have happened to whipper as well as later developments in the Python eco system, simply setting up a virtualenv and running whipper from within that seems like a more reasonable approach at this time. This also fixes https://github.com/JoeLametta/whipper/issues/47 by removing the "morituri-uninstalled mode" completely. :) --- misc/whipper-uninstalled | 83 ---------------------------------------- 1 file changed, 83 deletions(-) delete mode 100755 misc/whipper-uninstalled diff --git a/misc/whipper-uninstalled b/misc/whipper-uninstalled deleted file mode 100755 index 050d7df..0000000 --- a/misc/whipper-uninstalled +++ /dev/null @@ -1,83 +0,0 @@ -#!/bin/bash -i -# -# set up environment to use and develop uninstalled -# -# set up PATH, PYTHONPATH -# -# prefer uninstalled versions, but also put installed ones on the path -# -# symlink this script in a directory in your path (for example $HOME/bin) -# to a name that reflects the version of your checkout - -# this script is run -i so that PS1 doesn't get cleared - -self=$0 -absolute=$self -if test -L $absolute -then - # find what the symlink points to - absolute=`stat $absolute -c %N -t | sed 's/^.* -> .//g' | sed 's/.$//g'` -fi -MISCDIR=`dirname $absolute` -BASEDIR=`cd $MISCDIR/.. && pwd` - -# extract version from $0 -# if this script is called "...-head" then version will be "head" -PROJECT=`basename $self | sed s/-.*//g` -VERSION=`basename $self | sed s/.*-//g` -COMMAND=$PROJECT -# override if the command line name to be completed is different -COMMAND=whipper - -options= - -# set up a bunch of paths -export PATH=$BASEDIR/bin${PATH:+:$PATH} -export PYTHONPATH=$BASEDIR${PYTHONPATH:+:$PYTHONPATH} - -# set up bash completion if we have it -tmp= -if echo $SHELL | grep bash > /dev/null -then - if test -d $BASEDIR/etc/bash_completion.d - then - # we need to create our own temporary bashrc replacement from the user's - # and our completion stuff - tmp=`mktemp -t bashrc.XXXXXXXX` - if test -e $HOME/.bashrc - then - cat $HOME/.bashrc > $tmp - fi - cat $BASEDIR/etc/bash_completion.d/$COMMAND >> $tmp - SHELL_OPTIONS="--init-file $tmp" - options="(with bash completion)" - fi -fi - -# if we got a command, run it, else start a shell -if test ! -z "$1"; -then - $@ - exit $? -fi - -# set up prompt to help us remember we're in a subshell, cd to -# the base directory and start $SHELL -cd $BASEDIR -shell=$SHELL -if test "x$SHELL" == "x/bin/bash" -then - # debian/ubuntu resets our PS1. bastards. - if test -e /etc/debian_version - then - SHELL_OPTIONS="$SHELL_OPTIONS --noprofile" - fi -fi -echo Entering interactive $PROJECT shell $SHELL $options -PS1="[$PROJECT-$VERSION] $PS1" $SHELL $SHELL_OPTIONS - -if test ! -z "$tmp" -then - rm $tmp -fi -echo Thank you for using $PROJECT.