Merge ~jugmac00/lazr.restful:add-pre-commit into lazr.restful:main

[Jürgen Gmach]

Add basic pre-commit configuration

flake8 was added as a hook, but some formatting issues were not touched, as they will be fixed when we use black.

Three more warnings were also not touched. Fixing these would result in a changed code/test meaning, which needs some more attention at a later time.

[Colin Watson (cjwatson)]

review: Approve

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..45fd4ba
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,15 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-ast
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: debug-statements
+-   repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
+    hooks:
+    -   id: flake8
diff --git a/NEWS.rst b/NEWS.rst
index 4245130..9a03a7e 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -6,6 +6,7 @@ NEWS for lazr.restful
 =====
 
 - Add support for Python 3.9 and 3.10.
+- Add basic pre-commit configuration.
 
 1.1.0 (2021-10-07)
 ==================
diff --git a/setup.py b/setup.py
index 29508ad..4fc49fc 100755
--- a/setup.py
+++ b/setup.py
@@ -18,6 +18,7 @@
 
 from setuptools import setup, find_packages
 
+
 # generic helpers primarily for the long_description
 def generate(*docname_or_string):
     res = []
@@ -32,6 +33,7 @@ def generate(*docname_or_string):
     return '\n'.join(res)
 # end generic helpers
 
+
 setup(
     name='lazr.restful',
     version='1.1.0',
@@ -99,7 +101,7 @@ setup(
     extras_require=dict(
         docs=['Sphinx'],
         test=['zope.testing>=4.6.0'],
-        xml=['lxml',] # requiring this of normal users is too much
+        xml=['lxml',]  # requiring this of normal users is too much
     ),
     test_suite='lazr.restful.tests',
     )
diff --git a/src/lazr/restful/__init__.py b/src/lazr/restful/__init__.py
index c8d4916..54321dc 100644
--- a/src/lazr/restful/__init__.py
+++ b/src/lazr/restful/__init__.py
@@ -32,11 +32,11 @@ try:
     # While we generally frown on "*" imports, this approach, combined with
     # the fact we only test code from this module, means that we can verify
     # what has been exported in the local files (DRY).
-    from lazr.restful._bytestorage import *
+    from lazr.restful._bytestorage import *  # noqa: F401, F403
     from lazr.restful._bytestorage import __all__ as _bytestorage_all
-    from lazr.restful._operation import *
+    from lazr.restful._operation import *  # noqa: F401, F403
     from lazr.restful._operation import __all__ as _operation_all
-    from lazr.restful._resource import *
+    from lazr.restful._resource import *  # noqa: F401, F403
     from lazr.restful._resource import __all__ as _resource_all
     __all__ = []
     __all__.extend(_bytestorage_all)
diff --git a/src/lazr/restful/_operation.py b/src/lazr/restful/_operation.py
index ee1eee5..fc7c037 100644
--- a/src/lazr/restful/_operation.py
+++ b/src/lazr/restful/_operation.py
@@ -157,7 +157,7 @@ class ResourceOperation(BatchingResourceMixin):
             return False
 
         try:
-            iterator = iter(result)
+            iter(result)
             # Objects that have iterators but aren't ordinary data structures
             # tend to be result-set objects. Batch them.
             return True
diff --git a/src/lazr/restful/_resource.py b/src/lazr/restful/_resource.py
index e12f5e3..0b411e8 100644
--- a/src/lazr/restful/_resource.py
+++ b/src/lazr/restful/_resource.py
@@ -45,8 +45,8 @@ try:
     import hashlib
     sha_constructor = hashlib.sha1
 except ImportError:
-     import sha
-     sha_constructor = sha.new
+    import sha
+    sha_constructor = sha.new
 
 try:
     from html import escape
@@ -150,7 +150,7 @@ CLOSEUP_DETAIL = object()
 # bug=https://bugs.edge.launchpad.net/zope3/+bug/322486:
 # Add nonstandard status methods to Zope's status_reasons dictionary.
 for code, reason in [(209, 'Content Returned')]:
-    if not code in status_reasons:
+    if code not in status_reasons:
         status_reasons[code] = reason
 init_status_codes()
 
@@ -314,7 +314,7 @@ class HTTPResource:
 
         :return: The HTTP method to use.
         """
-        if request == None:
+        if request is None:
             request = self.request
         override = request.headers.get('X-HTTP-Method-Override')
         if override is not None and request.method == 'POST':
@@ -344,7 +344,7 @@ class HTTPResource:
             if existing_etag in incoming_etags:
                 # The client already has this representation.
                 # No need to send it again.
-                self.request.response.setStatus(304) # Not Modified
+                self.request.response.setStatus(304)  # Not Modified
                 media_type = None
         return media_type
 
@@ -617,7 +617,6 @@ class BatchingResourceMixin:
 
         return simplejson.dumps(len(entries))
 
-
     def batch(self, entries, request):
         """Prepare a batch from a (possibly huge) list of entries.
 
@@ -645,7 +644,7 @@ class BatchingResourceMixin:
         navigator = WebServiceBatchNavigator(entries, request)
 
         view_permission = getUtility(IWebServiceConfiguration).view_permission
-        batch = { 'start' : navigator.batch.start }
+        batch = {'start': navigator.batch.start}
         # If this is the last batch, then total() is easy to
         # calculate. Let's use it and save the client from having to
         # ask for the total size of the collection.
@@ -990,7 +989,7 @@ class EntryHTMLView:
         namespace = self.HTML_TEMPLATE.pt_getContext()
         names_and_values = self.resource.toDataStructure(
             HTTPResource.XHTML_TYPE).items()
-        data = [{'name' : name, 'value': decode_value(value)}
+        data = [{'name': name, 'value': decode_value(value)}
                 for name, value in names_and_values]
         namespace['context'] = sorted(data, key=itemgetter('name'))
         return self.HTML_TEMPLATE.pt_render(namespace)
@@ -1076,7 +1075,7 @@ class EntryManipulatingResource(ReadWriteResource):
             marshaller = getMultiAdapter((field, self.request),
                                          IFieldMarshaller)
             repr_name = marshaller.representation_name
-            if not repr_name in changeset:
+            if repr_name not in changeset:
                 # The client didn't try to set a value for this field.
                 continue
 
@@ -1146,7 +1145,7 @@ class EntryManipulatingResource(ReadWriteResource):
                 # ObjectLookupFieldMarshaller, once we make it
                 # possible for Vocabulary fields to specify a schema
                 # class the way IReference fields can.
-                if value != None and not field.schema.providedBy(value):
+                if value is not None and not field.schema.providedBy(value):
                     errors.append(u"%s: Your value points to the "
                                    "wrong kind of object" % repr_name)
                     continue
@@ -1183,7 +1182,7 @@ class EntryManipulatingResource(ReadWriteResource):
                         error = "Constraint not satisfied."
                     errors.append(u"%s: %s" % (repr_name, error))
                     continue
-                except RequiredMissing as e:
+                except RequiredMissing:
                     error = "Missing required value."
                     errors.append(u"%s: %s" % (repr_name, error))
                 except (ValueError, ValidationError) as e:
@@ -1306,7 +1305,7 @@ class EntryFieldResource(FieldUnmarshallerMixin, EntryManipulatingResource):
         value, error = self.processAsJSONDocument(media_type, representation)
         if value is None:
             return value, error
-        changeset = {self.context.name : value}
+        changeset = {self.context.name: value}
         return self.applyChanges(changeset, media_type)
 
     do_PATCH = do_PUT
@@ -1367,6 +1366,7 @@ class EntryFieldURL(AbsoluteURL):
         self.context = entryfield
         self.request = request
 
+
 def make_entry_etag_cores(field_details):
     """Given the details of an entry's fields, calculate its ETag cores.
 
@@ -1390,7 +1390,6 @@ def make_entry_etag_cores(field_details):
     return [unwritable, writable]
 
 
-
 @implementer(IEntryResource, IJSONPublishable)
 class EntryResource(CustomOperationResourceMixin,
                     FieldUnmarshallerMixin, EntryManipulatingResource):
@@ -1465,7 +1464,6 @@ class EntryResource(CustomOperationResourceMixin,
         existing_write_portion = extract_write_portion(existing_etag)
         return existing_write_portion in incoming_write_portions
 
-
     def toDataForJSON(self, media_type=None):
         """Turn the object into a simple data structure."""
         return self.toDataStructure(media_type or self.JSON_TYPE)
@@ -1612,7 +1610,6 @@ class EntryResource(CustomOperationResourceMixin,
 
         return self.applyChanges(changeset, media_type)
 
-
     def do_PATCH(self, media_type, representation):
         """Apply a JSON patch to the entry."""
         changeset, error = self.processAsJSONHash(media_type, representation)
@@ -1629,7 +1626,6 @@ class EntryResource(CustomOperationResourceMixin,
         if cache is not None:
             cache.delete(self.context)
 
-
     @property
     def type_url(self):
         """The URL to the resource type for this resource."""
@@ -1643,7 +1639,6 @@ class EntryResource(CustomOperationResourceMixin,
         """An EntryAdapterUtility for this resource."""
         return EntryAdapterUtility(self.entry.__class__)
 
-
     @property
     def redacted_fields(self):
         """Names the fields the current user doesn't have permission to see."""
@@ -1991,7 +1986,7 @@ class ServiceRootResource(HTTPResource):
                         # directly, it will always show up in
                         # providedBy(self.request).
                         continue
-                    if not version_marker in providedBy(self.request):
+                    if version_marker not in providedBy(self.request):
                         continue
 
                     # Make sure that no other entry class is using this
@@ -2042,7 +2037,7 @@ class ServiceRootResource(HTTPResource):
                 self.request.publication.getApplication(self.request),
                 self.request),
             "service-root")
-        data_for_json = {'resource_type_link' : type_url}
+        data_for_json = {'resource_type_link': type_url}
         publications = self.getTopLevelPublications()
         for link_name, publication in publications.items():
             data_for_json[link_name] = absoluteURL(publication,
@@ -2326,9 +2321,8 @@ def get_entry_fields_in_write_order(entry):
         # it at the end -- it's probably controlled by a mutator.
         implementation = field_implementations[name]
         if (issubclass(implementation.__class__, Passthrough)
-            and not implementation.__class__ is Passthrough):
+            and implementation.__class__ is not Passthrough):
             mutator_fields.append((name, field))
         else:
             non_mutator_fields.append((name, field))
     return non_mutator_fields + mutator_fields
-
diff --git a/src/lazr/restful/declarations.py b/src/lazr/restful/declarations.py
index fa13b30..f1529de 100644
--- a/src/lazr/restful/declarations.py
+++ b/src/lazr/restful/declarations.py
@@ -234,7 +234,7 @@ def _export_as_webservice_entry(interface,
             # no 'as' is specified. Also set 'original_name' for every
             # version in which the field is published--this will help with
             # performance optimizations around permission checks.
-            if tags.get('exported') != False:
+            if tags.get('exported') is not False:
                 tags['original_name'] = name
                 if tags.get('as') is None:
                     tags['as'] = name
@@ -397,7 +397,7 @@ def exported(field, *versioned_annotations, **kwparams):
     # the VersionedDict.
     for (key, annotation_key) in annotation_key_for_argument_key.items():
         if key in kwparams:
-            if (key == "exported" and kwparams[key] == False
+            if (key == "exported" and kwparams[key] is False
                 and first_version_name is not None):
                 raise ValueError(
                     ("as_of=%s says to export %s, but exported=False "
@@ -561,6 +561,7 @@ class collection_default_content:
 
 WEBSERVICE_ERROR = '__lazr_webservice_error__'
 
+
 def webservice_error(status):
     """Mark the exception with the HTTP status code to use.
 
@@ -604,6 +605,7 @@ def error_status(status):
     validation, its specified status won't propagate to the response.
     """
     status = int(status)
+
     def func(value):
         if not issubclass(value, Exception):
             raise TypeError('Annotated value must be an exception class.')
@@ -668,7 +670,7 @@ class _method_annotator:
         The annotations will copied to the lazr.webservice.exported tag
         by a class advisor.
         """
-        raise NotImplemented
+        raise NotImplementedError
 
 
 def annotate_exported_methods(interface):
@@ -743,7 +745,7 @@ def _update_default_and_required_params(params, method_info):
             # string.
             if (six.PY2 and
                     isinstance(default, str) and IText.providedBy(param_def)):
-                default = unicode(default)
+                default = unicode(default)  # noqa: F821
             param_def.default = default
             param_def.required = False
         elif name in required and param_def.default is not None:
@@ -891,6 +893,7 @@ class operation_removed_in_version(operation_for_version):
         # version from a method that was incompletely annotated.
         annotations['type'] = REMOVED_OPERATION_TYPE
 
+
 class export_operation_as(_method_annotator):
     """Decorator specifying the name to export the method as."""
 
diff --git a/src/lazr/restful/directives/__init__.py b/src/lazr/restful/directives/__init__.py
index 527c332..c695ea7 100644
--- a/src/lazr/restful/directives/__init__.py
+++ b/src/lazr/restful/directives/__init__.py
@@ -7,7 +7,8 @@ from __future__ import absolute_import, print_function
 __metaclass__ = type
 __all__ = ['request_class',
            'publication_class',
-           'settings',]
+           'settings',
+]
 
 import martian
 from zope.component import getSiteManager
@@ -71,6 +72,7 @@ class ConfigurationGrokker(martian.ClassGrokker):
     martian.component(BaseWebServiceConfiguration)
     martian.directive(request_class)
     martian.directive(publication_class)
+
     def execute(self, cls, config, request_class,
                 publication_class, *kw):
         # If implementations of the IWebServiceConfiguration methods are
@@ -114,6 +116,7 @@ class ConfigurationGrokker(martian.ClassGrokker):
 class ServiceRootGrokker(martian.ClassGrokker):
     """Registers your service root as a singleton object."""
     martian.component(ServiceRootResource)
+
     def execute(self, cls, config, *kw):
         getSiteManager().registerUtility(cls(), IServiceRootResource)
         return True
@@ -126,6 +129,7 @@ class RootResourceAbsoluteURLGrokker(martian.ClassGrokker):
     RootResourceAbsoluteURL.
     """
     martian.component(RootResourceAbsoluteURL)
+
     def execute(self, cls, config, *kw):
         getSiteManager().registerAdapter(cls)
         return True
@@ -149,6 +153,7 @@ class AbsoluteURLGrokker(martian.ClassGrokker):
     """
     martian.component(AbsoluteURL)
     martian.directive(location_interface)
+
     def execute(self, cls, config, location_interface, *kw):
         getSiteManager().registerAdapter(
             cls, (location_interface, IWebServiceLayer), IAbsoluteURL)
diff --git a/src/lazr/restful/docs/conf.py b/src/lazr/restful/docs/conf.py
index 59f6e02..e1cdf5d 100644
--- a/src/lazr/restful/docs/conf.py
+++ b/src/lazr/restful/docs/conf.py
@@ -165,6 +165,3 @@ texinfo_documents = [
      author, 'lazrrestful', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-
diff --git a/src/lazr/restful/error.py b/src/lazr/restful/error.py
index 059cd6a..389c2b8 100644
--- a/src/lazr/restful/error.py
+++ b/src/lazr/restful/error.py
@@ -26,6 +26,7 @@ try:
     from zope.app.exception.interfaces import ISystemErrorView
 except ImportError:
     from zope.interface import Interface
+
     class ISystemErrorView(Interface):
         """Error views that can classify their contexts as system errors
         """
diff --git a/src/lazr/restful/example/base/filemanager.py b/src/lazr/restful/example/base/filemanager.py
index 7b1120a..8e03049 100644
--- a/src/lazr/restful/example/base/filemanager.py
+++ b/src/lazr/restful/example/base/filemanager.py
@@ -14,8 +14,8 @@ try:
     import hashlib
     sha_constructor = hashlib.sha1
 except ImportError:
-     import sha
-     sha_constructor = sha.new
+    import sha
+    sha_constructor = sha.new
 
 from zope.interface import implementer
 
@@ -50,6 +50,8 @@ class FileManager:
         """See `IFileManager`."""
         if key in self.files:
             del self.files[key]
+
+
 grokcore.component.global_utility(FileManager)
 
 
diff --git a/src/lazr/restful/example/base/root.py b/src/lazr/restful/example/base/root.py
index c1a053d..197d5df 100644
--- a/src/lazr/restful/example/base/root.py
+++ b/src/lazr/restful/example/base/root.py
@@ -34,7 +34,7 @@ from lazr.restful.testing.webservice import WebServiceTestPublication
 from lazr.restful.utils import get_current_web_service_request
 
 
-#Entry classes.
+# Entry classes.
 class CookbookWebServiceObject:
     """A basic object published through the web service."""
 
@@ -199,6 +199,7 @@ class Recipe(CookbookWebServiceObject):
     def delete(self):
         getUtility(IRecipeSet).removeRecipe(self)
 
+
 # Top-level objects.
 @implementer(ILocation)
 class CookbookTopLevelObject(CookbookWebServiceObject,
@@ -338,6 +339,7 @@ def year(year):
     """Turn a year into a datetime.date object."""
     return date(year, 1, 1)
 
+
 C1 = Cookbook(u"Mastering the Art of French Cooking", "", Cuisine.FRANCAISE,
               year(1961))
 C2 = Cookbook(u"The Joy of Cooking", "", Cuisine.GENERAL, year(1995),
@@ -379,8 +381,8 @@ class CookbookServiceRootResource(ServiceRootResource):
     def top_level_names(self):
         """Access or create the list of top-level objects."""
         return {'cookbooks': getUtility(ICookbookSet),
-                'dishes' : getUtility(IDishSet),
-                'recipes' : getUtility(IRecipeSet),
+                'dishes': getUtility(IDishSet),
+                'recipes': getUtility(IRecipeSet),
                 'filemanager': getUtility(IFileManager)}
 
     def get(self, name):
@@ -388,8 +390,8 @@ class CookbookServiceRootResource(ServiceRootResource):
         obj = self.top_level_names.get(name)
         return obj
 
-# Define the web service configuration.
 
+# Define the web service configuration.
 class WebServiceConfiguration(BaseWebServiceConfiguration):
     directives.publication_class(WebServiceTestPublication)
     caching_policy = [10000, 2]
@@ -400,7 +402,7 @@ class WebServiceConfiguration(BaseWebServiceConfiguration):
     active_versions = ['1.0', 'devel']
     service_description = """<p>This is a web service.</p>
     <p>It's got resources!</p>"""
-    version_descriptions = { 'devel' : """<p>The unstable development
+    version_descriptions = {'devel': """<p>The unstable development
     version.</p>
 
     <p>Don't use this unless you like changing things.</p>"""
@@ -409,4 +411,3 @@ class WebServiceConfiguration(BaseWebServiceConfiguration):
     first_version_with_total_size_link = None
     use_https = False
     view_permission = 'lazr.restful.example.base.View'
-
diff --git a/src/lazr/restful/example/base/security.py b/src/lazr/restful/example/base/security.py
index 7a1b85f..50354ba 100644
--- a/src/lazr/restful/example/base/security.py
+++ b/src/lazr/restful/example/base/security.py
@@ -30,4 +30,3 @@ class CookbookWebServiceSecurityPolicy(PermissiveSecurityPolicy):
             return False
         else:
             return True
-
diff --git a/src/lazr/restful/example/base/subscribers.py b/src/lazr/restful/example/base/subscribers.py
index b2b0b1d..78daffe 100644
--- a/src/lazr/restful/example/base/subscribers.py
+++ b/src/lazr/restful/example/base/subscribers.py
@@ -11,6 +11,7 @@ import grokcore.component
 from lazr.lifecycle.interfaces import IObjectModifiedEvent
 from lazr.restful.example.base.interfaces import ICookbook
 
+
 @grokcore.component.subscribe(ICookbook, IObjectModifiedEvent)
 def update_cookbook_revision_number(object, event):
     """Increment ICookbook.revision_number."""
diff --git a/src/lazr/restful/example/base/tests/test_integration.py b/src/lazr/restful/example/base/tests/test_integration.py
index d6de481..cec645d 100644
--- a/src/lazr/restful/example/base/tests/test_integration.py
+++ b/src/lazr/restful/example/base/tests/test_integration.py
@@ -36,6 +36,8 @@ checker = renormalizing.OutputChecker()
 class FunctionalLayer:
     allow_teardown = False
     zcml = os.path.abspath(resource_filename('lazr.restful', 'ftesting.zcml'))
+
+
 zcml_layer(FunctionalLayer)
 
 
@@ -43,6 +45,8 @@ class WSGILayer(FunctionalLayer):
     @classmethod
     def make_application(self):
         return WebServiceApplication({}, CookbookWebServiceTestPublication)
+
+
 wsgi_intercept_layer(WSGILayer)
 
 
diff --git a/src/lazr/restful/example/base_extended/tests/test_integration.py b/src/lazr/restful/example/base_extended/tests/test_integration.py
index 0732c8a..5235b28 100644
--- a/src/lazr/restful/example/base_extended/tests/test_integration.py
+++ b/src/lazr/restful/example/base_extended/tests/test_integration.py
@@ -26,6 +26,8 @@ class FunctionalLayer:
     allow_teardown = False
     zcml = os.path.abspath(resource_filename(
         'lazr.restful.example.base_extended', 'site.zcml'))
+
+
 zcml_layer(FunctionalLayer)
 
 
@@ -33,6 +35,8 @@ class WSGILayer(FunctionalLayer):
     @classmethod
     def make_application(self):
         return WebServiceApplication({}, CookbookWebServiceTestPublication)
+
+
 wsgi_intercept_layer(WSGILayer)
 
 
diff --git a/src/lazr/restful/example/multiversion/resources.py b/src/lazr/restful/example/multiversion/resources.py
index 693954d..bd1fb94 100644
--- a/src/lazr/restful/example/multiversion/resources.py
+++ b/src/lazr/restful/example/multiversion/resources.py
@@ -45,6 +45,7 @@ class IKeyValuePair(ILocation):
     deleted = exported(Bool(title=u"Whether this key-value pair has been "
                             "deleted"),
                        ('3.0', dict(exported=True)), exported=False)
+
     @mutator_for(a_comment)
     @export_write_operation()
     @operation_parameters(comment=Text())
diff --git a/src/lazr/restful/example/multiversion/root.py b/src/lazr/restful/example/multiversion/root.py
index 7447972..11452df 100644
--- a/src/lazr/restful/example/multiversion/root.py
+++ b/src/lazr/restful/example/multiversion/root.py
@@ -58,4 +58,3 @@ class MultiversionWebServiceRootResource(RootResource):
             ]
         collections = dict(pairs=(IKeyValuePair, pairset))
         return collections, {}
-
diff --git a/src/lazr/restful/example/multiversion/tests/test_integration.py b/src/lazr/restful/example/multiversion/tests/test_integration.py
index dac7bbb..1c4e58b 100644
--- a/src/lazr/restful/example/multiversion/tests/test_integration.py
+++ b/src/lazr/restful/example/multiversion/tests/test_integration.py
@@ -34,6 +34,8 @@ checker = renormalizing.OutputChecker()
 class FunctionalLayer:
     zcml = os.path.abspath(resource_filename(
         'lazr.restful.example.multiversion', 'site.zcml'))
+
+
 zcml_layer(FunctionalLayer)
 
 
@@ -45,6 +47,8 @@ class WSGILayer(FunctionalLayer):
         getUtility(IWebServiceConfiguration).port = None
         root = MultiversionWebServiceRootResource()
         return WebServiceApplication(root, Publication)
+
+
 wsgi_intercept_layer(WSGILayer)
 
 
diff --git a/src/lazr/restful/example/wsgi/root.py b/src/lazr/restful/example/wsgi/root.py
index e8bca9e..277eb0c 100644
--- a/src/lazr/restful/example/wsgi/root.py
+++ b/src/lazr/restful/example/wsgi/root.py
@@ -52,4 +52,3 @@ class WSGIExampleWebServiceRootResource(RootResource):
             ]
         collections = dict(pairs=(IKeyValuePair, pairset))
         return collections, {}
-
diff --git a/src/lazr/restful/example/wsgi/tests/test_integration.py b/src/lazr/restful/example/wsgi/tests/test_integration.py
index 87484b7..da2b911 100644
--- a/src/lazr/restful/example/wsgi/tests/test_integration.py
+++ b/src/lazr/restful/example/wsgi/tests/test_integration.py
@@ -33,6 +33,8 @@ checker = renormalizing.OutputChecker()
 class FunctionalLayer:
     zcml = os.path.abspath(resource_filename(
         'lazr.restful.example.wsgi', 'site.zcml'))
+
+
 zcml_layer(FunctionalLayer)
 
 
@@ -43,6 +45,8 @@ class WSGILayer(FunctionalLayer):
         getUtility(IWebServiceConfiguration).port = None
         root = WSGIExampleWebServiceRootResource()
         return WebServiceApplication(root, Publication)
+
+
 wsgi_intercept_layer(WSGILayer)
 
 
diff --git a/src/lazr/restful/frameworks/django.py b/src/lazr/restful/frameworks/django.py
index 8b6eeb8..d247e66 100644
--- a/src/lazr/restful/frameworks/django.py
+++ b/src/lazr/restful/frameworks/django.py
@@ -51,6 +51,7 @@ class DjangoConfigurationGrokker(martian.ClassGrokker):
     that can be overridden from your Django 'settings' module.
     """
     martian.component(DjangoWebServiceConfiguration)
+
     def execute(self, cls, config, *kw):
         for name, field in getFieldsInOrder(IWebServiceConfiguration):
             settings_name = "LAZR_RESTFUL_" + name.upper()
@@ -76,6 +77,7 @@ class IDjangoLocation(Interface):
     def __parent_object__(self):
         """This object's parent in the object tree."""
 
+
 # We want a raised django.core.exceptions.ObjectDoesNotExist
 # object to result in a 404 status code. But we don't
 # control that class definition, so we can't annotate it.
@@ -109,6 +111,8 @@ class DjangoLocation(object):
     @property
     def __name__(self):
         return self.context.__url_path__
+
+
 grokcore.component.global_adapter(DjangoLocation, IDjangoLocation, ILocation)
 
 
@@ -135,4 +139,6 @@ class ManagerSequencer(object):
     def __len__(self):
         """Return the length of the dataset."""
         return self.manager.count()
+
+
 grokcore.component.global_adapter(ManagerSequencer, Manager, IFiniteSequence)
diff --git a/src/lazr/restful/interface.py b/src/lazr/restful/interface.py
index ce78b03..67971f1 100644
--- a/src/lazr/restful/interface.py
+++ b/src/lazr/restful/interface.py
@@ -82,4 +82,3 @@ def copy_field(field, **overrides):
     for name, value in overrides.items():
         setattr(field_copy, name, value)
     return field_copy
-
diff --git a/src/lazr/restful/interfaces/__init__.py b/src/lazr/restful/interfaces/__init__.py
index 83a726a..de1611f 100644
--- a/src/lazr/restful/interfaces/__init__.py
+++ b/src/lazr/restful/interfaces/__init__.py
@@ -27,9 +27,9 @@ try:
     # While we generally frown on "*" imports, this approach, combined with
     # the fact we only test code from this module, means that we can verify
     # what has been exported in the local files (DRY).
-    from lazr.restful.interfaces._fields import *
+    from lazr.restful.interfaces._fields import *  # noqa: F401, F403
     from lazr.restful.interfaces._fields import __all__ as _fields_all
-    from lazr.restful.interfaces._rest import *
+    from lazr.restful.interfaces._rest import *  # noqa: F401, F403
     from lazr.restful.interfaces._rest import __all__ as _rest_all
     __all__ = []
     __all__.extend(_fields_all)
diff --git a/src/lazr/restful/interfaces/_fields.py b/src/lazr/restful/interfaces/_fields.py
index 7136a34..190df42 100644
--- a/src/lazr/restful/interfaces/_fields.py
+++ b/src/lazr/restful/interfaces/_fields.py
@@ -36,6 +36,7 @@ class ICollectionField(ISequence):
     All iterables satisfy this collection field.
     """
 
+
 class IReference(IObject):
     """A reference to an object providing a particular schema.
 
diff --git a/src/lazr/restful/interfaces/_rest.py b/src/lazr/restful/interfaces/_rest.py
index 158fd0a..3f37f26 100644
--- a/src/lazr/restful/interfaces/_rest.py
+++ b/src/lazr/restful/interfaces/_rest.py
@@ -83,7 +83,7 @@ from zope.publisher.interfaces.browser import (
 from lazr.batchnavigator.interfaces import InvalidBatchSizeError
 
 # Constants for periods of time
-HOUR = 3600 # seconds
+HOUR = 3600  # seconds
 
 # The namespace prefix for LAZR web service-related tags.
 LAZR_WEBSERVICE_NS = 'lazr.restful'
@@ -117,6 +117,7 @@ class IJSONPublishable(Interface):
         may include parameters.
         """
 
+
 class IServiceRootResource(IHTTPResource):
     """A service root object that also acts as a resource."""
 
@@ -309,6 +310,7 @@ class INotificationsProvider(Interface):
         ERROR = logging.ERROR     # the previous action did not succeed
         """))
 
+
 class IWebServiceClientRequest(IBrowserRequest):
     """Interface for requests to the web service."""
     version = Attribute("The version of the web service that the client "
@@ -331,6 +333,7 @@ class IWebServiceVersion(Interface):
     """
     pass
 
+
 class IJSONRequestCache(Interface):
     """A cache of objects exposed as URLs or JSON representations."""
 
diff --git a/src/lazr/restful/jsoncache.py b/src/lazr/restful/jsoncache.py
index 9a08bdb..0c71d4d 100644
--- a/src/lazr/restful/jsoncache.py
+++ b/src/lazr/restful/jsoncache.py
@@ -17,6 +17,7 @@ from zope.component import adapter
 from zope.interface import implementer
 from zope.publisher.interfaces import IApplicationRequest
 
+
 @implementer(IJSONRequestCache)
 @adapter(IApplicationRequest)
 class JSONRequestCache:
diff --git a/src/lazr/restful/marshallers.py b/src/lazr/restful/marshallers.py
index 21ca499..f212224 100644
--- a/src/lazr/restful/marshallers.py
+++ b/src/lazr/restful/marshallers.py
@@ -185,7 +185,7 @@ class SimpleFieldMarshaller:
             try:
                 v = value
                 if isinstance(v, bytes):
-                    v = v.decode('utf8') # assume utf8
+                    v = v.decode('utf8')  # assume utf8
                 elif not isinstance(v, six.text_type):
                     v = six.text_type(v)
                 value = simplejson.loads(v)
diff --git a/src/lazr/restful/metazcml.py b/src/lazr/restful/metazcml.py
index 680413a..95d5e4c 100644
--- a/src/lazr/restful/metazcml.py
+++ b/src/lazr/restful/metazcml.py
@@ -67,6 +67,7 @@ def reset_globals():
     del REGISTERED_OPERATIONS[:]
     REGISTERED_CONTRIBUTORS.clear()
 
+
 try:
     from zope.testing.cleanup import addCleanUp
 except ImportError:
@@ -329,6 +330,7 @@ def register_webservice(context, module):
             callable=generate_and_register_webservice_operations,
             order=2)
 
+
 @adapter(IProcessStarting)
 def webservice_sanity_checks(registration):
     """Ensure the web service contains no references to unpublished objects.
@@ -390,7 +392,7 @@ def webservice_sanity_checks(registration):
                 version, referenced_interface, available_registrations,
                 "named operation %s returns %s" % (tags['as'], what))
 
-        if not 'params' in tags:
+        if 'params' not in tags:
             continue
 
         for name, field in tags['params'].items():
@@ -473,7 +475,7 @@ def generate_and_register_webservice_operations(
             config.last_version_with_mutator_named_operations)
         if len(config.active_versions) > no_mutator_operations_after+1:
             block_mutator_operations_as_of_version = config.active_versions[
-                no_mutator_operations_after+1]
+                no_mutator_operations_after + 1]
         else:
             block_mutator_operations_as_of_version = None
     registered_adapters = set()
@@ -569,7 +571,7 @@ def generate_and_register_webservice_operations(
             else:
                 if tag['type'] == 'read_operation':
                     operation_provides = IResourceGETOperation
-                elif tag['type']in ['factory', 'write_operation']:
+                elif tag['type'] in ['factory', 'write_operation']:
                     operation_provides = IResourcePOSTOperation
                 elif tag['type'] in ['destructor']:
                     operation_provides = IResourceDELETEOperation
@@ -621,7 +623,7 @@ def generate_and_register_webservice_operations(
                 registered_adapters.add(
                     (operation_name, version, operation_provides))
                 if (tag.get('is_mutator')
-                    and block_mutator_operations_as_of_version != None):
+                    and block_mutator_operations_as_of_version is not None):
                     defined_in = this_version_index
                     blocked_as_of = config.active_versions.index(
                         block_mutator_operations_as_of_version)
@@ -672,5 +674,3 @@ def register_exception_view(context, exception):
               WebServiceExceptionView, (exception, IWebServiceClientRequest),
               Interface, 'index.html', context.info),
         )
-
-
diff --git a/src/lazr/restful/security.py b/src/lazr/restful/security.py
index ff4530f..77ca653 100644
--- a/src/lazr/restful/security.py
+++ b/src/lazr/restful/security.py
@@ -44,5 +44,3 @@ def protect_schema(type_, schema, read_permission=CheckerPublic,
                 continue
             write_permissions[name] = write_permission
     defineChecker(type_, Checker(read_permissions, write_permissions))
-
-
diff --git a/src/lazr/restful/simple.py b/src/lazr/restful/simple.py
index 25824e7..04c0a0a 100644
--- a/src/lazr/restful/simple.py
+++ b/src/lazr/restful/simple.py
@@ -290,7 +290,6 @@ class RootResourceAbsoluteURL:
         self.port = config.port
         self.prefix = config.service_root_uri_prefix
 
-
     def __str__(self):
         """Return the part of the URL that contains the hostname.
 
@@ -502,4 +501,3 @@ class DictionaryBasedRepresentationCache(BaseRepresentationCache):
 BaseWebServiceConfiguration = implement_from_dict(
     "BaseWebServiceConfiguration", IWebServiceConfiguration,
     {'first_version_with_total_size_link': None}, object)
-
diff --git a/src/lazr/restful/tales.py b/src/lazr/restful/tales.py
index d9bb8df..7d12db9 100644
--- a/src/lazr/restful/tales.py
+++ b/src/lazr/restful/tales.py
@@ -300,7 +300,7 @@ class WebLayerAPI:
     def is_entry(self):
         """Whether the object is published as an entry."""
         request = get_current_web_service_request()
-        return queryMultiAdapter((self.context, request), IEntry) != None
+        return queryMultiAdapter((self.context, request), IEntry) is not None
 
     @property
     def json(self):
@@ -740,7 +740,6 @@ class WadlFieldAPI(RESTUtilityBase):
                 % (self.field.interface, self.field.getName()))
             raise e
 
-
     @property
     def options(self):
         """An enumeration of acceptable values for this field.
diff --git a/src/lazr/restful/testing/event.py b/src/lazr/restful/testing/event.py
index d071af5..3eaf040 100644
--- a/src/lazr/restful/testing/event.py
+++ b/src/lazr/restful/testing/event.py
@@ -36,4 +36,3 @@ class TestEventListener:
         sm = zope.component.getGlobalSiteManager()
         sm.unregisterHandler(
             self, (self.object_type, self.event_type))
-
diff --git a/src/lazr/restful/testing/tales.py b/src/lazr/restful/testing/tales.py
index 616502f..b8afdb3 100644
--- a/src/lazr/restful/testing/tales.py
+++ b/src/lazr/restful/testing/tales.py
@@ -33,4 +33,3 @@ def test_tales(expression, **kw):
     # fail if an object is accessed or imported outside of page's namespace.
     compiled_tales = TrustedEngine.compile(expression)
     return compiled_tales(Context(**kw))
-
diff --git a/src/lazr/restful/testing/webservice.py b/src/lazr/restful/testing/webservice.py
index ec621e4..be79781 100644
--- a/src/lazr/restful/testing/webservice.py
+++ b/src/lazr/restful/testing/webservice.py
@@ -156,7 +156,6 @@ class FakeRequest:
         self.URL = 'http://api.example.org/'
         self.headers = {}
 
-
     def getTraversalStack(self):
         """See `IPublicationRequest`.
 
diff --git a/src/lazr/restful/tests/test_declarations.py b/src/lazr/restful/tests/test_declarations.py
index 6a693e4..12d380c 100644
--- a/src/lazr/restful/tests/test_declarations.py
+++ b/src/lazr/restful/tests/test_declarations.py
@@ -228,10 +228,14 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
         self.product._bug_count = 10
         self.project._bug_count = 100
         register_test_module('testmod', IProduct, IProject, IHasBugs)
-        adapter = getMultiAdapter((self.product, self.one_zero_request), IEntry)
+        adapter = getMultiAdapter(
+            (self.product, self.one_zero_request), IEntry
+        )
         self.assertEqual(adapter.bug_count, 10)
 
-        adapter = getMultiAdapter((self.project, self.one_zero_request), IEntry)
+        adapter = getMultiAdapter(
+            (self.project, self.one_zero_request), IEntry
+        )
         self.assertEqual(adapter.bug_count, 100)
 
     def test_multiple_contributing_interfaces(self):
@@ -241,7 +245,9 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
         self.product._dev_branch = Branch('A product branch')
         register_test_module(
             'testmod', IBranch, IProduct, IHasBugs, IHasBranches)
-        adapter = getMultiAdapter((self.product, self.one_zero_request), IEntry)
+        adapter = getMultiAdapter(
+            (self.product, self.one_zero_request), IEntry
+        )
         self.assertEqual(adapter.bug_count, 10)
         self.assertEqual(adapter.development_branch, self.product._dev_branch)
 
@@ -251,6 +257,7 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
         @exported_as_webservice_entry()
         class IEmpty(Interface):
             pass
+
         @implementer(IEmpty)
         class Empty:
             pass
@@ -279,7 +286,8 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
             secure_product = ProxyFactory(
                 self.product,
                 checker=MultiChecker([(IProduct, 'zope.Public')]))
-            entry_resource = EntryResource(secure_product, self.one_zero_request)
+            entry_resource = EntryResource(
+                secure_product, self.one_zero_request)
             self.assertEqual([], entry_resource.redacted_fields)
         finally:
             endInteraction()
@@ -308,6 +316,7 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
         # A contributing interface can only contribute to exported interfaces.
         class INotExported(Interface):
             pass
+
         @exported_as_webservice_entry(contributes_to=[INotExported])
         class IContributor(Interface):
             title = exported(TextLine(title=u'The project title'))
@@ -336,7 +345,9 @@ class ContributingInterfacesTestCase(TestCaseWithWebServiceFixtures):
         # different adapters, its type name is that of the main interface and
         # not one of its contributors.
         register_test_module('testmod', IProduct, IHasBugs)
-        adapter = getMultiAdapter((self.product, self.one_zero_request), IEntry)
+        adapter = getMultiAdapter(
+            (self.product, self.one_zero_request), IEntry
+        )
         self.assertEqual(
             'product', EntryAdapterUtility(adapter.__class__).singular_type)
 
@@ -805,7 +816,6 @@ class TestEntryMultiversion(TestCaseWithWebServiceFixtures):
             INotPresentInLaterVersion, [],
             *getUtility(IWebServiceConfiguration).active_versions)
         self.assertEqual(len(interfaces), 1)
-        tags = interfaces[0][1].getTaggedValue(LAZR_WEBSERVICE_NAME)
         self.assertEqual(interfaces[0].version, '1.0')
 
     def test_different_names_in_different_versions(self):
@@ -971,8 +981,7 @@ class TestRequireExplicitVersions(TestCaseWithWebServiceFixtures):
             'but not by using as_of. The service configuration requires '
             'that you use as_of.')
 
-
-    def test_field_exported_as_of_earlier_version_is_exported_in_subsequent_versions(self):
+    def test_field_exported_as_of_earlier_version_is_exported_in_subsequent_versions(self):  # noqa: E501
         # If you export a field as_of version 1.0, it's present in
         # 1.0's version of the entry and in all subsequent versions.
         interfaces = generate_entry_interfaces(
@@ -983,7 +992,7 @@ class TestRequireExplicitVersions(TestCaseWithWebServiceFixtures):
         self.assertEqual(list(interface_10.names()), ['field'])
         self.assertEqual(list(interface_20.names()), ['field'])
 
-    def test_field_exported_as_of_later_version_is_not_exported_in_earlier_versions(self):
+    def test_field_exported_as_of_later_version_is_not_exported_in_earlier_versions(self):  # noqa: E501
         # If you export a field as_of version 2.0, it's not present in
         # 1.0's version of the entry.
         interfaces = generate_entry_interfaces(
@@ -1188,7 +1197,7 @@ class TestSanityChecking(TestCaseWithWebServiceFixtures):
 
     def _test_fails_sanity_check(
         self, expect_failure_in_version, expect_failure_for_reason,
-        expect_failure_due_to_interface, *classes):
+            expect_failure_due_to_interface, *classes):
         """Verify that the given interfaces can't become a web service.
 
         The given set of interfaces are expected to fail the sanity
@@ -1213,13 +1222,12 @@ class TestSanityChecking(TestCaseWithWebServiceFixtures):
         expected_message = (
             "In version %(version)s, %(reason)s, but version %(version)s "
             "of the web service does not publish %(interface)s as an entry. "
-             "(It may not be published at all.)" % dict(
+            "(It may not be published at all.)" % dict(
                 version=expect_failure_in_version,
                 reason=expect_failure_for_reason,
                 interface=expect_failure_due_to_interface.__name__))
         self.assertEqual(str(exception), expected_message)
 
-
     def test_reference_to_unpublished_object_fails(self):
         self._test_fails_sanity_check(
             '1.0',
diff --git a/src/lazr/restful/tests/test_utils.py b/src/lazr/restful/tests/test_utils.py
index c70c90b..91dbc8e 100644
--- a/src/lazr/restful/tests/test_utils.py
+++ b/src/lazr/restful/tests/test_utils.py
@@ -119,7 +119,7 @@ class TestVersionedDict(testtools.TestCase):
         self.assertRaises(
             KeyError, self.dict.rename_version, "not present", "renamed")
 
-    def test_dict_for_name_finds_first_dict(self):
+    def test_dict_for_name_finds_dict_with_given_name(self):
         # dict_for_name finds a dict with the given name in the stack.
         self.dict.push("name1")
         self.dict['key'] = 'value1'
@@ -204,7 +204,6 @@ class TestVersionedDict(testtools.TestCase):
             'Error test: Unrecognized version "nosuchversion".')
 
 
-
 class TestParseAcceptStyleHeader(unittest.TestCase):
 
     def test_single_value(self):
diff --git a/src/lazr/restful/tests/test_webservice.py b/src/lazr/restful/tests/test_webservice.py
index bf43319..acb4ae0 100644
--- a/src/lazr/restful/tests/test_webservice.py
+++ b/src/lazr/restful/tests/test_webservice.py
@@ -161,7 +161,7 @@ class EntryTestCase(WebServiceTestCase):
     def request(self, media_type=None):
         media_type = media_type or self.default_media_type
         request = getUtility(IWebServiceConfiguration).createRequest(
-            BytesIO(b""), {'HTTP_ACCEPT' : media_type})
+            BytesIO(b""), {'HTTP_ACCEPT': media_type})
         newInteraction(request)
         yield request
         endInteraction()
@@ -180,7 +180,8 @@ class EntryTestCase(WebServiceTestCase):
         data_object = entry_implementation(*implementation_args)
 
         with self.request() as request:
-            entry = entry_class(data_object, request)
+            # todo: needs a closer look
+            entry = entry_class(data_object, request)  # noqa: F841
             resource = EntryResource(data_object, request)
             yield resource
 
@@ -722,7 +723,7 @@ class WadlAPITestCase(WebServiceTestCase):
             'A simple collection containing IGenericEntry, for use in tests.',
             '</wadl:doc>'], doclines)
 
-    def test_field_wadl_doc (self):
+    def test_field_wadl_doc(self):
         """Test the wadl:doc generated for an exported field."""
         entry = get_resource_factory(IGenericEntry, IEntry)
         field = entry.schema['a_field']
@@ -750,7 +751,7 @@ class WadlAPITestCase(WebServiceTestCase):
         # we dont care about the formatting of the parameters table.
         self.assertEqual([
             '<wadl:doc xmlns="http://www.w3.org/1999/xhtml">',
-            '<p>Print an appropriate greeting based on the message.</p>',],
+            '<p>Print an appropriate greeting based on the message.</p>', ],
             doclines[0:2])
         self.assertEqual('</wadl:doc>', doclines[-1])
         self.assertTrue(len(doclines) > 3,
@@ -939,7 +940,6 @@ class BaseBatchingTest:
             LAZR_WEBSERVICE_NAME,
             dict(singular='test_entity', plural='test_entities'))
 
-
     def make_instance(self, entries, request):
         raise NotImplementedError('You have to make your own instances.')
 
@@ -1000,6 +1000,7 @@ class NotificationsProviderTest(EntryTestCase):
             return [Notification(logging.INFO, "Informational"),
                     Notification(logging.WARNING, "Warning")
                     ]
+
     def setUp(self):
         super(NotificationsProviderTest, self).setUp()
         self.default_media_type = "application/json;include=lp_html"
@@ -1037,6 +1038,7 @@ class NotificationsProviderTest(EntryTestCase):
                 [logging.INFO, "Informational"], [logging.WARNING, "Warning"]]
             self.assertEqual(notifications, expected_notifications)
 
+
 class EventTestCase(EntryTestCase):
 
     testmodule_objects = [IHasOneField]
diff --git a/src/lazr/restful/wsgi.py b/src/lazr/restful/wsgi.py
index 56593dd..5006d1a 100644
--- a/src/lazr/restful/wsgi.py
+++ b/src/lazr/restful/wsgi.py
@@ -71,4 +71,3 @@ class BaseWSGIWebServiceConfiguration(BaseWebServiceConfiguration):
     WebServiceConfiguration. It's only maintained for backwards
     compatibility.
     """
-
diff --git a/tox.ini b/tox.ini
index aac9737..02b7f78 100644
--- a/tox.ini
+++ b/tox.ini
@@ -15,3 +15,33 @@ deps =
     .[docs]
 commands =
     sphinx-build -b html -d src/lazr/restful/docs/_build/doctrees src/lazr/restful/docs src/lazr/restful/docs/_build/html
+
+[flake8]
+ignore =
+    # most errors from the E section will be fixed by using black
+    E121
+    E123
+    E124
+    E125
+    E126
+    E127
+    E128
+    E129
+    E131
+    E201
+    E202
+    E203
+    E225
+    E226
+    E231
+    E251
+    E261
+    E402
+    E501
+    # W503 and W504 are mutually exclusive
+    W503
+    W504
+    # todo
+    E731
+    F821
+    W605