Ouranosinc / xscen / 9703494924

coverage: 72.125% (-0.01%) from 72.139%
9703494924

push

github

web-flow 
Dont change mutable input argument of search_data_catalog (#413)

<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [ ] 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.

### Does this PR introduce a breaking change?
I hope not.

### Other information:

23344 of 32366 relevant lines covered (72.13%)

0.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.69
/.tox/py312-esmpy-coveralls/lib/python3.12/site-packages/xscen/extract.py


Source Not Available

The file ".tox/py312-esmpy-coveralls/lib/python3.12/site-packages/xscen/extract.py" isn't available on github. Either it's been removed, or the repo root directory needs to be updated.