mirror of
https://github.com/hwchase17/langchain.git
synced 2025-08-09 21:08:59 +00:00
a0c2281540
```python
"""python scripts/update_mypy_ruff.py"""
import glob
import tomllib
from pathlib import Path
import toml
import subprocess
import re
ROOT_DIR = Path(__file__).parents[1]
def main():
for path in glob.glob(str(ROOT_DIR / "libs/**/pyproject.toml"), recursive=True):
print(path)
with open(path, "rb") as f:
pyproject = tomllib.load(f)
try:
pyproject["tool"]["poetry"]["group"]["typing"]["dependencies"]["mypy"] = (
"^1.10"
)
pyproject["tool"]["poetry"]["group"]["lint"]["dependencies"]["ruff"] = (
"^0.5"
)
except KeyError:
continue
with open(path, "w") as f:
toml.dump(pyproject, f)
cwd = "/".join(path.split("/")[:-1])
completed = subprocess.run(
"poetry lock --no-update; poetry install --with typing; poetry run mypy . --no-color",
cwd=cwd,
shell=True,
capture_output=True,
text=True,
)
logs = completed.stdout.split("\n")
to_ignore = {}
for l in logs:
if re.match("^(.*)\:(\d+)\: error:.*\[(.*)\]", l):
path, line_no, error_type = re.match(
"^(.*)\:(\d+)\: error:.*\[(.*)\]", l
).groups()
if (path, line_no) in to_ignore:
to_ignore[(path, line_no)].append(error_type)
else:
to_ignore[(path, line_no)] = [error_type]
print(len(to_ignore))
for (error_path, line_no), error_types in to_ignore.items():
all_errors = ", ".join(error_types)
full_path = f"{cwd}/{error_path}"
try:
with open(full_path, "r") as f:
file_lines = f.readlines()
except FileNotFoundError:
continue
file_lines[int(line_no) - 1] = (
file_lines[int(line_no) - 1][:-1] + f" # type: ignore[{all_errors}]\n"
)
with open(full_path, "w") as f:
f.write("".join(file_lines))
subprocess.run(
"poetry run ruff format .; poetry run ruff --select I --fix .",
cwd=cwd,
shell=True,
capture_output=True,
text=True,
)
if __name__ == "__main__":
main()
```
202 lines
6.6 KiB
Python
202 lines
6.6 KiB
Python
from typing import Type, cast
|
|
|
|
import pytest
|
|
from langchain_core.load import dumpd
|
|
from langchain_core.pydantic_v1 import SecretStr
|
|
from pytest import CaptureFixture, MonkeyPatch
|
|
|
|
from langchain_openai import (
|
|
AzureChatOpenAI,
|
|
AzureOpenAI,
|
|
AzureOpenAIEmbeddings,
|
|
ChatOpenAI,
|
|
OpenAI,
|
|
OpenAIEmbeddings,
|
|
)
|
|
|
|
|
|
def test_chat_openai_secrets() -> None:
|
|
o = ChatOpenAI(openai_api_key="foo") # type: ignore[call-arg]
|
|
s = str(o)
|
|
assert "foo" not in s
|
|
|
|
|
|
def test_openai_secrets() -> None:
|
|
o = OpenAI(openai_api_key="foo") # type: ignore[call-arg]
|
|
s = str(o)
|
|
assert "foo" not in s
|
|
|
|
|
|
def test_openai_embeddings_secrets() -> None:
|
|
o = OpenAIEmbeddings(openai_api_key="foo") # type: ignore[call-arg]
|
|
s = str(o)
|
|
assert "foo" not in s
|
|
|
|
|
|
def test_azure_chat_openai_secrets() -> None:
|
|
o = AzureChatOpenAI( # type: ignore[call-arg]
|
|
openai_api_key="foo1",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="foo2", # type: ignore[arg-type]
|
|
api_version="version",
|
|
)
|
|
s = str(o)
|
|
assert "foo1" not in s
|
|
assert "foo2" not in s
|
|
|
|
|
|
def test_azure_openai_secrets() -> None:
|
|
o = AzureOpenAI( # type: ignore[call-arg]
|
|
openai_api_key="foo1",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="foo2", # type: ignore[arg-type]
|
|
api_version="version",
|
|
)
|
|
s = str(o)
|
|
assert "foo1" not in s
|
|
assert "foo2" not in s
|
|
|
|
|
|
def test_azure_openai_embeddings_secrets() -> None:
|
|
o = AzureOpenAIEmbeddings( # type: ignore[call-arg]
|
|
openai_api_key="foo1",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="foo2", # type: ignore[arg-type]
|
|
api_version="version",
|
|
)
|
|
s = str(o)
|
|
assert "foo1" not in s
|
|
assert "foo2" not in s
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"model_class", [AzureChatOpenAI, AzureOpenAI, AzureOpenAIEmbeddings]
|
|
)
|
|
def test_azure_openai_api_key_is_secret_string(model_class: Type) -> None:
|
|
"""Test that the API key is stored as a SecretStr."""
|
|
model = model_class(
|
|
openai_api_key="secret-api-key",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="secret-ad-token",
|
|
api_version="version",
|
|
)
|
|
assert isinstance(model.openai_api_key, SecretStr)
|
|
assert isinstance(model.azure_ad_token, SecretStr)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"model_class", [AzureChatOpenAI, AzureOpenAI, AzureOpenAIEmbeddings]
|
|
)
|
|
def test_azure_openai_api_key_masked_when_passed_from_env(
|
|
model_class: Type, monkeypatch: MonkeyPatch, capsys: CaptureFixture
|
|
) -> None:
|
|
"""Test that the API key is masked when passed from an environment variable."""
|
|
monkeypatch.setenv("AZURE_OPENAI_API_KEY", "secret-api-key")
|
|
monkeypatch.setenv("AZURE_OPENAI_AD_TOKEN", "secret-ad-token")
|
|
model = model_class(azure_endpoint="endpoint", api_version="version")
|
|
print(model.openai_api_key, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
print(model.azure_ad_token, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"model_class", [AzureChatOpenAI, AzureOpenAI, AzureOpenAIEmbeddings]
|
|
)
|
|
def test_azure_openai_api_key_masked_when_passed_via_constructor(
|
|
model_class: Type, capsys: CaptureFixture
|
|
) -> None:
|
|
"""Test that the API key is masked when passed via the constructor."""
|
|
model = model_class(
|
|
openai_api_key="secret-api-key",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="secret-ad-token",
|
|
api_version="version",
|
|
)
|
|
print(model.openai_api_key, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
print(model.azure_ad_token, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"model_class", [AzureChatOpenAI, AzureOpenAI, AzureOpenAIEmbeddings]
|
|
)
|
|
def test_azure_openai_uses_actual_secret_value_from_secretstr(
|
|
model_class: Type,
|
|
) -> None:
|
|
"""Test that the actual secret value is correctly retrieved."""
|
|
model = model_class(
|
|
openai_api_key="secret-api-key",
|
|
azure_endpoint="endpoint",
|
|
azure_ad_token="secret-ad-token",
|
|
api_version="version",
|
|
)
|
|
assert cast(SecretStr, model.openai_api_key).get_secret_value() == "secret-api-key"
|
|
assert cast(SecretStr, model.azure_ad_token).get_secret_value() == "secret-ad-token"
|
|
|
|
|
|
@pytest.mark.parametrize("model_class", [ChatOpenAI, OpenAI, OpenAIEmbeddings])
|
|
def test_openai_api_key_is_secret_string(model_class: Type) -> None:
|
|
"""Test that the API key is stored as a SecretStr."""
|
|
model = model_class(openai_api_key="secret-api-key")
|
|
assert isinstance(model.openai_api_key, SecretStr)
|
|
|
|
|
|
@pytest.mark.parametrize("model_class", [ChatOpenAI, OpenAI, OpenAIEmbeddings])
|
|
def test_openai_api_key_masked_when_passed_from_env(
|
|
model_class: Type, monkeypatch: MonkeyPatch, capsys: CaptureFixture
|
|
) -> None:
|
|
"""Test that the API key is masked when passed from an environment variable."""
|
|
monkeypatch.setenv("OPENAI_API_KEY", "secret-api-key")
|
|
model = model_class()
|
|
print(model.openai_api_key, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
|
|
@pytest.mark.parametrize("model_class", [ChatOpenAI, OpenAI, OpenAIEmbeddings])
|
|
def test_openai_api_key_masked_when_passed_via_constructor(
|
|
model_class: Type, capsys: CaptureFixture
|
|
) -> None:
|
|
"""Test that the API key is masked when passed via the constructor."""
|
|
model = model_class(openai_api_key="secret-api-key")
|
|
print(model.openai_api_key, end="") # noqa: T201
|
|
captured = capsys.readouterr()
|
|
|
|
assert captured.out == "**********"
|
|
|
|
|
|
@pytest.mark.parametrize("model_class", [ChatOpenAI, OpenAI, OpenAIEmbeddings])
|
|
def test_openai_uses_actual_secret_value_from_secretstr(model_class: Type) -> None:
|
|
"""Test that the actual secret value is correctly retrieved."""
|
|
model = model_class(openai_api_key="secret-api-key")
|
|
assert cast(SecretStr, model.openai_api_key).get_secret_value() == "secret-api-key"
|
|
|
|
|
|
@pytest.mark.parametrize("model_class", [AzureChatOpenAI, AzureOpenAI])
|
|
def test_azure_serialized_secrets(model_class: Type) -> None:
|
|
"""Test that the actual secret value is correctly retrieved."""
|
|
model = model_class(
|
|
openai_api_key="secret-api-key", api_version="foo", azure_endpoint="foo"
|
|
)
|
|
serialized = dumpd(model)
|
|
assert serialized["kwargs"]["openai_api_key"]["id"] == ["AZURE_OPENAI_API_KEY"]
|
|
|
|
model = model_class(
|
|
azure_ad_token="secret-token", api_version="foo", azure_endpoint="foo"
|
|
)
|
|
serialized = dumpd(model)
|
|
assert serialized["kwargs"]["azure_ad_token"]["id"] == ["AZURE_OPENAI_AD_TOKEN"]
|