← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

  • Committer: Martin Pool
  • Date: 2011-06-13 22:10:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5986.
  • Revision ID: mbp@canonical.com-20110613221004-fbxg2mzfe6i1pdu1
Make test_source actually comply with pep8 itself

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
They are useful for testing code quality, checking coverage metric etc.
20
20
"""
21
21
 
22
 
# import system imports here
23
22
import os
24
23
import parser
25
24
import re
27
26
import sys
28
27
import token
29
28
 
30
 
#import bzrlib specific imports here
31
29
from bzrlib import (
32
30
    osutils,
33
31
    )
113
111
 
114
112
        # Avoid the case when bzrlib is packaged in a zip file
115
113
        if not os.path.isdir(source_dir):
116
 
            raise TestSkipped('Cannot find bzrlib source directory. Expected %s'
117
 
                              % source_dir)
 
114
            raise TestSkipped(
 
115
                'Cannot find bzrlib source directory. Expected %s'
 
116
                % source_dir)
118
117
        return source_dir
119
118
 
120
119
    def get_source_files(self, extensions=None):
154
153
            yield fname, text
155
154
 
156
155
    def is_our_code(self, fname):
157
 
        """Return true if it's a "real" part of bzrlib rather than external code"""
 
156
        """True if it's a "real" part of bzrlib rather than external code"""
158
157
        if '/util/' in fname or '/plugins/' in fname:
159
158
            return False
160
159
        else:
194
193
 
195
194
        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
196
195
        copyright_canonical_re = re.compile(
197
 
            r'# Copyright \(C\) ' # Opening "# Copyright (C)"
198
 
            r'(\d+)(, \d+)*' # Followed by a series of dates
199
 
            r'.*Canonical Ltd' # And containing 'Canonical Ltd'
200
 
            )
 
196
            r'# Copyright \(C\) '  # Opening "# Copyright (C)"
 
197
            r'(\d+)(, \d+)*'       # followed by a series of dates
 
198
            r'.*Canonical Ltd')    # and containing 'Canonical Ltd'.
201
199
 
202
200
        for fname, text in self.get_source_file_contents(
203
201
                extensions=('.py', '.pyx')):
230
228
                        ]
231
229
            for fname, comment in incorrect:
232
230
                help_text.append(fname)
233
 
                help_text.append((' '*4) + comment)
 
231
                help_text.append((' ' * 4) + comment)
234
232
 
235
233
            self.fail('\n'.join(help_text))
236
234
 
269
267
                         " LICENSE_EXCEPTIONS in"
270
268
                         " bzrlib/tests/test_source.py",
271
269
                         "Or add the following text to the beginning:",
272
 
                         gpl_txt
273
 
                        ]
 
270
                         gpl_txt]
274
271
            for fname in incorrect:
275
 
                help_text.append((' '*4) + fname)
 
272
                help_text.append((' ' * 4) + fname)
276
273
 
277
274
            self.fail('\n'.join(help_text))
278
275
 
283
280
            dict_[fname].append(line_no)
284
281
 
285
282
    def _format_message(self, dict_, message):
286
 
        files = ["%s: %s" % (f, ', '.join([str(i+1) for i in lines]))
 
283
        files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
287
284
                for f, lines in dict_.items()]
288
285
        files.sort()
289
286
        return message + '\n\n    %s' % ('\n    '.join(files))
312
309
                if '\t' in line:
313
310
                    self._push_file(tabs, fname, line_no)
314
311
                if not line.endswith('\n') or line.endswith('\r\n'):
315
 
                    if line_no != last_line_no: # not no_newline_at_eof
 
312
                    if line_no != last_line_no:  # not no_newline_at_eof
316
313
                        self._push_file(illegal_newlines, fname, line_no)
317
314
            if not lines[-1].endswith('\n'):
318
315
                no_newline_at_eof.append(fname)
367
364
    def test_extension_exceptions(self):
368
365
        """Extension functions should propagate exceptions.
369
366
 
370
 
        Either they should return an object, have an 'except' clause, or have a
371
 
        "# cannot_raise" to indicate that we've audited them and defined them as not
372
 
        raising exceptions.
 
367
        Either they should return an object, have an 'except' clause, or
 
368
        have a "# cannot_raise" to indicate that we've audited them and
 
369
        defined them as not raising exceptions.
373
370
        """
374
371
        both_exc_and_no_exc = []
375
372
        missing_except = []
377
374
                              r'(api\s+)?class (\w+).*:', re.MULTILINE)
378
375
        extern_class_re = re.compile(r'## extern cdef class (\w+)',
379
376
                                     re.MULTILINE)
380
 
        except_re = re.compile(r'cdef\s+' # start with cdef
381
 
                               r'([\w *]*?)\s*' # this is the return signature
382
 
                               r'(\w+)\s*\(' # the function name
383
 
                               r'[^)]*\)\s*' # parameters
384
 
                               r'(.*)\s*:' # the except clause
385
 
                               r'\s*(#\s*cannot[- _]raise)?' # cannot raise comment
386
 
                              )
 
377
        except_re = re.compile(
 
378
            r'cdef\s+'        # start with cdef
 
379
            r'([\w *]*?)\s*'  # this is the return signature
 
380
            r'(\w+)\s*\('     # the function name
 
381
            r'[^)]*\)\s*'     # parameters
 
382
            r'(.*)\s*:'       # the except clause
 
383
            r'\s*(#\s*cannot[- _]raise)?')  # cannot raise comment
387
384
        for fname, text in self.get_source_file_contents(
388
385
                extensions=('.pyx',)):
389
386
            known_classes = set([m[-1] for m in class_re.findall(text)])
402
399
                    missing_except.append((fname, func))
403
400
        error_msg = []
404
401
        if both_exc_and_no_exc:
405
 
            error_msg.append('The following functions had "cannot raise" comments'
406
 
                             ' but did have an except clause set:')
 
402
            error_msg.append(
 
403
                'The following functions had "cannot raise" comments'
 
404
                ' but did have an except clause set:')
407
405
            for fname, func in both_exc_and_no_exc:
408
406
                error_msg.append('%s:%s' % (fname, func))
409
407
            error_msg.extend(('', ''))
410
408
        if missing_except:
411
 
            error_msg.append('The following functions have fixed return types,'
412
 
                             ' but no except clause.')
413
 
            error_msg.append('Either add an except or append "# cannot_raise".')
 
409
            error_msg.append(
 
410
                'The following functions have fixed return types,'
 
411
                ' but no except clause.')
 
412
            error_msg.append(
 
413
                'Either add an except or append "# cannot_raise".')
414
414
            for fname, func in missing_except:
415
415
                error_msg.append('%s:%s' % (fname, func))
416
416
            error_msg.extend(('', ''))