style: blacken code and suppress some pylint warnings

Author: aelanman

.github/workflows/main.yml

@@ -35,7 +35,7 @@ jobs:
         run: flake8 --show-source --ignore=E501,E741,E203,W503,E266,E402,D105,D107 coco
 
       - name: Run pylint
-        run: pylint-ignore -d line-too-long,invalid-name,logging-fstring-interpolation,too-many-arguments,too-many-instance-attributes,too-many-locals,cyclic-import --ignore=_version.py coco
+        run: pylint-ignore -d line-too-long,invalid-name,logging-fstring-interpolation,too-many-arguments,too-many-instance-attributes,too-many-locals,cyclic-import,C0206 --ignore=_version.py coco
 
   tests:
     runs-on: ubuntu-latest

coco/_version.py

@@ -56,7 +56,7 @@ class NotThisMethod(Exception):
 
 
 def register_vcs_handler(vcs, method):  # decorator
-    """Mark a method as the handler for a particular VCS."""
+    """Decorator to mark a method as the handler for a particular VCS."""
 
     def decorate(f):
         """Store f in HANDLERS[vcs][method]."""

coco/config.py

@@ -172,7 +172,7 @@ def load_config(path=None):
 
         logger.info(f"Loading config file {cfile}")
 
-        with absfile.open("r") as fh:
+        with absfile.open("r", encoding="utf-8") as fh:
             conf = yaml.safe_load(fh)
 
         config = merge_dict_tree(config, conf)

coco/core.py

@@ -392,7 +392,7 @@ def check(e):
                         a = list(a.keys())[0]
                     if isinstance(a, CocoForward):
                         a = a.name
-                    if a not in self.endpoints.keys():
+                    if a not in self.endpoints:
                         raise ConfigError(
                             f"coco.endpoint: endpoint `{a}` found in config for "
                             f"`{e.name}` does not exist."

coco/request_forwarder.py

@@ -21,7 +21,7 @@
 logger = logging.getLogger(__name__)
 
 
-async def _dump_trace(session, context, params):
+async def _dump_trace(session, context, params):  # pylint: disable=W0613
     """Tracing call back that dumps the current info."""
     events_seen = ", ".join(
         [
@@ -45,7 +45,7 @@ def _create_trace_callback(name):
     The callbacks will track which events were seen at what time.
     """
 
-    async def _callback(session, context, params):
+    async def _callback(session, context, params):  # pylint: disable=W0613
 
         if not hasattr(context, "event_status"):
             context.event_status = {}
@@ -56,10 +56,10 @@ async def _callback(session, context, params):
     return _callback
 
 
-def _trace_config(all=False):
+def _trace_config(trace_all=False):
     """Get a trace config for debugging.
 
-    If all=False, only dump on exceptions, otherwise dump at the end of a request too.
+    If trace_all=False, only dump on exceptions, otherwise dump at the end of a request too.
     """
     if not hasattr(_trace_config, "obj"):
 
@@ -74,7 +74,7 @@ def _trace_config(all=False):
 
         _trace_config.obj.on_request_exception.append(_dump_trace)
 
-        if all:
+        if trace_all:
             _trace_config.obj.on_request_end.append(_dump_trace)
 
     return _trace_config.obj

coco/test/coco_runner.py

@@ -9,8 +9,8 @@
 import shutil
 import time
 
-STATE_DIR = tempfile.TemporaryDirectory()
-BLOCKLIST_DIR = tempfile.TemporaryDirectory()
+STATE_DIR = tempfile.TemporaryDirectory()  # pylint: disable=R1732
+BLOCKLIST_DIR = tempfile.TemporaryDirectory()  # pylint: disable=R1732
 BLOCKLIST_PATH = pathlib.Path(BLOCKLIST_DIR.name, "blocklist.json")
 
 COCO_DAEMON = (
@@ -61,11 +61,13 @@ def __del__(self):
     def __enter__(self):
         return self
 
-    def __exit__(self, type, value, traceback):
+    def __exit__(self, exc_type, value, traceback):
         self.__del__()
 
-    def client(self, command, data=[], silent=False):
+    def client(self, command, data=None, silent=False):
         """Make coco-client script call a coco endpoint."""
+        if data is None:
+            data = []
         cmd = CLIENT_ARGS + ["-c", self.configfile.name, command] + data
         logger.debug(f"calling coco client: {cmd}")
         try:
@@ -90,24 +92,28 @@ def start_coco(self, config, endpoint_configs, reset):
         CONFIG.update(config)
 
         # Write endpoint configs to file
-        self.endpointdir = tempfile.TemporaryDirectory()
+        self.endpointdir = tempfile.TemporaryDirectory()  # pylint: disable=R1732
         CONFIG["endpoint_dir"] = self.endpointdir.name
         for name, endpoint_conf in endpoint_configs.items():
             with open(
-                os.path.join(self.endpointdir.name, name + ".conf"), "w"
+                os.path.join(self.endpointdir.name, name + ".conf"),
+                "w",
+                encoding="utf-8",
             ) as outfile:
                 json.dump(endpoint_conf, outfile)
 
         # Write config to file
-        self.configfile = tempfile.NamedTemporaryFile("w")
+        self.configfile = tempfile.NamedTemporaryFile("w")  # pylint: disable=R1732
         json.dump(CONFIG, self.configfile)
         self.configfile.flush()
 
         args = []
         if reset:
             args.append("--reset")
 
-        self.coco = subprocess.Popen([COCO_DAEMON, "-c", self.configfile.name, *args])
+        self.coco = subprocess.Popen(
+            [COCO_DAEMON, "-c", self.configfile.name, *args]
+        )  # pylint: disable=R1732
 
     def stop_coco(self):
         """Stop coco script."""

coco/test/endpoint_farm.py

@@ -27,7 +27,9 @@ def endpoint(name):
     try:
         reply = dict(request.json)
     except BadRequest:
-        app.logger.info("Did not get a JSON message, using the empty {}")
+        app.logger.info(
+            "Did not get a JSON message, using the empty {}"
+        )  # pylint: disable=E1101
         reply = {}
 
     if request.args:

coco/worker.py

@@ -134,8 +134,8 @@ async def go():
 
                 try:
                     endpoint = endpoints[endpoint_name]
-                except KeyError:
-                    raise InvalidPath(f"Endpoint /{endpoint_name} not found.")
+                except KeyError as exc:
+                    raise InvalidPath(f"Endpoint /{endpoint_name} not found.") from exc
 
                 # Check that it is being requested with the correct method
                 if method != endpoint.type and method not in endpoint.type:

docs/conf.py

@@ -57,7 +57,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.