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]: Improve the way to access namespaced datasets with _FrozenDataset API #3928

Closed
ElenaKhaustova opened this issue Jun 5, 2024 · 2 comments
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@ElenaKhaustova
Copy link
Contributor

ElenaKhaustova commented Jun 5, 2024

Description

Users struggle with the _FrozenDataset's API when accessing namespaced datasets because it uses double underscores instead of dots, which they find unintuitive and cumbersome. Some prefer referring to the dataset by its original name, so they use the private _get_dataset() method instead.

We propose to:

  1. Explore the feasibility of modifying the _FrozenDataset's API to use dots instead of double underscores for namespaces, aligning with users' expectations.
  2. Provide an opportunity to call datasets by their exact names - get dataset by name function.

Relates to #3926

Context

User feedback:

  • C1 team finds the replacement of characters like “.” or “@” with “__” in dataset names to be unclean and prefers calling datasets by their exact names.
  • "There's a problem with names space data sets, but that's not the end of the world because you can do getattr(catalog.datasets, "namespace.dataset"). So it's still possible but it's just like horribly ugly. Also, it just doesn't feel natural, to me, the catalog feels like it should operate as a dictionary. And therefore access should be by get_item rather than get_attribute. "
  • "The use of double underscores instead of dots for namespaces in the catalog might be unintuitive for users, making the functionality feel awkward and overly complex. This could lead to difficulties in navigating and using namespaces effectively."
@merelcht
Copy link
Member

FYI the PR in which the double underscore syntax was introduced: #487

@ElenaKhaustova
Copy link
Contributor Author

Solved in #4218

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
Status: Done
Development

No branches or pull requests

2 participants