Linting fixes

Author: monoxgas

pyproject.toml

@@ -104,7 +104,9 @@ strict = true
 target-version = "py310"
 line-length = 100
 extend-exclude = [
-    "*.ipynb", # jupyter notebooks
+    "*.ipynb",    # jupyter notebooks
+    "examples/*", # example files
+    ".github/*",  # github files
 ]
 
 [tool.ruff.lint]

rigging/__init__.py

@@ -42,52 +42,52 @@
 __version__ = VERSION
 
 __all__ = [
-    "get_generator",
-    "Message",
-    "MessageDict",
-    "Messages",
-    "ContentText",
-    "ContentImageUrl",
-    "ContentAudioInput",
-    "Tool",
-    "Model",
-    "attr",
-    "element",
-    "wrapped",
     "Chat",
     "ChatPipeline",
-    "Generator",
-    "GenerateParams",
-    "GeneratedMessage",
-    "GeneratedText",
-    "chat",
-    "complete",
     "Completion",
     "CompletionPipeline",
-    "register_generator",
-    "prompt",
-    "Prompt",
+    "ContentAudioInput",
+    "ContentImageUrl",
+    "ContentText",
     "Ctx",
-    "data",
-    "watchers",
-    "model",
-    "error",
-    "parsing",
-    "tool",
-    "tool_method",
-    "logging",
-    "await_",
-    "interact",
-    "ThenChatCallback",
+    "GenerateParams",
+    "GeneratedMessage",
+    "GeneratedText",
+    "Generator",
     "MapChatCallback",
-    "ThenCompletionCallback",
     "MapCompletionCallback",
+    "Message",
+    "MessageDict",
+    "Messages",
+    "Model",
     "PipelineStep",
-    "PipelineStepGenerator",
     "PipelineStepContextManager",
+    "PipelineStepGenerator",
+    "Prompt",
+    "ThenChatCallback",
+    "ThenCompletionCallback",
+    "Tool",
+    "attr",
+    "await_",
+    "chat",
+    "complete",
+    "data",
+    "element",
+    "error",
     "generator",
+    "get_generator",
+    "interact",
+    "logging",
     "mcp",
+    "model",
+    "parsing",
+    "prompt",
+    "register_generator",
     "robopages",
+    "tool",
+    "tool_method",
+    "watchers",
+    "wrapped",
 ]
 
 from loguru import logger

rigging/chat.py

@@ -217,7 +217,7 @@ def message_dicts(self) -> list[MessageDict]:
         """
         return [
             t.cast(
-                MessageDict,
+                "MessageDict",
                 m.model_dump(include={"role", "content_parts"}, exclude_none=True),
             )
             for m in self.all
@@ -409,7 +409,7 @@ def inject_tool_prompt(
 
         tool_system_prompt = tool_description_prompt_part(
             definitions,
-            t.cast(t.Literal["xml", "json-in-xml"], mode),
+            t.cast("t.Literal['xml', 'json-in-xml']", mode),
         )
         return self.inject_system_content(tool_system_prompt)
 
@@ -524,8 +524,7 @@ def __call__(
         self,
         chat: Chat,
         /,
-    ) -> t.Awaitable[Chat | None]:
-        ...
+    ) -> t.Awaitable[Chat | None]: ...
 
 
 @runtime_checkable
@@ -534,8 +533,7 @@ def __call__(
         self,
         chat: Chat,
         /,
-    ) -> "PipelineStepGenerator | PipelineStepContextManager | t.Awaitable[PipelineStepGenerator | PipelineStepContextManager | None]":
-        ...
+    ) -> "PipelineStepGenerator | PipelineStepContextManager | t.Awaitable[PipelineStepGenerator | PipelineStepContextManager | None]": ...
 
 
 ThenChatCallback = _ThenChatCallback | _ThenChatStepCallback
@@ -550,8 +548,7 @@ def __call__(
         self,
         chats: list[Chat],
         /,
-    ) -> t.Awaitable[list[Chat]]:
-        ...
+    ) -> t.Awaitable[list[Chat]]: ...
 
 
 @runtime_checkable
@@ -560,8 +557,7 @@ def __call__(
         self,
         chats: list[Chat],
         /,
-    ) -> "PipelineStepGenerator | PipelineStepContextManager | t.Awaitable[PipelineStepGenerator | PipelineStepContextManager]":
-        ...
+    ) -> "PipelineStepGenerator | PipelineStepContextManager | t.Awaitable[PipelineStepGenerator | PipelineStepContextManager]": ...
 
 
 MapChatCallback = _MapChatCallback | _MapChatStepCallback
@@ -658,9 +654,10 @@ def depth(self) -> int:
         This is useful for setting constraints on recursion depth.
         """
         depth = 0
-        while self.parent is not None:
+        current = self
+        while current.parent is not None:
             depth += 1
-            self = self.parent
+            current = current.parent
         return depth
 
 
@@ -852,8 +849,7 @@ def add(
             and self.chat.all[-1].role == message_list[0].role
             and (
                 merge_strategy == "all"
-                or merge_strategy == "only-user-role"
-                and self.chat.all[-1].role == "user"
+                or (merge_strategy == "only-user-role" and self.chat.all[-1].role == "user")
             )
         ):
             self.chat.all[-1].content_parts += message_list[0].content_parts
@@ -1263,7 +1259,7 @@ async def _then_tools(self, chat: Chat) -> PipelineStepContextManager | None:
 
         # Parse the actual tool calls
 
-        tool_calls: (list[ApiToolCall] | list[XmlToolCall] | list[JsonInXmlToolCall] | None) = None
+        tool_calls: list[ApiToolCall] | list[XmlToolCall] | list[JsonInXmlToolCall] | None = None
         if self.tool_mode == "api":
             tool_calls = chat.last.tool_calls
         if self.tool_mode == "xml":
@@ -1435,7 +1431,7 @@ async def complete() -> None:
                     )
 
                 generator = t.cast(
-                    PipelineStepGenerator,
+                    "PipelineStepGenerator",
                     await exit_stack.enter_async_context(aclosing(result)),
                 )
                 async for step in generator:
@@ -1675,7 +1671,7 @@ async def _step(  # noqa: PLR0915, PLR0912
 
                     if inspect.isasyncgen(chats_or_generator):
                         generator = t.cast(
-                            PipelineStepGenerator,
+                            "PipelineStepGenerator",
                             await exit_stack.enter_async_context(
                                 aclosing(chats_or_generator),
                             ),

rigging/completion.py

@@ -263,7 +263,7 @@ def __init__(
 
         ExhuastedMaxRounds is implicitly included.
         """
-        self.on_failed: "FailMode" = "raise"
+        self.on_failed: FailMode = "raise"
         """How to handle failures in the pipeline unless overriden in calls."""
 
         # (callback, all_text, max_rounds)
@@ -747,7 +747,7 @@ async def _run(  # noqa: PLR0912
                         raise inbound  # noqa: TRY301
 
                 inbounds = [inbound for inbound in _inbounds if isinstance(inbound, GeneratedText)]
-            except Exception as e:  # noqa: BLE001
+            except Exception as e:
                 if on_failed == "raise" or not any(
                     isinstance(e, t) for t in self.errors_to_fail_on
                 ):
@@ -768,14 +768,14 @@ async def _run(  # noqa: PLR0912
                         state.processor.send(inbound.text)
                         continue
                     except StopIteration as stop:
-                        output = t.cast(str, stop.value)
+                        output = t.cast("str", stop.value)
                     except CompletionExhaustedMaxRoundsError as exhausted:
                         if on_failed == "raise":
                             raise
                         output = exhausted.completion
                         failed = True
                         error = exhausted
-                    except Exception as e:  # noqa: BLE001
+                    except Exception as e:
                         if on_failed == "raise" or not any(
                             isinstance(e, t) for t in self.errors_to_fail_on
                         ):

rigging/data.py

@@ -297,7 +297,7 @@ def elastic_data_to_chats(
     while all(hasattr(data, attr) for attr in ("keys", "__getitem__")) and "hits" in data:
         data = data["hits"]
 
-    objects = t.cast(t.Sequence[t.Mapping[str, t.Any]], data)
+    objects = t.cast("t.Sequence[t.Mapping[str, t.Any]]", data)
     if not isinstance(objects, t.Sequence):
         raise TypeError(
             f"Expected to find a sequence of objects (optionally under hits), found: {type(data)}",
@@ -341,7 +341,7 @@ async def elastic_to_chats(
         A pandas DataFrame containing the chat data.
     """
     data = await client.search(index=index, query=query, size=max_results, **kwargs)
-    return elastic_data_to_chats(t.cast(dict[str, t.Any], data))
+    return elastic_data_to_chats(t.cast("dict[str, t.Any]", data))
 
 
 async def s3_bucket_exists(client: S3Client, bucket: str) -> bool:

rigging/error.py

@@ -122,7 +122,7 @@ def _raise_as(func: t.Callable[P, R]) -> t.Callable[P, R]:
         def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             try:
                 return func(*args, **kwargs)
-            except Exception as e:  # noqa: BLE001
+            except Exception as e:
                 error = error_type(message)
                 raise error from e
 

rigging/generator/__init__.py

@@ -54,19 +54,19 @@ def get_transformers_lazy() -> type[Generator]:
 register_generator("transformers", get_transformers_lazy)
 
 __all__ = [
-    "get_generator",
-    "Generator",
     "GenerateParams",
     "GeneratedMessage",
     "GeneratedText",
+    "Generator",
+    "HTTPGenerator",
+    "LiteLLMGenerator",
     "StopReason",
     "Usage",
     "chat",
     "complete",
     "get_generator",
-    "register_generator",
+    "get_generator",
     "get_identifier",
-    "LiteLLMGenerator",
-    "HTTPGenerator",
+    "register_generator",
     # TODO: We can't add VLLM and Transformers here because they are lazy loaded
 ]

rigging/generator/base.py

@@ -663,7 +663,7 @@ def get_identifier(generator: Generator, params: GenerateParams | None = None) -
     return identifier
 
 
-def get_generator(identifier: str, *, params: GenerateParams | None = None) -> Generator:  # noqa: PLR0912
+def get_generator(identifier: str, *, params: GenerateParams | None = None) -> Generator:
     """
     Get a generator by an identifier string. Uses LiteLLM by default.
 
@@ -708,24 +708,24 @@ def get_generator(identifier: str, *, params: GenerateParams | None = None) -> G
     if "!" in identifier:
         try:
             provider, model = identifier.split("!")
-        except Exception as e:  # noqa: BLE001
+        except Exception as e:
             raise InvalidModelSpecifiedError(identifier) from e
 
     if provider not in g_providers:
         raise InvalidModelSpecifiedError(identifier)
 
     if not isinstance(g_providers[provider], type):
-        lazy_generator = t.cast(LazyGenerator, g_providers[provider])
+        lazy_generator = t.cast("LazyGenerator", g_providers[provider])
         g_providers[provider] = lazy_generator()
 
-    generator_cls = t.cast(type[Generator], g_providers[provider])
+    generator_cls = t.cast("type[Generator]", g_providers[provider])
 
     kwargs = {}
     if "," in model:
         try:
             model, kwargs_str = model.split(",", 1)
             kwargs = dict(arg.split("=", 1) for arg in kwargs_str.split(","))
-        except Exception as e:  # noqa: BLE001
+        except Exception as e:
             raise InvalidModelSpecifiedError(identifier) from e
 
     # See if any of the kwargs would apply to the cls constructor directly
@@ -753,7 +753,7 @@ def get_generator(identifier: str, *, params: GenerateParams | None = None) -> G
 
     try:
         merged_params = GenerateParams(**kwargs).merge_with(params)
-    except Exception as e:  # noqa: BLE001
+    except Exception as e:
         raise InvalidModelSpecifiedError(identifier) from e
 
     return generator_cls(model=model, params=merged_params, **init_kwargs)

rigging/generator/http.py

@@ -33,12 +33,12 @@ def _to_str(v: str | dict[str, t.Any]) -> str:
 
 
 def _to_dict(v: str | dict[str, t.Any]) -> dict[str, t.Any]:
-    return t.cast(dict[str, t.Any], json.loads(v)) if isinstance(v, str) else v
+    return t.cast("dict[str, t.Any]", json.loads(v)) if isinstance(v, str) else v
 
 
 def _to_dict_or_str(v: str) -> dict[str, t.Any] | str:
     try:
-        return t.cast(dict[str, t.Any], json.loads(v))
+        return t.cast("dict[str, t.Any]", json.loads(v))
     except json.JSONDecodeError:
         return v
 

rigging/interact.py

@@ -87,7 +87,7 @@ async def interact(
             else:
                 pipeline.add(user_input)
 
-            print("")
+            print()
 
             animation_task = asyncio.create_task(_animate())
             chat = await pipeline.run()