[ ] This PR addresses an already opened issue (for bug fixes / features)
This PR fixes #xyz
[ ] (If applicable) Documentation has been added / updated (for bug fixes / features).
[ ] (If applicable) Tests have been added.
[x] This PR does not seem to break the templates.
[x] CHANGELOG.rst has been updated (with summary of main changes).
[x] Link to issue (:issue:number) and pull request (:pull:number) has been added.
What kind of change does this PR introduce?
Rewrite the first part of search_data_catalogs so that we do not modify the mutable input argument data_catalogs.
If this argument is coming from a config dictionary, this had the unwanted consquence of changing the config entry from a path to a DataCatalog instance. Which could have unexpected consequences.
In our usual xscen usage, the config dictionary is an instance of xscen.config.ConfigDict which has the magical ability of copying itself each time a section is accessed (i.e. CONFIG['section'] actually returns a copy of the "section" sub-dictionary and not a reference to the CONFIG dictionary itself.). And so we didn't notice the issue.
Pull Request Checklist:
number) and pull request (:pull:number) has been added.What kind of change does this PR introduce?
search_data_catalogsso that we do not modify the mutable input argumentdata_catalogs.If this argument is coming from a config dictionary, this had the unwanted consquence of changing the config entry from a path to a
DataCataloginstance. Which could have unexpected consequences.In our usual xscen usage, the config dictionary is an instance of
xscen.config.ConfigDictwhich has the magical ability of copying itself each time a section is accessed (i.e.CONFIG['section']actually returns a copy of the "section" sub-dictionary and not a reference to theCONFIGdictionary itself.). And so we didn't notice the issue.Does this PR introduce a breaking change?
I hope not.
Other information: