Skip to content
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.

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

[DataCatalog]: Error message is confusing when kedro-dataset is not installed #3911

Closed
ElenaKhaustova opened this issue Jun 3, 2024 · 2 comments · Fixed by #3952
Closed
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@ElenaKhaustova
Copy link
Contributor

ElenaKhaustova commented Jun 3, 2024

Description

When kedro-datasets is not installed the error message one gets is not informative.

We propose enhancing the error message to provide a clear message on the root cause of the failure - when dataset dependencies are missing.

Relates to #2401

Context

Currently, users are required to install all dependencies even for unused datasets (in case you want to run pipeline partially or do not load some datasets when standalone catalog usage). The error message generated when some datasets are not installed is unclear, making it difficult for users to understand why the pipeline fails.

Example of the current error message:

DatasetError: An exception occurred when parsing config for dataset 'companies':
Class 'pandas.CSVDataset' not found, is this a typo?

This error occurs during dataset configuration parsing and lacks clarity, not suggesting the straightforward solution of installing the necessary package. This can lead to confusion and delays as users may not immediately realize that the issue is due to missing software rather than a typo in their configuration.

@ElenaKhaustova ElenaKhaustova added the Issue: Feature Request New feature or improvement to existing feature label Jun 3, 2024
@iamelijahko iamelijahko changed the title [DataCatalog]: Error message is confusing when dataset is not installed [DataCatalog]: Error message is confusing when kedro-dataset is not installed Jun 3, 2024
@merelcht merelcht added this to the Improve Developer Experience milestone Jun 3, 2024
@astrojuanlu
Copy link
Member

astrojuanlu commented Jun 6, 2024

Related to #2943

@astrojuanlu
Copy link
Member

Also, as much as I'd like to see a more explicit call for users to pip install kedro-datasets[whatever], it's also true that kedro-datasets is not, and should not, be the only package providing the datasets the user is looking for...

The phrasing of the error message & call to action here is important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
Archived in project
5 participants