forked from metoppv/improver
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into snow_splitter_names
* master: Bump actions/stale from 8 to 9 (metoppv#1972) Bump codecov/codecov-action from 3 to 4 (metoppv#1942) Bump actions/cache from 3 to 4 (metoppv#1977) Adds CLI to copy attributes from one NetCDF file to another. (metoppv#1976)
- Loading branch information
Showing
6 changed files
with
133 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| #!/usr/bin/env python | ||
| # -*- coding: utf-8 -*- | ||
| # ----------------------------------------------------------------------------- | ||
| # (C) British Crown copyright. The Met Office. | ||
| # All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are met: | ||
| # | ||
| # * Redistributions of source code must retain the above copyright notice, this | ||
| # list of conditions and the following disclaimer. | ||
| # | ||
| # * Redistributions in binary form must reproduce the above copyright notice, | ||
| # this list of conditions and the following disclaimer in the documentation | ||
| # and/or other materials provided with the distribution. | ||
| # | ||
| # * Neither the name of the copyright holder nor the names of its | ||
| # contributors may be used to endorse or promote products derived from | ||
| # this software without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| # POSSIBILITY OF SUCH DAMAGE. | ||
| """Script to copy attributes from template_cube to cube""" | ||
|
|
||
| from improver import cli | ||
|
|
||
|
|
||
| @cli.clizefy | ||
| @cli.with_output | ||
| def process( | ||
| cube: cli.inputcube, | ||
| template_cube: cli.inputcube, | ||
| *, | ||
| attributes: cli.comma_separated_list, | ||
| ): | ||
| """ | ||
| Copy attribute values from template_cube to cube, overwriting any existing values. | ||
| Args: | ||
| cube (iris.cube.Cube): | ||
| Source cube to be updated. | ||
| template_cube (iris.cube.Cube): | ||
| Source cube to get attribute values from. | ||
| attributes (list): | ||
| List of names of attributes to copy. If any are not present on template_cube, a | ||
| KeyError will be raised. | ||
| Returns: | ||
| iris.cube.Cube | ||
| """ | ||
| from improver.metadata.amend import amend_attributes | ||
|
|
||
| new_attributes = {k: template_cube.attributes[k] for k in attributes} | ||
| amend_attributes(cube, new_attributes) | ||
| return cube |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # ----------------------------------------------------------------------------- | ||
| # (C) British Crown copyright. The Met Office. | ||
| # All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are met: | ||
| # | ||
| # * Redistributions of source code must retain the above copyright notice, this | ||
| # list of conditions and the following disclaimer. | ||
| # | ||
| # * Redistributions in binary form must reproduce the above copyright notice, | ||
| # this list of conditions and the following disclaimer in the documentation | ||
| # and/or other materials provided with the distribution. | ||
| # | ||
| # * Neither the name of the copyright holder nor the names of its | ||
| # contributors may be used to endorse or promote products derived from | ||
| # this software without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| # POSSIBILITY OF SUCH DAMAGE. | ||
| """ | ||
| Tests for the copy-attributes CLI | ||
| """ | ||
|
|
||
| import pytest | ||
|
|
||
| from . import acceptance as acc | ||
|
|
||
| pytestmark = [pytest.mark.acc, acc.skip_if_kgo_missing] | ||
| CLI = acc.cli_name_with_dashes(__file__) | ||
| run_cli = acc.run_cli(CLI) | ||
|
|
||
|
|
||
| def test_change_metadata(tmp_path): | ||
| """Test copying attribute values from a template file""" | ||
| kgo_dir = acc.kgo_root() / "copy-attributes" | ||
| kgo_path = kgo_dir / "kgo.nc" | ||
| input_path = kgo_dir / "input.nc" | ||
| template_path = kgo_dir / "stage_input.nc" | ||
| output_path = tmp_path / "output.nc" | ||
| args = [ | ||
| input_path, | ||
| template_path, | ||
| "--attributes", | ||
| "mosg__forecast_run_duration,mosg__grid_version", | ||
| "--output", | ||
| output_path, | ||
| ] | ||
| run_cli(args) | ||
| acc.compare(output_path, kgo_path) |