chore(cli): remove ruff exclusion of templates (#32864)

2025-09-22 19:09:57 +00:00 · 2025-09-09 20:56:47 +02:00
parent 256a0b5f2f
commit 352ff363ca
19 changed files with 1317 additions and 1302 deletions
--- a/libs/cli/langchain_cli/integration_template/docs/chat.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/chat.ipynb
@@ -63,7 +63,9 @@
    "import os\n",
    "\n",
    "if not os.getenv(\"__MODULE_NAME___API_KEY\"):\n",
-        "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "        \"Enter your __ModuleName__ API key: \"\n",
+    "    )"
   ]
  },
  {
--- a/libs/cli/langchain_cli/integration_template/docs/document_loaders.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/document_loaders.ipynb
@@ -58,7 +58,9 @@
    "import getpass\n",
    "import os\n",
    "\n",
-        "os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "    \"Enter your __ModuleName__ API key: \"\n",
+    ")"
   ]
  },
  {
--- a/libs/cli/langchain_cli/integration_template/docs/llms.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/llms.ipynb
@@ -56,7 +56,9 @@
    "import os\n",
    "\n",
    "if not os.getenv(\"__MODULE_NAME___API_KEY\"):\n",
-        "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "        \"Enter your __ModuleName__ API key: \"\n",
+    "    )"
   ]
  },
  {
@@ -173,9 +175,7 @@
   "source": [
    "from langchain_core.prompts import PromptTemplate\n",
    "\n",
-        "prompt = PromptTemplate(\n",
-        "    \"How to say {input} in {output_language}:\\n\"\n",
-        ")\n",
+    "prompt = PromptTemplate(\"How to say {input} in {output_language}:\\n\")\n",
    "\n",
    "chain = prompt | llm\n",
    "chain.invoke(\n",
--- a/libs/cli/langchain_cli/integration_template/docs/stores.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/stores.ipynb
@@ -62,7 +62,9 @@
    "import os\n",
    "\n",
    "if not os.getenv(\"__MODULE_NAME___API_KEY\"):\n",
-    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "        \"Enter your __ModuleName__ API key: \"\n",
+    "    )"
   ]
  },
  {
--- a/libs/cli/langchain_cli/integration_template/docs/text_embedding.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/text_embedding.ipynb
@@ -52,7 +52,9 @@
    "import os\n",
    "\n",
    "if not os.getenv(\"__MODULE_NAME___API_KEY\"):\n",
-        "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "        \"Enter your __ModuleName__ API key: \"\n",
+    "    )"
   ]
  },
  {
--- a/libs/cli/langchain_cli/integration_template/docs/tools.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/tools.ipynb
@@ -120,9 +120,7 @@
    "from langchain_community.tools import __ModuleName__\n",
    "\n",
    "\n",
-    "tool = __ModuleName__(\n",
-    "    ...\n",
-    ")"
+    "tool = __ModuleName__(...)"
   ]
  },
  {
--- a/libs/cli/langchain_cli/integration_template/docs/vectorstores.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/vectorstores.ipynb
@@ -68,7 +68,9 @@
    "import os\n",
    "\n",
    "if not os.getenv(\"__MODULE_NAME___API_KEY\"):\n",
-        "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\"Enter your __ModuleName__ API key: \")"
+    "    os.environ[\"__MODULE_NAME___API_KEY\"] = getpass.getpass(\n",
+    "        \"Enter your __ModuleName__ API key: \"\n",
+    "    )"
   ]
  },
  {
@@ -140,24 +142,15 @@
   "source": [
    "from langchain_core.documents import Document\n",
    "\n",
-        "document_1 = Document(\n",
-        "    page_content=\"foo\",\n",
-        "    metadata={\"source\": \"https://example.com\"}\n",
-        ")\n",
+    "document_1 = Document(page_content=\"foo\", metadata={\"source\": \"https://example.com\"})\n",
    "\n",
-        "document_2 = Document(\n",
-        "    page_content=\"bar\",\n",
-        "    metadata={\"source\": \"https://example.com\"}\n",
-        ")\n",
+    "document_2 = Document(page_content=\"bar\", metadata={\"source\": \"https://example.com\"})\n",
    "\n",
-        "document_3 = Document(\n",
-        "    page_content=\"baz\",\n",
-        "    metadata={\"source\": \"https://example.com\"}\n",
-        ")\n",
+    "document_3 = Document(page_content=\"baz\", metadata={\"source\": \"https://example.com\"})\n",
    "\n",
    "documents = [document_1, document_2, document_3]\n",
    "\n",
-        "vector_store.add_documents(documents=documents,ids=[\"1\",\"2\",\"3\"])"
+    "vector_store.add_documents(documents=documents, ids=[\"1\", \"2\", \"3\"])"
   ]
  },
  {
@@ -178,11 +171,10 @@
   "outputs": [],
   "source": [
    "updated_document = Document(\n",
-        "    page_content=\"qux\",\n",
-        "    metadata={\"source\": \"https://another-example.com\"}\n",
+    "    page_content=\"qux\", metadata={\"source\": \"https://another-example.com\"}\n",
    ")\n",
    "\n",
-        "vector_store.update_documents(document_id=\"1\",document=updated_document)"
+    "vector_store.update_documents(document_id=\"1\", document=updated_document)"
   ]
  },
  {
@@ -228,7 +220,9 @@
   "metadata": {},
   "outputs": [],
   "source": [
-        "results = vector_store.similarity_search(query=\"thud\",k=1,filter={\"source\":\"https://another-example.com\"})\n",
+    "results = vector_store.similarity_search(\n",
+    "    query=\"thud\", k=1, filter={\"source\": \"https://another-example.com\"}\n",
+    ")\n",
    "for doc in results:\n",
    "    print(f\"* {doc.page_content} [{doc.metadata}]\")"
   ]
@@ -250,7 +244,9 @@
   "metadata": {},
   "outputs": [],
   "source": [
-        "results = vector_store.similarity_search_with_score(query=\"thud\",k=1,filter={\"source\":\"https://example.com\"})\n",
+    "results = vector_store.similarity_search_with_score(\n",
+    "    query=\"thud\", k=1, filter={\"source\": \"https://example.com\"}\n",
+    ")\n",
    "for doc, score in results:\n",
    "    print(f\"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]\")"
   ]
@@ -274,10 +270,7 @@
   "metadata": {},
   "outputs": [],
   "source": [
-        "retriever = vector_store.as_retriever(\n",
-        "    search_type=\"mmr\",\n",
-        "    search_kwargs={\"k\": 1}\n",
-        ")\n",
+    "retriever = vector_store.as_retriever(search_type=\"mmr\", search_kwargs={\"k\": 1})\n",
    "retriever.invoke(\"thud\")"
   ]
  },
--- a/libs/cli/langchain_cli/integration_template/integration_template/chat_models.py
+++ b/libs/cli/langchain_cli/integration_template/integration_template/chat_models.py
@@ -21,11 +21,13 @@ class Chat__ModuleName__(BaseChatModel):
    # https://github.com/langchain-ai/langchain/blob/7ff05357bac6eaedf5058a2af88f23a1817d40fe/libs/partners/openai/langchain_openai/chat_models/base.py#L1120
    """__ModuleName__ chat model integration.

-    The default implementation echoes the first `parrot_buffer_length` characters of the input.
+    The default implementation echoes the first `parrot_buffer_length` characters of
+    the input.

    # TODO: Replace with relevant packages, env vars.
    Setup:
-        Install ``__package_name__`` and set environment variable ``__MODULE_NAME___API_KEY``.
+        Install ``__package_name__`` and set environment variable
+        ``__MODULE_NAME___API_KEY``.

        .. code-block:: bash

@@ -48,7 +50,8 @@ class Chat__ModuleName__(BaseChatModel):
        max_retries: int
            Max number of retries.
        api_key: Optional[str]
-            __ModuleName__ API key. If not passed in will be read from env var __MODULE_NAME___API_KEY.
+            __ModuleName__ API key. If not passed in will be read from env var
+            __MODULE_NAME___API_KEY.

    See full list of supported init args and their descriptions in the params section.

--- a/libs/cli/langchain_cli/integration_template/integration_template/document_loaders.py
+++ b/libs/cli/langchain_cli/integration_template/integration_template/document_loaders.py
@@ -14,7 +14,8 @@ class __ModuleName__Loader(BaseLoader):

    # TODO: Replace with relevant packages, env vars.
    Setup:
-        Install ``__package_name__`` and set environment variable ``__MODULE_NAME___API_KEY``.
+        Install ``__package_name__`` and set environment variable
+        ``__MODULE_NAME___API_KEY``.

        .. code-block:: bash

@@ -62,7 +63,7 @@ class __ModuleName__Loader(BaseLoader):

            TODO: Example output

-    """  # noqa: E501
+    """

    # TODO: This method must be implemented to load documents.
    # Do not implement load(), a default implementation is already available.
--- a/libs/cli/langchain_cli/integration_template/integration_template/toolkits.py
+++ b/libs/cli/langchain_cli/integration_template/integration_template/toolkits.py
@@ -12,7 +12,8 @@ class __ModuleName__Toolkit(BaseToolkit):

    # TODO: Replace with relevant packages, env vars, etc.
    Setup:
-        Install ``__package_name__`` and set environment variable ``__MODULE_NAME___API_KEY``.
+        Install ``__package_name__`` and set environment variable
+        ``__MODULE_NAME___API_KEY``.

        .. code-block:: bash

@@ -65,7 +66,7 @@ class __ModuleName__Toolkit(BaseToolkit):

             # TODO: Example output.

-    """  # noqa: E501
+    """

    # TODO: This method must be implemented to list tools.
    def get_tools(self) -> List[BaseTool]:
--- a/libs/cli/langchain_cli/integration_template/integration_template/tools.py
+++ b/libs/cli/langchain_cli/integration_template/integration_template/tools.py
@@ -27,7 +27,8 @@ class __ModuleName__Tool(BaseTool):  # type: ignore[override]

    Setup:
        # TODO: Replace with relevant packages, env vars.
-        Install ``__package_name__`` and set environment variable ``__MODULE_NAME___API_KEY``.
+        Install ``__package_name__`` and set environment variable
+        ``__MODULE_NAME___API_KEY``.

        .. code-block:: bash

--- a/libs/cli/langchain_cli/integration_template/pyproject.toml
+++ b/libs/cli/langchain_cli/integration_template/pyproject.toml
@@ -25,6 +25,9 @@ langchain-core = "^0.3.15"
 [tool.ruff.lint]
 select = ["E", "F", "I", "T201"]

+[tool.ruff.lint.per-file-ignores]
+"docs/**" = [ "ALL",]
+
 [tool.coverage.run]
 omit = ["tests/*"]

--- a/libs/cli/langchain_cli/package_template/package_template/init.py
+++ b/libs/cli/langchain_cli/package_template/package_template/init.py
@@ -1,3 +1,5 @@
+"""__module_name__ module."""
+
 from __module_name__.chain import chain

 __all__ = ["chain"]
--- a/libs/cli/langchain_cli/package_template/package_template/chain.py
+++ b/libs/cli/langchain_cli/package_template/package_template/chain.py
@@ -1,3 +1,5 @@
+"""Chain definition."""
+
 from langchain_core.prompts import ChatPromptTemplate
 from langchain_openai import ChatOpenAI

--- a/libs/cli/langchain_cli/package_template/tests/init.py
+++ b/libs/cli/langchain_cli/package_template/tests/init.py
@@ -0,0 +1 @@
+"""Tests."""
--- a/libs/cli/langchain_cli/project_template/app/init.py
+++ b/libs/cli/langchain_cli/project_template/app/init.py
@@ -0,0 +1 @@
+"""Server application."""
--- a/libs/cli/langchain_cli/project_template/app/server.py
+++ b/libs/cli/langchain_cli/project_template/app/server.py
@@ -1,3 +1,5 @@
+"""Chain server."""
+
 from fastapi import FastAPI
 from fastapi.responses import RedirectResponse
 from langserve import add_routes
@@ -6,7 +8,7 @@ app = FastAPI()


@app.get("/")
-async def redirect_root_to_docs() -> RedirectResponse:
+async def _redirect_root_to_docs() -> RedirectResponse:
    return RedirectResponse("/docs")


@@ -16,4 +18,4 @@ add_routes(app, NotImplemented)
 if __name__ == "__main__":
    import uvicorn

-    uvicorn.run(app, host="0.0.0.0", port=8000)
+    uvicorn.run(app, host="0.0.0.0", port=8000)  # noqa: S104
--- a/libs/cli/pyproject.toml
+++ b/libs/cli/pyproject.toml
@@ -41,11 +41,9 @@ langchain = { path = "../langchain", editable = true }

 [tool.ruff]
 target-version = "py39"
-exclude = [
-    "langchain_cli/integration_template",
-    "langchain_cli/package_template",
-    "langchain_cli/project_template",
-]
+
+[tool.ruff.format]
+docstring-code-format = true

 [tool.ruff.lint]
 select = [ "ALL",]
--- a/libs/cli/uv.lock
+++ b/libs/cli/uv.lock
@@ -667,9 +667,10 @@ test-integration = [
    { name = "transformers", specifier = ">=4.51.3,<5.0.0" },
 ]
 typing = [
+    { name = "beautifulsoup4", specifier = ">=4.13.5,<5.0.0" },
    { name = "lxml-stubs", specifier = ">=0.5.1,<1.0.0" },
    { name = "mypy", specifier = ">=1.17.1,<1.18" },
-    { name = "tiktoken", specifier = ">=0.8.0,<1.0.0" },
+    { name = "tiktoken", specifier = ">=0.11.0,<1.0.0" },
    { name = "types-requests", specifier = ">=2.31.0.20240218,<3.0.0.0" },
 ]