litellm/tests/documentation_tests/test_standard_logging_payload.py
yuneng-jiang 6a0d03914c
test: drop the cwd-relative sys.path.insert calls from the test suite (#37802)
* test: drop the cwd-relative sys.path.insert calls from the test suite

TQ003 stands at 1,077 across 1,058 files, and 1,015 of them are the same shape:
sys.path.insert(0, os.path.abspath("../..")) and its deeper siblings. The
argument resolves against the working directory rather than the file, so from
the repo root, where every job runs pytest, it inserts the directory two levels
above the checkout. It has never pointed at litellm. The package is installed
into the environment anyway, which is what actually makes the import work, and
what the rule's message has said all along.

Removing them leaves 1,634 imports of sys and os with no remaining reference,
and those go too, except where another test module imports the name back out of
the file. The rest of TQ003 is 62 call sites that resolve against __file__ or a
variable, which are a different question and are left alone.

Collection is identical either way: 45,871 tests and the same 51 pre-existing
collection errors before and after, and ruff reports no new undefined name.

* test: drop the duplicate imports the sys.path sweep exposed to F811

* test(pre-call-utils): restore the os import the new bedrock tests need
2026-08-22 09:25:58 -07:00

74 lines
2.5 KiB
Python

import re
from typing import get_type_hints
from litellm.types.utils import StandardLoggingPayload
def get_all_fields(type_dict, prefix=""):
"""Recursively get all fields from TypedDict and its nested types"""
fields = set()
# Get type hints for the TypedDict
hints = get_type_hints(type_dict)
for field_name, field_type in hints.items():
full_field_name = f"{prefix}{field_name}" if prefix else field_name
fields.add(full_field_name)
# Check if the field type is another TypedDict we should process
if hasattr(field_type, "__annotations__"):
nested_fields = get_all_fields(field_type)
fields.update(nested_fields)
return fields
def test_standard_logging_payload_documentation():
# Get all fields from StandardLoggingPayload and its nested types
all_fields = get_all_fields(StandardLoggingPayload)
print("All fields in StandardLoggingPayload: ")
for _field in all_fields:
print(_field)
# Read the documentation
docs_path = "../../docs/my-website/docs/proxy/logging_spec.md"
try:
with open(docs_path, "r", encoding="utf-8") as docs_file:
content = docs_file.read()
# Extract documented fields from the table
doc_field_pattern = re.compile(r"\|\s*`([^`]+?)`\s*\|")
documented_fields = set(doc_field_pattern.findall(content))
# Clean up documented fields (remove whitespace)
documented_fields = {field.strip() for field in documented_fields}
# Clean up documented fields (remove whitespace)
documented_fields = {field.strip() for field in documented_fields}
print("\n\nDocumented fields: ")
for _field in documented_fields:
print(_field)
# Compare and find undocumented fields
undocumented_fields = all_fields - documented_fields
print("\n\nUndocumented fields: ")
for _field in undocumented_fields:
print(_field)
if undocumented_fields:
raise Exception(
f"\nFields not documented in 'StandardLoggingPayload': {undocumented_fields}"
)
print(
f"All {len(all_fields)} fields are documented in 'StandardLoggingPayload'"
)
except FileNotFoundError:
raise Exception(
f"Documentation file not found at {docs_path}. Please ensure the documentation exists."
)