Lint Python sources with ruff (#85)

* Add ruff as development dependency

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Add lint step to CI workflow

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Apply automatic fixes made by ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Ignore rule E501

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Explicitly select ruff rule sets

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Enable isort rules in ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Apply automatic fixes made by ruff for isort violations

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Enable pyupgrade rules in ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Apply automatic fix made by ruff for pyupgrade violation

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Enable flake8-bandit rules in ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Enable flake8-boolean-trap rules in ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Enable flake8-bugbear rules in ruff

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

* Fix 'B028 No explicit `stacklevel` keyword argument found'

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

---------

Signed-off-by: Mattt Zmuda <mattt@replicate.com>

Author: mattt

.github/workflows/ci.yaml

@@ -24,6 +24,8 @@ jobs:
           cache: "pip"
       - name: Install dependencies
         run: python -m pip install -r requirements.txt -r requirements-dev.txt .
+      - name: Lint
+        run: python -m ruff .
       - name: Test
         run: python -m pytest
 

pyproject.toml

@@ -11,11 +11,31 @@ license = { file = "LICENSE" }
 authors = [{ name = "Replicate, Inc." }]
 requires-python = ">=3.8"
 dependencies = ["packaging", "pydantic>1", "requests>2"]
-optional-dependencies = { dev = ["black", "pytest", "responses"] }
+optional-dependencies = { dev = ["black", "pytest", "responses", "ruff"] }
 
 [project.urls]
 homepage = "https://replicate.com"
 repository = "https://github.com/replicate/replicate-python"
 
 [tool.pytest.ini_options]
 testpaths = "tests/"
+
+[tool.ruff]
+select = [
+    "E",   # pycodestyle error
+    "F",   # Pyflakes
+    "I",   # isort
+    "W",   # pycodestyle warning
+    "UP",  # pyupgrade
+    "S",   # flake8-bandit
+    "BLE", # flake8-blind-except
+    "FBT", # flake8-boolean-trap
+    "B",   # flake8-bugbear
+]
+ignore = [
+    "E501", # Line too long
+    "S113", # Probable use of requests call without timeout
+]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["S101", "S106"]

replicate/base_model.py

@@ -1,6 +1,6 @@
 from typing import ForwardRef
-import pydantic
 
+import pydantic
 
 Client = ForwardRef("Client")
 Collection = ForwardRef("Collection")

replicate/collection.py

@@ -35,4 +35,4 @@ def prepare_model(self, attrs):
             model._collection = self
             return model
         else:
-            raise Exception("Can't create %s from %s" % (self.model.__name__, attrs))
+            raise Exception(f"Can't create {self.model.__name__} from {attrs}")

replicate/files.py

@@ -15,7 +15,7 @@ def upload_file(fh: io.IOBase, output_file_prefix: str = None) -> str:
     if output_file_prefix is not None:
         name = getattr(fh, "name", "output")
         url = output_file_prefix + os.path.basename(name)
-        resp = requests.put(url, files={"file": fh})
+        resp = requests.put(url, files={"file": fh}, timeout=None)
         resp.raise_for_status()
         return url
 

replicate/json.py

@@ -3,7 +3,6 @@
 from types import GeneratorType
 from typing import Any, Callable
 
-
 try:
     import numpy as np  # type: ignore
 

replicate/model.py

@@ -1,5 +1,3 @@
-from typing import List
-
 from replicate.base_model import BaseModel
 from replicate.collection import Collection
 from replicate.exceptions import ReplicateException
@@ -12,7 +10,7 @@ class Model(BaseModel):
 
     def predict(self, *args, **kwargs):
         raise ReplicateException(
-            f"The `model.predict()` method has been removed, because it's unstable: if a new version of the model you're using is pushed and its API has changed, your code may break. Use `version.predict()` instead. See https://github.com/replicate/replicate-python#readme"
+            "The `model.predict()` method has been removed, because it's unstable: if a new version of the model you're using is pushed and its API has changed, your code may break. Use `version.predict()` instead. See https://github.com/replicate/replicate-python#readme"
         )
 
     @property

replicate/prediction.py

@@ -3,7 +3,7 @@
 
 from replicate.base_model import BaseModel
 from replicate.collection import Collection
-from replicate.exceptions import ModelError, ReplicateException
+from replicate.exceptions import ModelError
 from replicate.files import upload_file
 from replicate.json import encode_json
 from replicate.version import Version
@@ -92,7 +92,7 @@ def get(self, id: str) -> Prediction:
         return self.prepare_model(obj)
 
     def list(self) -> List[Prediction]:
-        resp = self._client._request("GET", f"/v1/predictions")
+        resp = self._client._request("GET", "/v1/predictions")
         # TODO: paginate
         predictions = resp.json()["results"]
         for prediction in predictions:

replicate/training.py

@@ -1,13 +1,11 @@
 import re
-import time
-from typing import Any, Dict, Iterator, List, Optional
+from typing import Any, Dict, List, Optional
 
 from replicate.base_model import BaseModel
 from replicate.collection import Collection
-from replicate.exceptions import ModelError, ReplicateException
+from replicate.exceptions import ReplicateException
 from replicate.files import upload_file
 from replicate.json import encode_json
-from replicate.version import Version
 
 
 class Training(BaseModel):
@@ -55,7 +53,7 @@ def create(
         )
         if not match:
             raise ReplicateException(
-                f"version must be in format username/model_name:version_id"
+                "version must be in format username/model_name:version_id"
             )
         username = match.group("username")
         model_name = match.group("model_name")

replicate/version.py

@@ -18,6 +18,7 @@ def predict(self, **kwargs) -> Union[Any, Iterator[Any]]:
         warnings.warn(
             "version.predict() is deprecated. Use replicate.run() instead. It will be removed before version 1.0.",
             DeprecationWarning,
+            stacklevel=1,
         )
 
         prediction = self._client.predictions.create(version=self, input=kwargs)

requirements-dev.txt

@@ -43,6 +43,8 @@ requests==2.28.2
     #   responses
 responses==0.23.1
     # via replicate (pyproject.toml)
+ruff==0.0.261
+    # via replicate (pyproject.toml)
 types-pyyaml==6.0.12.9
     # via responses
 typing-extensions==4.5.0

tests/test_prediction.py

@@ -1,8 +1,6 @@
 import responses
 from responses import matchers
 
-import replicate
-
 from .factories import create_client, create_version
 
 
@@ -41,7 +39,7 @@ def test_create_works_with_webhooks():
         },
     )
 
-    prediction = client.predictions.create(
+    client.predictions.create(
         version=version,
         input={"text": "world"},
         webhook="https://example.com/webhook",
@@ -156,8 +154,8 @@ def test_async_timings():
     )
 
     assert prediction.created_at == "2022-04-26T20:00:40.658234Z"
-    assert prediction.completed_at == None
-    assert prediction.output == None
+    assert prediction.completed_at is None
+    assert prediction.output is None
     prediction.wait()
     assert prediction.created_at == "2022-04-26T20:00:40.658234Z"
     assert prediction.completed_at == "2022-04-26T20:02:27.648305Z"

tests/test_version.py

@@ -2,9 +2,10 @@
 
 import pytest
 import responses
-from replicate.exceptions import ModelError
 from responses import matchers
 
+from replicate.exceptions import ModelError
+
 from .factories import (
     create_version,
     create_version_with_iterator_output,