Merge branch 'wip-v1.0' into typing-dict

Author: mdrxy

docs/docs/contributing/how_to/documentation/style_guide.mdx

@@ -79,7 +79,7 @@ Here are some high-level tips on writing a good how-to guide:
 
 ### Conceptual guide
 
-LangChain's conceptual guide falls under the **Explanation** quadrant of Diataxis. These guides should cover LangChain terms and concepts
+LangChain's conceptual guides fall under the **Explanation** quadrant of Diataxis. These guides should cover LangChain terms and concepts
 in a more abstract way than how-to guides or tutorials, targeting curious users interested in
 gaining a deeper understanding and insights of the framework. Try to avoid excessively large code examples as the primary goal is to
 provide perspective to the user rather than to finish a practical project. These guides should cover **why** things work the way they do.
@@ -105,7 +105,7 @@ Here are some high-level tips on writing a good conceptual guide:
 ### References
 
 References contain detailed, low-level information that describes exactly what functionality exists and how to use it.
-In LangChain, this is mainly our API reference pages, which are populated from docstrings within code.
+In LangChain, these are mainly our API reference pages, which are populated from docstrings within code.
 References pages are generally not read end-to-end, but are consulted as necessary when a user needs to know
 how to use something specific.
 
@@ -119,25 +119,25 @@ but here are some high-level tips on writing a good docstring:
 - Be concise
 - Discuss special cases and deviations from a user's expectations
 - Go into detail on required inputs and outputs
-- Light details on when one might use the feature are fine, but in-depth details belong in other sections.
+- Light details on when one might use the feature are fine, but in-depth details belong in other sections
 
 Each category serves a distinct purpose and requires a specific approach to writing and structuring the content.
 
 ## General guidelines
 
 Here are some other guidelines you should think about when writing and organizing documentation.
 
-We generally do not merge new tutorials from outside contributors without an actue need.
+We generally do not merge new tutorials from outside contributors without an acute need.
 We welcome updates as well as new integration docs, how-tos, and references.
 
 ### Avoid duplication
 
 Multiple pages that cover the same material in depth are difficult to maintain and cause confusion. There should
-be only one (very rarely two), canonical pages for a given concept or feature. Instead, you should link to other guides.
+be only one (very rarely two) canonical pages for a given concept or feature. Instead, you should link to other guides.
 
 ### Link to other sections
 
-Because sections of the docs do not exist in a vacuum, it is important to link to other sections frequently,
+Because sections of the docs do not exist in a vacuum, it is important to link to other sections frequently
 to allow a developer to learn more about an unfamiliar topic within the flow of reading.
 
 This includes linking to the API references and conceptual sections!

docs/docs/contributing/tutorials/docs.mdx

@@ -33,7 +33,7 @@ Sometimes you want to make a small change, like fixing a typo, and the easiest w
    - Click the "Commit changes..." button at the top-right corner of the page.
    - Give your commit a title like "Fix typo in X section."
    - Optionally, write an extended commit description.
-   - Click "Propose changes"
+   - Click "Propose changes".
 
 5. **Submit a pull request (PR):**
    - GitHub will redirect you to a page where you can create a pull request.

libs/cli/langchain_cli/cli.py

@@ -1,6 +1,6 @@
 """LangChain CLI."""
 
-from typing import Annotated, Optional
+from typing import Annotated
 
 import typer
 
@@ -61,11 +61,11 @@ def _main(
 def serve(
     *,
     port: Annotated[
-        Optional[int],
+        int | None,
         typer.Option(help="The port to run the server on"),
     ] = None,
     host: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(help="The host to run the server on"),
     ] = None,
 ) -> None:

libs/cli/langchain_cli/namespaces/app.py

@@ -5,7 +5,7 @@
 import sys
 import warnings
 from pathlib import Path
-from typing import Annotated, Optional
+from typing import Annotated
 
 import typer
 import uvicorn
@@ -35,18 +35,18 @@
 @app_cli.command()
 def new(
     name: Annotated[
-        Optional[str],
+        str | None,
         typer.Argument(
             help="The name of the folder to create",
         ),
     ] = None,
     *,
     package: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(help="Packages to seed the project with"),
     ] = None,
     pip: Annotated[
-        Optional[bool],
+        bool | None,
         typer.Option(
             "--pip/--no-pip",
             help="Pip install the template(s) as editable dependencies",
@@ -131,24 +131,24 @@ def new(
 @app_cli.command()
 def add(
     dependencies: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Argument(help="The dependency to add"),
     ] = None,
     *,
     api_path: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(help="API paths to add"),
     ] = None,
     project_dir: Annotated[
-        Optional[Path],
+        Path | None,
         typer.Option(help="The project directory"),
     ] = None,
     repo: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(help="Install templates from a specific github repo instead"),
     ] = None,
     branch: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(help="Install templates from a specific branch"),
     ] = None,
     pip: Annotated[
@@ -191,7 +191,7 @@ def add(
     )
 
     # group by repo/ref
-    grouped: dict[tuple[str, Optional[str]], list[DependencySource]] = {}
+    grouped: dict[tuple[str, str | None], list[DependencySource]] = {}
     for dep in parsed_deps:
         key_tup = (dep["git"], dep["ref"])
         lst = grouped.get(key_tup, [])
@@ -243,7 +243,7 @@ def add(
     try:
         add_dependencies_to_pyproject_toml(
             project_root / "pyproject.toml",
-            zip(installed_destination_names, installed_destination_paths),
+            zip(installed_destination_names, installed_destination_paths, strict=False),
         )
     except Exception:
         # Can fail if user modified/removed pyproject.toml
@@ -281,11 +281,11 @@ def add(
 
     imports = [
         f"from {e['module']} import {e['attr']} as {name}"
-        for e, name in zip(installed_exports, chain_names)
+        for e, name in zip(installed_exports, chain_names, strict=False)
     ]
     routes = [
         f'add_routes(app, {name}, path="{path}")'
-        for name, path in zip(chain_names, api_paths)
+        for name, path in zip(chain_names, api_paths, strict=False)
     ]
 
     t = (
@@ -310,7 +310,7 @@ def remove(
     api_paths: Annotated[list[str], typer.Argument(help="The API paths to remove")],
     *,
     project_dir: Annotated[
-        Optional[Path],
+        Path | None,
         typer.Option(help="The project directory"),
     ] = None,
 ) -> None:
@@ -349,15 +349,15 @@ def remove(
 def serve(
     *,
     port: Annotated[
-        Optional[int],
+        int | None,
         typer.Option(help="The port to run the server on"),
     ] = None,
     host: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(help="The host to run the server on"),
     ] = None,
     app: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(help="The app to run, e.g. `app.server:app`"),
     ] = None,
 ) -> None:

libs/cli/langchain_cli/namespaces/integration.py

@@ -4,7 +4,7 @@
 import shutil
 import subprocess
 from pathlib import Path
-from typing import Annotated, Optional, cast
+from typing import Annotated, cast
 
 import typer
 from typing_extensions import TypedDict
@@ -65,22 +65,22 @@ def new(
         ),
     ],
     name_class: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(
             help="The name of the integration in PascalCase. e.g. `MyIntegration`."
             " This is used to name classes like `MyIntegrationVectorStore`",
         ),
     ] = None,
     src: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(
             help="The name of the single template file to copy."
             " e.g. `--src integration_template/chat_models.py "
             "--dst my_integration/chat_models.py`. Can be used multiple times.",
         ),
     ] = None,
     dst: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(
             help="The relative path to the integration package to place the new file in"
             ". e.g. `my-integration/my_integration.py`",
@@ -166,7 +166,7 @@ def new(
                 typer.echo(f"File {dst_path} exists.")
                 raise typer.Exit(code=1)
 
-        for src_path, dst_path in zip(src_paths, dst_paths):
+        for src_path, dst_path in zip(src_paths, dst_paths, strict=False):
             shutil.copy(src_path, dst_path)
             replace_file(dst_path, cast("dict[str, str]", replacements))
 
@@ -203,7 +203,7 @@ def create_doc(
         ),
     ],
     name_class: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(
             help=(
                 "The PascalCase name of the integration (e.g. `OpenAI`, "

libs/cli/langchain_cli/namespaces/migrate/generate/utils.py

@@ -6,7 +6,8 @@
 import pathlib
 from pathlib import Path
 from types import ModuleType
-from typing import Any, Optional
+
+from typing_extensions import override
 
 HERE = Path(__file__).parent
 # Should bring us to [root]/src
@@ -20,12 +21,13 @@
 class ImportExtractor(ast.NodeVisitor):
     """Import extractor."""
 
-    def __init__(self, *, from_package: Optional[str] = None) -> None:
+    def __init__(self, *, from_package: str | None = None) -> None:
         """Extract all imports from the given code, optionally filtering by package."""
-        self.imports: list = []
+        self.imports: list[tuple[str, str]] = []
         self.package = from_package
 
-    def visit_ImportFrom(self, node: ast.ImportFrom) -> None:  # noqa: N802
+    @override
+    def visit_ImportFrom(self, node: ast.ImportFrom) -> None:
         if node.module and (
             self.package is None or str(node.module).startswith(self.package)
         ):
@@ -44,7 +46,8 @@ def _get_class_names(code: str) -> list[str]:
 
     # Define a node visitor class to collect class names
     class ClassVisitor(ast.NodeVisitor):
-        def visit_ClassDef(self, node: ast.ClassDef) -> None:  # noqa: N802
+        @override
+        def visit_ClassDef(self, node: ast.ClassDef) -> None:
             class_names.append(node.name)
             self.generic_visit(node)
 
@@ -54,7 +57,7 @@ def visit_ClassDef(self, node: ast.ClassDef) -> None:  # noqa: N802
     return class_names
 
 
-def is_subclass(class_obj: Any, classes_: list[type]) -> bool:
+def is_subclass(class_obj: type, classes_: list[type]) -> bool:
     """Check if the given class object is a subclass of any class in list classes."""
     return any(
         issubclass(class_obj, kls)
@@ -85,7 +88,7 @@ def _get_all_classnames_from_file(file: Path, pkg: str) -> list[tuple[str, str]]
 def identify_all_imports_in_file(
     file: str,
     *,
-    from_package: Optional[str] = None,
+    from_package: str | None = None,
 ) -> list[tuple[str, str]]:
     """Let's also identify all the imports in the given file."""
     code = Path(file).read_text(encoding="utf-8")
@@ -144,7 +147,7 @@ def list_init_imports_by_package(pkg_root: str) -> list[tuple[str, str]]:
 def find_imports_from_package(
     code: str,
     *,
-    from_package: Optional[str] = None,
+    from_package: str | None = None,
 ) -> list[tuple[str, str]]:
     """Find imports in code."""
     # Parse the code into an AST

libs/cli/langchain_cli/namespaces/migrate/main.py

@@ -4,7 +4,7 @@
 
 import rich
 import typer
-from gritql import run  # type: ignore[import]
+from gritql import run  # type: ignore[import-untyped]
 from typer import Option
 
 
@@ -68,7 +68,7 @@ def migrate(
     final_code = run.apply_pattern(
         "langchain_all_migrations()",
         args,
-        grit_dir=get_gritdir_path(),
+        grit_dir=str(get_gritdir_path()),
     )
 
     raise typer.Exit(code=final_code)

libs/cli/langchain_cli/namespaces/template.py

@@ -4,7 +4,7 @@
 import shutil
 import subprocess
 from pathlib import Path
-from typing import Annotated, Optional
+from typing import Annotated
 
 import typer
 import uvicorn
@@ -88,15 +88,15 @@ def new(
 def serve(
     *,
     port: Annotated[
-        Optional[int],
+        int | None,
         typer.Option(help="The port to run the server on"),
     ] = None,
     host: Annotated[
-        Optional[str],
+        str | None,
         typer.Option(help="The host to run the server on"),
     ] = None,
     configurable: Annotated[
-        Optional[bool],
+        bool | None,
         typer.Option(
             "--configurable/--no-configurable",
             help="Whether to include a configurable route",
@@ -140,7 +140,7 @@ def serve(
 
 
 @package_cli.command()
-def list(contains: Annotated[Optional[str], typer.Argument()] = None) -> None:  # noqa: A001
+def list(contains: Annotated[str | None, typer.Argument()] = None) -> None:  # noqa: A001
     """List all or search for available templates."""
     packages = list_packages(contains=contains)
     for package in packages:

libs/cli/langchain_cli/project_template/app/server.py

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