Skip to content

fix(report): add helpful migration errors for save_html/save_json/json in 0.7+ #1850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RaghavShah01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(report): add helpful migration errors for save_html/save_json/json in 0.7+ #1850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions src/evidently/core/report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -901,6 +901,44 @@ def __init__(
self.set_dataset_id(dataset_id)
self.include_tests = include_tests

# -----------------------------------------------------------------------
# Migration helpers: raise clear errors for methods that moved to Snapshot
# in Evidently 0.7+. Fixes: https://github.com/evidentlyai/evidently/issues/1595
# -----------------------------------------------------------------------

def save_html(self, filename: str) -> None:
raise AttributeError(
"\n\n`save_html` is not available on the `Report` object in Evidently >= 0.7.\n\n"
"In Evidently 0.7+, `report.run()` returns a `Snapshot` object.\n"
"Call `save_html` on that snapshot instead:\n\n"
" snapshot = report.run(current_data, reference_data)\n"
" snapshot.save_html('file.html')\n\n"
"To use the old API, pin: pip install 'evidently==0.6.7'\n"
"Migration guide: https://docs.evidentlyai.com/faq/migration\n"
)

def save_json(self, filename: str) -> None:
raise AttributeError(
"\n\n`save_json` is not available on the `Report` object in Evidently >= 0.7.\n\n"
"In Evidently 0.7+, `report.run()` returns a `Snapshot` object.\n"
"Call `save_json` on that snapshot instead:\n\n"
" snapshot = report.run(current_data, reference_data)\n"
" snapshot.save_json('file.json')\n\n"
"To use the old API, pin: pip install 'evidently==0.6.7'\n"
"Migration guide: https://docs.evidentlyai.com/faq/migration\n"
)

def json(self) -> str:
raise AttributeError(
"\n\n`.json()` is not available on the `Report` object in Evidently >= 0.7.\n\n"
"In Evidently 0.7+, `report.run()` returns a `Snapshot` object.\n"
"Call `.json()` on that snapshot instead:\n\n"
" snapshot = report.run(current_data, reference_data)\n"
" snapshot.json()\n\n"
"To use the old API, pin: pip install 'evidently==0.6.7'\n"
"Migration guide: https://docs.evidentlyai.com/faq/migration\n"
)

def run(
self,
current_data: PossibleDatasetTypes,
Expand Down