Merge lp:~qcxhome/pyflakes/pyflakes-options--exclude into lp:pyflakes

[Chenxiong Qi]

Hi Team,

To exclude some files or directories is more useful. In some cases, a django-based project might have directory named migrations to track models' changes, and test code within tests/ or tests.py. All these files and directories are not necessary to be checked with pyflakes. Without option --exclude, user has to specify all other files and directories that must be checked. It's not very convenient. Hope this commit be useful to pyflakes' users.

Regards,
Chenxiong Qi

[lp:~qcxhome/pyflakes/pyflakes-options--exclude]

109. By Chenxiong Qi on 2013-08-17

change to help text of exclude option

Unmerged revisions

109. By Chenxiong Qi on 2013-08-17

change to help text of exclude option

108. By Chenxiong Qi on 2013-08-16

add --exclude option

=== modified file 'pyflakes/api.py'
--- pyflakes/api.py	2013-04-21 09:32:10 +0000
+++ pyflakes/api.py	2013-08-17 03:26:51 +0000
@@ -104,7 +104,14 @@
             yield path
 
 
-def checkRecursive(paths, reporter):
+def is_path_excluded(path, exclude_patterns):
+    if exclude_patterns is None:
+        return False
+    result = set(exclude_patterns) & set(path.split(os.sep))
+    return len(result) > 0
+
+
+def checkRecursive(paths, reporter, options):
     """
     Recursively check all source files in C{paths}.
 
@@ -112,20 +119,48 @@
         containing Python source files.
     @param reporter: A L{Reporter} where all of the warnings and errors
         will be reported to.
+    @param options: options passed in the command line.
     @return: The number of warnings found.
     """
     warnings = 0
+    patterns = options.exclude_patterns
     for sourcePath in iterSourceCode(paths):
-        warnings += checkPath(sourcePath, reporter)
+        if not is_path_excluded(sourcePath, patterns):
+            warnings += checkPath(sourcePath, reporter)
     return warnings
 
 
+def build_options_parser(prog, version):
+    parser = OptionParser(prog=prog, version=version)
+    parser.add_option('--exclude', action='store',
+                      metavar='patterns', dest='exclude_patterns',
+                      help='exclude files or directories which match patterns '
+                           'separated by comma. Specify the basename instead '
+                           'of relative or absolute path. (default: '
+                           '.svn,CVS,.bzr,.hg,.git)')
+    return parser
+
+
+def clean_options(options):
+    patterns = options.exclude_patterns
+    default_patterns = ['.svn', 'CVS', '.bzr', '.hg', '.git']
+    if patterns is not None:
+        options.exclude_patterns = default_patterns + patterns.split(',')
+
+
+def parse_args(prog, version):
+    parser = build_options_parser(prog=prog, version=version)
+    opts, args = parser.parse_args()
+    clean_options(opts)
+    return opts, args
+
+
 def main(prog=None):
-    parser = OptionParser(prog=prog, version=__version__)
-    __, args = parser.parse_args()
+    opts, args = parse_args(prog=prog, version=__version__)
+
     reporter = modReporter._makeDefaultReporter()
     if args:
-        warnings = checkRecursive(args, reporter)
+        warnings = checkRecursive(args, reporter, opts)
     else:
         warnings = check(sys.stdin.read(), '<stdin>', reporter)
     raise SystemExit(warnings > 0)