Make "arc lint" use Flake8. Fix lint errors.

Kannan Goundan · braincore · commit 06dac6c79dd8 · 2016-05-20T10:51:12.000-07:00
Reviewed By: kelkabany
diff --git a/.arc_lib/.gitignore b/.arc_lib/.gitignore
@@ -0,0 +1 @@
+/.phutil_module_cache
diff --git a/.arc_lib/__phutil_library_init__.php b/.arc_lib/__phutil_library_init__.php
@@ -0,0 +1,3 @@
+<?php
+
+phutil_register_library('babel-arcanist-utils', __FILE__);
diff --git a/.arc_lib/__phutil_library_map__.php b/.arc_lib/__phutil_library_map__.php
@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * This file is automatically generated. Use 'arc liberate' to rebuild it.
+ *
+ * @generated
+ * @phutil-library-version 2
+ */
+phutil_register_library_map(array(
+  '__library_version__' => 2,
+  'class' => array(
+    'BabelLintEngine' => 'lint/BabelLintEngine.php',
+  ),
+  'function' => array(),
+  'xmap' => array(
+    'BabelLinter' => 'ArcanistLintEngine',
+  ),
+));
diff --git a/.arc_lib/lint/BabelLintEngine.php b/.arc_lib/lint/BabelLintEngine.php
@@ -0,0 +1,28 @@
+<?php
+
+final class BabelLintEngine extends ArcanistLintEngine {
+
+  public function buildLinters() {
+    $flake8 = new ArcanistFlake8Linter();
+
+    $pythonPaths = array();
+    foreach ($this->getPaths() as $path) {
+      if (!self::endsWith($path, ".py")) continue;  // Only include Python files.
+      if (self::startsWith($path, "example/api/")) continue;  // Old crufty stuff.
+      \array_push($pythonPaths, $path);
+    }
+    $flake8->setPaths($pythonPaths);
+
+    return array(
+      "flake8" => $flake8,
+    );
+  }
+
+  public static function startsWith($haystack, $needle) {
+    return \substr($haystack, 0, strlen($needle)) === $needle;
+  }
+
+  public static function endsWith($haystack, $needle) {
+    return \substr($haystack, \strlen($haystack) - \strlen($needle)) === $needle;
+  }
+}
diff --git a/.arcconfig b/.arcconfig
@@ -3,5 +3,11 @@
   "conduit_uri" : "https://tails.corp.dropbox.com/api/",
   "copyright_holder" : "Dropbox",
   "repository.callsign": "BABEL",
-  "immutable_history": false
+  "immutable_history": false,
+
+  "lint_engine": "BabelLintEngine",
+
+  "phutil_libraries": {
+    "babel-arcanist-utils": ".arc_lib"
+  }
 }
diff --git a/babelapi/babel/lexer.py b/babelapi/babel/lexer.py
@@ -55,10 +55,12 @@ def token(self):
             else:
                 if r is None and self.cur_indent > 0:
                     if self.last_token and self.last_token.type not in ('NEWLINE', 'LINE'):
-                        newline_token = self._create_token('NEWLINE', '\n', self.lex.lineno, self.lex.lexpos)
+                        newline_token = self._create_token('NEWLINE', '\n', self.lex.lineno,
+                                                           self.lex.lexpos)
                         self.tokens_queue.append(newline_token)
                     dedent_count = self.cur_indent / 4
-                    dedent_token = self._create_token('DEDENT', '\t', self.lex.lineno, self.lex.lexpos)
+                    dedent_token = self._create_token('DEDENT', '\t', self.lex.lineno,
+                                                      self.lex.lexpos)
                     self.tokens_queue.extend([dedent_token] * dedent_count)
 
                     self.cur_indent = 0
@@ -90,11 +92,11 @@ def test(self, data):
 
     # List of token names
     tokens = (
-       'ID',
-       'KEYWORD',
-       'PATH',
-       'PIPE',
-       'DOT',
+        'ID',
+        'KEYWORD',
+        'PATH',
+        'PIPE',
+        'DOT',
     )
 
     # Whitespace tokens
@@ -128,8 +130,8 @@ def test(self, data):
 
     # Regular expression rules for simple tokens
     t_DOT = r'\.'
-    t_LPAR  = r'\('
-    t_RPAR  = r'\)'
+    t_LPAR = r'\('
+    t_RPAR = r'\)'
     t_EQ = r'='
     t_COMMA = r','
     t_PIPE = r'\|'
diff --git a/babelapi/babel/parser.py b/babelapi/babel/parser.py
@@ -385,7 +385,10 @@ def p_coverage(self, p):
             p[0] = p[2]
 
     def p_struct(self, p):
-        'struct : STRUCT ID inheritance coverage NEWLINE INDENT docsection field_list example_list DEDENT'
+        """
+        struct : STRUCT ID inheritance coverage NEWLINE \
+                     INDENT docsection field_list example_list DEDENT
+        """
         p[0] = BabelTypeDef(p.lineno(1), p.lexpos(1), p[1], p[2], extends=p[3], coverage=p[4])
         if p[7]:
             p[0].set_doc(p[7])
diff --git a/babelapi/compiler.py b/babelapi/compiler.py
@@ -4,7 +4,6 @@
 import inspect
 import os
 import re
-import sys
 import shutil
 
 from babelapi.generator import Generator
diff --git a/babelapi/data_type.py b/babelapi/data_type.py
@@ -642,7 +642,7 @@ def get_example(self, label):
                         raise Exception('No example with label %r for subtype '
                                         '%r' % (label, field.data_type.name))
                 elif (isinstance(field.data_type, List) and
-                          isinstance(field.data_type.data_type, CompositeType)):
+                        isinstance(field.data_type.data_type, CompositeType)):
                     example_copy[field.name] = [field.data_type.data_type.get_example(label)]
             return example_copy
 
@@ -704,9 +704,8 @@ def has_example(self, label):
     def get_example(self, label):
         for field in self.fields:
             if (isinstance(field, Field)
-                and isinstance(field.data_type, CompositeType)
-                and field.data_type.has_example(label)):
-
+                    and isinstance(field.data_type, CompositeType)
+                    and field.data_type.has_example(label)):
                 return {field.name: field.data_type.get_example(label)}
         else:
             # Fallback to checking for direct symbols
diff --git a/babelapi/lang/ruby.py b/babelapi/lang/ruby.py
@@ -40,7 +40,8 @@ def format_type(self, data_type):
         return RubyTargetLanguage._type_table.get(data_type.__class__, data_type.name)
 
     def format_obj(self, o):
-        assert not isinstance(o, dict), "Bad argument to format_obj: pprint's dict formatting is not valid Ruby."
+        assert not isinstance(o, dict), \
+            "Bad argument to format_obj: pprint's dict formatting is not valid Ruby."
         if o is True:
             return 'true'
         if o is False:
diff --git a/example/generator/dropbox-python-sdk/dbx_python_json.babelg.py b/example/generator/dropbox-python-sdk/dbx_python_json.babelg.py
@@ -8,23 +8,13 @@
 
 import re
 from babelapi.data_type import (
-    Binary,
-    Boolean,
     CompositeType,
-    Float32,
-    Float64,
-    Field,
     Int32,
     Int64,
-    List,
-    Null,
     String,
-    Struct,
     SymbolField,
-    Timestamp,
     UInt32,
     UInt64,
-    Union,
 )
 from babelapi.data_type import (
     is_composite_type,
@@ -291,7 +281,7 @@ def _generate_struct_class_init(self, data_type):
             if data_type.fields:
                 for field in data_type.fields:
                     if (is_union_type(field.data_type)
-                        and field.data_type.unique_field_data_types()):
+                            and field.data_type.unique_field_data_types()):
 
                         # This is an optimization for the developer experience.
                         # Without optimzation, the developer needs to instantiate a
@@ -331,10 +321,10 @@ def _generate_struct_class_init(self, data_type):
                                     ))
                         self.emit_empty_line()
                     else:
-                        assert_type = "assert isinstance({0}, {1}), '{0} must be of type {1}'".format(
-                            field.name,
-                            self._is_instance_type(field.data_type),
-                        )
+                        assert_type = ("assert isinstance({0}, {1}), '{0} must be of type {1}'"
+                            .format(
+                                field.name,
+                                self._is_instance_type(field.data_type)))
                         if field.nullable or field.optional:
                             # We conflate nullability and optionality in Python
                             self.emit_line('if {} is not None:'.format(field.name))
@@ -406,7 +396,6 @@ def _generate_struct_class_to_json(self, data_type):
             self.emit_line('return d')
         self.emit_empty_line()
 
-
     def _class_name_for_data_type(self, data_type):
         return self.lang.format_class(data_type.name)
 
@@ -471,8 +460,9 @@ def _generate_union_class(self, data_type):
                 if isinstance(field, SymbolField):
                     self.emit_line('{} = object()'.format(self.lang.format_class(field.name)))
                 elif is_composite_type(field.data_type):
-                    self.emit_line('{0} = {1}'.format(self.lang.format_class(field.name),
-                                                      self._class_name_for_data_type(field.data_type)))
+                    self.emit_line('{0} = {1}'.format(
+                        self.lang.format_class(field.name),
+                        self._class_name_for_data_type(field.data_type)))
                 else:
                     raise ValueError('Only symbols and composite types for union fields.')
             self.emit_empty_line()
@@ -513,16 +503,16 @@ def _generate_union_class_init(self, data_type):
 
                 for field in data_type.fields:
                     if not isinstance(field, SymbolField):
-                        assert_type = "assert isinstance({0}, {1}), '{0} must be of type {1}'".format(
-                            field.name,
-                            self._is_instance_type(field.data_type),
-                        )
+                        assert_type = ("assert isinstance({0}, {1}), '{0} must be of type {1}'"
+                            .format(
+                                field.name,
+                                self._is_instance_type(field.data_type)))
                     else:
-                        assert_type = "assert isinstance({0}, {1}), '{0} must be of type {2}'".format(
-                            field.name,
-                            'bool',
-                            'bool',
-                        )
+                        assert_type = ("assert isinstance({0}, {1}), '{0} must be of type {2}'"
+                            .format(
+                                field.name,
+                                'bool',
+                                'bool'))
                     self.emit_line('if {} is not None:'.format(field.name))
                     with self.indent():
                         self.emit_line(assert_type)
@@ -706,7 +696,8 @@ def _generate_route_download_to_file(self, namespace, route):
         with self.indent():
             extra_request_args = None
             if response_binary_body:
-                extra_request_args = [('download_path', 'str', 'Path on local machine to save file.')]
+                extra_request_args = [
+                    ('download_path', 'str', 'Path on local machine to save file.')]
             self._generate_docstring_for_func(
                 request_data_type,
                 response_data_type,
diff --git a/example/generator/unbabel/unbabel.babelg.py b/example/generator/unbabel/unbabel.babelg.py
@@ -100,7 +100,7 @@ def generate_route(self, route):
         (List, ['data_type', 'min_items', 'max_items']),
         (String, ['min_length', 'max_length', 'pattern']),
         (Timestamp, ['format']),
-        ]
+    ]
 
     def format_data_type(self, data_type):
         """Helper function to format a data type.
diff --git a/generator/python/babel_serializers.py b/generator/python/babel_serializers.py
@@ -195,7 +195,7 @@ def _json_decode_helper(data_type, obj, strict, validate_primitives=True):
                 setattr(o, name, v)
         data_type.validate(o)
     elif isinstance(data_type, bv.Union):
-        val = None # Symbols do not have values
+        val = None  # Symbols do not have values
         if isinstance(obj, six.string_types):
             # Variant is a symbol
             tag = obj
diff --git a/generator/python/python.babelg.py b/generator/python/python.babelg.py
@@ -217,7 +217,7 @@ def _determine_validator_type(self, data_type):
         the appropriate validation object in Python.
         """
         if is_list_type(data_type):
-            v ='bv.List({})'.format(
+            v = 'bv.List({})'.format(
                 self._func_args_from_dict({
                     'item_validator': self._determine_validator_type(data_type.data_type),
                     'min_items': data_type.min_items,
@@ -654,7 +654,8 @@ def _generate_routes(self, namespace):
                 self.emit('{!r}: ({!r}, bv.FunctionSignature('.format(route.name, host_ident))
                 with self.indent():
                     self.emit('bv.FunctionStyle.{},'.format(style_enum))
-                    for t in (route.request_data_type, route.response_data_type, route.error_data_type):
+                    for t in (route.request_data_type, route.response_data_type,
+                              route.error_data_type):
                         self.emit('{},'.format(self._determine_validator_type(t)))
                 self.emit(')),')
         self.emit('}')
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[flake8]
+ignore = E128,E226,E301,E302,E127,E701,E231
diff --git a/setup.py b/setup.py
@@ -21,8 +21,8 @@
               'babelapi.babel',
               'babelapi.lang'],
     long_description=open('README.rst').read(),
-    platforms=['CPython 2.6', 'CPython 2.7'],      
-    entry_points = {
+    platforms=['CPython 2.6', 'CPython 2.7'],
+    entry_points={
         'console_scripts': ['babelapi=babelapi.cli:main'],
     },
     classifiers=[
@@ -34,5 +34,5 @@
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Topic :: Software Development :: Libraries :: Python Modules',
-        ],
+    ],
 )
diff --git a/test/test_babel_internal.py b/test/test_babel_internal.py
@@ -169,7 +169,7 @@ def test_float(self):
         self.assertIn('is greater than', cm.exception.args[0])
 
         with self.assertRaises(ParameterError) as cm:
-             Float64(min_value=0, max_value=10**330)
+            Float64(min_value=0, max_value=10**330)
         self.assertIn('too large for a float', cm.exception.args[0])
 
         with self.assertRaises(ParameterError) as cm:
@@ -197,8 +197,8 @@ def test_struct(self):
             'QuotaInfo',
             "Information about a user's space quota.",
             [
-             StructField('quota', UInt64(), 'Total amount of space.'),
-             ],
+                StructField('quota', UInt64(), 'Total amount of space.'),
+            ],
         )
 
         # add a example that doesn't fit the definition of a struct
@@ -222,8 +222,8 @@ def test_struct(self):
             'AccountInfo',
             "Information about an account.",
             [
-             StructField('account_id', String(), 'Unique identifier for account.'),
-             StructField('quota_info', quota_info, 'Quota')
+                StructField('account_id', String(), 'Unique identifier for account.'),
+                StructField('quota_info', quota_info, 'Quota')
             ],
         )
 
@@ -249,7 +249,8 @@ def test_union(self):
             'Policy for managing write conflicts.',
             [
                 UnionField('reject', Symbol(), 'On a write conflict, reject the new file.'),
-                UnionField('overwrite', Symbol(), 'On a write conflict, overwrite the existing file.'),
+                UnionField('overwrite', Symbol(),
+                           'On a write conflict, overwrite the existing file.'),
                 UnionField('update_if_matching_parent_rev',
                       update_parent_rev,
                       'On a write conflict, overwrite the existing file.'),

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<?php`
	`2`	`+`
	`3`	`+phutil_register_library('babel-arcanist-utils', __FILE__);`