Skip to content

Commit

Permalink
Added a note about to_config() constraints
Browse files Browse the repository at this point in the history
Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>
  • Loading branch information
ElenaKhaustova committed Nov 27, 2024
1 parent 0db9b46 commit 2f72e23
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion kedro/io/kedro_data_catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -378,9 +378,14 @@ def to_config(
dict[str, str | None],
str | None,
]:
"""Converts the KedroDataCatalog instance into a configuration format suitable for
"""Converts the `KedroDataCatalog` instance into a configuration format suitable for
serialization. This includes datasets, credentials, and versioning information.
This method is only applicabe to catalogs that contain datasets initialized with static, primitive
parameters. For example, it will work fine if one passes credentials as dictionary to
`GBQQueryDataset` but not as `google.auth.credentials.Credentials` object. See
https://github.com/kedro-org/kedro-plugins/issues/950 for the details.
Returns:
A tuple containing:
catalog: A dictionary mapping dataset names to their unresolved configurations,
Expand Down

0 comments on commit 2f72e23

Please sign in to comment.