Update to pass flake8 hook

Make the changes necessary to pass the flake8 hook we have in our
pre-commit configuration. Some tweaks were made to docstrings as part
of this process.

Note: The E203 check was disabled in the flake8 configuration.

Author: mcdonnnj

.flake8

@@ -14,6 +14,9 @@ max-line-length = 80
 # * The B950 flake8-bugbear opinionated warning -
 #   https://github.com/PyCQA/flake8-bugbear#opinionated-warnings
 select = C,D,E,F,W,B,B950
+# Ignore flake8's default warning about "whitespace before ':'" as it is not
+# PEP 8 compliant and conflicts with black's styling.
+#
 # Ignore flake8's default warning about maximum line length, which has
 # a hard stop at the configured value.  Instead we use
 # flake8-bugbear's B950, which allows up to 10% overage.
@@ -22,4 +25,4 @@ select = C,D,E,F,W,B,B950
 # operators.  It no longer agrees with PEP8.  See, for example, here:
 # https://github.com/ambv/black/issues/21. Guido agrees here:
 # https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b.
-ignore = E501,W503
+ignore = E203,E501,W503

gce-scripts/combine_shards.py

@@ -5,6 +5,7 @@
 
 
 def main():
+    """Read a file with a list of shard filenames and combine them."""
     if (len(sys.argv)) < 2:
         print("you need a filename!")
         exit(1)

src/pshtt/cli.py

@@ -39,6 +39,7 @@
 
 
 def to_csv(results, out_filename):
+    """Output the provided results in CSV format to the provided filename."""
     utils.debug("Opening CSV file: {}".format(out_filename))
     with smart_open(out_filename) as out_file:
         writer = csv.writer(out_file)
@@ -55,6 +56,7 @@ def to_csv(results, out_filename):
 
 
 def to_json(results, out_filename):
+    """Output the provided results in JSON format to the provided filename."""
     # Generate (yield) all the results before exporting to JSON
     results = list(results)
 
@@ -68,6 +70,7 @@ def to_json(results, out_filename):
 
 
 def to_markdown(results, out_filename):
+    """Output the provided results in Markdown format to the provided filename."""
     # Generate (yield) all the results before exporting to Markdown
     table = [[" %s" % result[header] for header in pshtt.HEADERS] for result in results]
 
@@ -83,6 +86,7 @@ def to_markdown(results, out_filename):
 
 
 def main():
+    """Provide a command line interface to the pshtt library."""
     args = docopt.docopt(__doc__, version=__version__)
     utils.configure_logging(args["--debug"])
 

src/pshtt/models.py

@@ -1,5 +1,11 @@
+"""Define the models used in this library."""
+
+
 class Domain(object):
+    """Define the domain model."""
+
     def __init__(self, domain):
+        """Initialize the model."""
         self.domain = domain
 
         # 4 endpoints for each domain.
@@ -13,6 +19,7 @@ def __init__(self, domain):
         self.canonical = None
 
     def to_object(self):
+        """Convert the model to a dictionary."""
         return {
             "https": self.https.to_object(),
             "httpswww": self.httpswww.to_object(),
@@ -22,7 +29,10 @@ def to_object(self):
 
 
 class Endpoint(object):
+    """Define the endpoint model."""
+
     def __init__(self, protocol, host, base_domain):
+        """Initialize the model."""
         # Basic endpoint description
         self.protocol = protocol
         self.host = host  # "www" or "root"
@@ -77,6 +87,7 @@ def __init__(self, protocol, host, base_domain):
         self.hsts_preloaded = None
 
     def url_for(self, protocol, host, base_domain):
+        """Return an appropriately formatted URL for the base domain."""
         if host == "root":
             prefix = ""
         elif host == "www":
@@ -86,6 +97,7 @@ def url_for(self, protocol, host, base_domain):
 
     # The fields we want to serialize to JSON.
     def to_object(self):
+        """Convert the model to a dictionary."""
         obj = {
             "url": self.url,
             "headers": dict(self.headers),