Ouranosinc / xscen / 9703494924
87%

DEFAULT BRANCH: main
Ran
Jobs 8
Files 152
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
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

Uncovered Existing Lines

Lines Coverage ∆ File
16
77.84
 -0.09% /home/runner/micromamba/envs/xscen-dev/lib/python3.9/site-packages/xscen/extract.py
16
77.84
 -0.09% .tox/py39-coveralls/lib/python3.9/site-packages/xscen/extract.py
17
77.69
 -0.09% /home/runner/micromamba/envs/xscen-dev/lib/python3.12/site-packages/xscen/extract.py
17
77.69
 -0.09% /home/runner/micromamba/envs/xscen-dev/lib/python3.11/site-packages/xscen/extract.py
17
77.69
 -0.09% .tox/py310-coveralls/lib/python3.10/site-packages/xscen/extract.py
17
77.69
 -0.09% .tox/py311-coveralls/lib/python3.11/site-packages/xscen/extract.py
17
77.69
 -0.09% /home/runner/micromamba/envs/xscen-dev/lib/python3.10/site-packages/xscen/extract.py
17
77.69
 -0.09% .tox/py312-esmpy-coveralls/lib/python3.12/site-packages/xscen/extract.py
Jobs
ID Job ID Ran Files Coverage
1 run-Python3.9-conda - 9703494924.1 19
73.33
 GitHub Action Run
2 run-Python3.11 - 9703494924.2 19
70.9
 GitHub Action Run
3 run-Python3.11-conda - 9703494924.3 19
73.37
 GitHub Action Run
4 run-Python3.9 - 9703494924.4 19
70.86
 GitHub Action Run
5 run-Python3.12 - 9703494924.5 19
70.9
 GitHub Action Run
6 run-Python3.10 - 9703494924.6 19
70.9
 GitHub Action Run
7 run-Python3.12-conda - 9703494924.7 19
73.37
 GitHub Action Run
8 run-Python3.10-conda - 9703494924.8 19
73.37
 GitHub Action Run
Source Files on build 9703494924