docs/langchain/libs/cli/scripts/generate_migrations.py

"""Script to generate migrations for the migration script."""
import json
import pkgutil

import click

from langchain_cli.namespaces.migrate.generate.generic import (
    generate_simplified_migrations,
)
from langchain_cli.namespaces.migrate.generate.partner import (
    get_migrations_for_partner_package,
)


@click.group()
def cli():
    """Migration scripts management."""
    pass


@cli.command()
@click.option(
    "--pkg1",
    default="langchain",
)
@click.option(
    "--pkg2",
    default="langchain_community",
)
@click.option(
    "--output",
    default=None,
    help="Output file for the migration script.",
)
@click.option(
    "--filter-by-all/--no-filter-by-all",
    default=True,
    help="Output file for the migration script.",
)
def generic(pkg1: str, pkg2: str, output: str, filter_by_all: bool) -> None:
    """Generate a migration script."""
    click.echo("Migration script generated.")
    migrations = generate_simplified_migrations(pkg1, pkg2, filter_by_all=filter_by_all)

    if output is None:
        output = f"{pkg1}_to_{pkg2}.json"

    with open(output, "w") as f:
        f.write(json.dumps(migrations, indent=2, sort_keys=True))


@cli.command()
@click.argument("pkg")
@click.option("--output", default=None, help="Output file for the migration script.")
def partner(pkg: str, output: str) -> None:
    """Generate migration scripts specifically for LangChain modules."""
    click.echo("Migration script for LangChain generated.")
    migrations = get_migrations_for_partner_package(pkg)
    # Run with python 3.9+
    output_name = f"{pkg.removeprefix('langchain_')}.json" if output is None else output
    if migrations:
        with open(output_name, "w") as f:
            f.write(json.dumps(migrations, indent=2, sort_keys=True))
        click.secho(f"LangChain migration script saved to {output_name}")
    else:
        click.secho(f"No migrations found for {pkg}", fg="yellow")


@cli.command()
def all_installed_partner_pkgs() -> None:
    """Generate migration scripts for all LangChain modules."""
    # Will generate migrations for all pather packages.
    # Define as "langchain_<partner_name>".
    # First let's determine which packages are installed in the environment
    # and then generate migrations for them.
    langchain_pkgs = [
        name
        for _, name, _ in pkgutil.iter_modules()
        if name.startswith("langchain_")
        and name not in {"langchain_core", "langchain_cli", "langchain_community"}
    ]
    for pkg in langchain_pkgs:
        migrations = get_migrations_for_partner_package(pkg)
        # Run with python 3.9+
        output_name = f"{pkg.removeprefix('langchain_')}.json"
        if migrations:
            with open(output_name, "w") as f:
                f.write(json.dumps(migrations, indent=2, sort_keys=True))
            click.secho(f"LangChain migration script saved to {output_name}")
        else:
            click.secho(f"No migrations found for {pkg}", fg="yellow")


if __name__ == "__main__":
    cli()