Pretty printing: `DataCatalog.__repr__`

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.

https://kedro.org

Apache License 2.0

9.88k stars 893 forks source link

Pretty printing: `DataCatalog.repr` #3981

Closed ElenaKhaustova closed 2 months ago

ElenaKhaustova commented 3 months ago

Description

Parent ticket: https://github.com/kedro-org/kedro/issues/3913 Blocked by: https://github.com/kedro-org/kedro/issues/3980

Implement __repr__ for DataCatalog for better catalog representation and printing.

Context

https://github.com/kedro-org/kedro/issues/3913#issue-2330910213 https://github.com/kedro-org/kedro/issues/1721

Possible Implementation

Implement AbstractDataset pretty printing: https://github.com/kedro-org/kedro/issues/3980
implement __repr__ for DataCatalog based on dataset's __repr__

ElenaKhaustova commented 3 months ago

Similarly to printing datasets two approaches were implemented:

both approaches implement __repr__() method for _FrozenDatasets and DataCatalog based on the implementation __repr__() for dataset with aadded top-level keys - datastets' names. Since __str__method is not implemented __repr__() is called when converting object to string, so we have the same results when print(obj), obj.
https://github.com/kedro-org/kedro/pull/3990

Screenshot 2024-07-05 at 00 31 48 Screenshot 2024-07-05 at 00 32 10

https://github.com/kedro-org/kedro/pull/3992

ElenaKhaustova commented 2 months ago

The non-indented version was preferred to the indented, closing #3992