Resolve pylint warnings

Author: mattt

Diff for: python/cog/predictor.py

@@ -70,7 +70,6 @@ def predict(self, **kwargs: Any) -> Any:
         """
         Run a single prediction on the model
         """
-        pass
 
     def log(self, *messages: str) -> None:
         """
@@ -174,7 +173,7 @@ def load_config() -> CogConfig:
     # Assumes the working directory is /src
     config_path = os.path.abspath("cog.yaml")
     try:
-        with open(config_path) as fh:
+        with open(config_path, encoding="utf-8") as fh:
             config = yaml.safe_load(fh)
     except FileNotFoundError as e:
         raise ConfigDoesNotExist(
@@ -548,11 +547,12 @@ class TrainingOutput(TrainingOutputType):  # type: ignore
             pass
 
         return TrainingOutput
+    else:
 
-    class TrainingOutput(BaseModel):
-        __root__: TrainingOutputType  # type: ignore
+        class TrainingOutput(BaseModel):
+            __root__: TrainingOutputType  # type: ignore
 
-    return TrainingOutput
+        return TrainingOutput
 
 
 def human_readable_type_name(t: Type[Union[Any, None]]) -> str:

Diff for: python/cog/server/clients.py

@@ -38,14 +38,14 @@ def _get_version() -> str:
             pass
         else:
             return version("cog")
-        import pkg_resources
+        import pkg_resources  # pylint: disable=import-outside-toplevel
 
         return pkg_resources.get_distribution("cog").version
-    except Exception:
+    except Exception:  # pylint: disable=broad-exception-caught
         return "unknown"
 
 
-_user_agent = f"cog-worker/{_get_version()} {httpx._client.USER_AGENT}"
+_user_agent = f"cog-worker/{_get_version()}"
 _response_interval = float(os.environ.get("COG_THROTTLE_RESPONSE_INTERVAL", 0.5))
 
 # HACK: signal that we should skip the start webhook when the response interval

Diff for: python/cog/server/http.py

@@ -102,14 +102,15 @@ async def healthcheck_startup_failed() -> Any:
 
 
 def create_app(
-    config: CogConfig,
-    shutdown_event: Optional[threading.Event],
-    threads: int = 1,
+    config: CogConfig,  # pylint: disable=redefined-outer-name
+    shutdown_event: Optional[threading.Event],  # pylint: disable=redefined-outer-name
+    threads: int = 1,  # pylint: disable=redefined-outer-name
     upload_url: Optional[str] = None,
     mode: str = "predict",
     is_build: bool = False,
+    await_explicit_shutdown: bool = False,  # pylint: disable=redefined-outer-name
 ) -> MyFastAPI:
-    app = MyFastAPI(
+    app = MyFastAPI(  # pylint: disable=redefined-outer-name
         title="Cog",  # TODO: mention model name?
         # version=None # TODO
     )
@@ -242,7 +243,8 @@ def startup() -> None:
             app.state.setup_result
             and app.state.setup_result.status == schema.Status.FAILED
         ):
-            if not args.await_explicit_shutdown:  # signal shutdown if interactive run
+            # signal shutdown if interactive run
+            if not await_explicit_shutdown:
                 if shutdown_event is not None:
                     shutdown_event.set()
         else:
@@ -469,9 +471,9 @@ def stop(self) -> None:
         os.kill(os.getpid(), signal.SIGKILL)
 
 
-def is_port_in_use(port: int) -> bool:
-    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
-        return s.connect_ex(("localhost", port)) == 0
+def is_port_in_use(port: int) -> bool:  # pylint: disable=redefined-outer-name
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        return sock.connect_ex(("localhost", port)) == 0
 
 
 def signal_ignore(signum: Any, frame: Any) -> None:  # pylint: disable=unused-argument
@@ -549,17 +551,25 @@ def _cpu_count() -> int:
             threads = _cpu_count()
 
     shutdown_event = threading.Event()
+
+    await_explicit_shutdown = args.await_explicit_shutdown
+    if await_explicit_shutdown:
+        signal.signal(signal.SIGTERM, signal_ignore)
+    else:
+        signal.signal(signal.SIGTERM, signal_set_event(shutdown_event))
+
     app = create_app(
         config=config,
         shutdown_event=shutdown_event,
         threads=threads,
         upload_url=args.upload_url,
         mode=args.mode,
+        await_explicit_shutdown=await_explicit_shutdown,
     )
 
     host: str = args.host
 
-    port = int(os.getenv("PORT", 5000))
+    port = int(os.getenv("PORT", "5000"))
     if is_port_in_use(port):
         log.error(f"Port {port} is already in use")
         sys.exit(1)
@@ -573,11 +583,6 @@ def _cpu_count() -> int:
         workers=1,
     )
 
-    if args.await_explicit_shutdown:
-        signal.signal(signal.SIGTERM, signal_ignore)
-    else:
-        signal.signal(signal.SIGTERM, signal_set_event(shutdown_event))
-
     s = Server(config=server_config)
     s.start()
 
@@ -589,6 +594,6 @@ def _cpu_count() -> int:
     s.stop()
 
     # return error exit code when setup failed and cog is running in interactive mode (not k8s)
-    if app.state.setup_result and not args.await_explicit_shutdown:
+    if app.state.setup_result and not await_explicit_shutdown:
         if app.state.setup_result.status == schema.Status.FAILED:
             exit(-1)

Diff for: python/cog/server/probes.py

@@ -24,9 +24,10 @@ def __init__(self, root: PathLike = None) -> None:
             self._root.mkdir(exist_ok=True, parents=True)
         except OSError:
             log.error(
-                f"Failed to create cog runtime state directory ({self._root}). "
+                "Failed to create cog runtime state directory (%s). "
                 "Does it already exist and is a file? Does the user running cog "
-                "have permissions?"
+                "have permissions?",
+                self._root,
             )
         else:
             self._enabled = True

Diff for: python/cog/server/runner.py

@@ -192,10 +192,10 @@ async def inner() -> SetupResult:
                         logs.append(event.message)
                     elif isinstance(event, Done):
                         if event.error:
+                            status = schema.Status.FAILED
                             raise FatalWorkerException(
                                 "Predictor errored during setup: " + event.error_detail
                             )
-                            status = schema.Status.FAILED
                         else:
                             status = schema.Status.SUCCEEDED
                         self._state = WorkerState.IDLE

Diff for: python/cog/server/worker.py

@@ -99,8 +99,8 @@ async def read(
 def emit_metric(metric_name: str, metric_value: "float | int") -> None:
     worker = worker_reference.get(None, None)
     if worker is None:
-        raise Exception("Attempted to emit metric but worker is not running")
-    worker._emit_metric(metric_name, metric_value)
+        raise RuntimeError("Attempted to emit metric but worker is not running")
+    worker.emit_metric(metric_name, metric_value)
 
 
 class _ChildWorker(_spawn.Process):  # type: ignore

Diff for: python/cog/suppress_output.py

@@ -6,8 +6,8 @@
 
 @contextmanager
 def suppress_output() -> Iterator[None]:
-    null_out = open(os.devnull, "w")
-    null_err = open(os.devnull, "w")
+    null_out = open(os.devnull, "w", encoding="utf-8")
+    null_err = open(os.devnull, "w", encoding="utf-8")
     out_fd = sys.stdout.fileno()
     err_fd = sys.stderr.fileno()
     out_dup_fd = os.dup(out_fd)