Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce duplication in cf.py spanning checks #6196

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Reduce duplication in cf.py spanning checks #6196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ This document explains the changes made to Iris for this release
#. `@trexfeathers`_ adapted Iris to work with Cartopy v0.24. (:pull:`6171`,
:pull:`6172`)

#. `@trexfeathers`_ refactored spanning checks in :mod:`iris.fileformats.cf`
to reduce code duplication. (:pull:`6196`)


.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
Expand Down
79 changes: 33 additions & 46 deletions lib/iris/fileformats/cf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from collections.abc import Iterable, MutableMapping
import os
import re
from typing import ClassVar
from typing import ClassVar, Optional
import warnings

import numpy as np
Expand Down Expand Up @@ -1448,6 +1448,35 @@ def _build(cf_variable):
coordinate_names = list(self.cf_group.coordinates.keys())
cf_group = self.CFGroup()

def _span_check(
var_name: str, via_formula_terms: Optional[str] = None
) -> None:
"""Sanity check dimensionality."""
var = self.cf_group[var_name]
# No span check is necessary if variable is attached to a mesh.
if is_mesh_var or var.spans(cf_variable):
cf_group[var_name] = var
else:
# Register the ignored variable.
# N.B. 'ignored' variable from enclosing scope.
ignored.add(var_name)

text_formula = text_via = ""
if via_formula_terms:
text_formula = " formula terms"
text_via = f" via variable {via_formula_terms}"

message = (
f"Ignoring{text_formula} variable {var_name} "
f"referenced by variable {cf_variable.cf_name}"
f"{text_via}: Dimensions {var.dimensions} do not span "
f"{cf_variable.dimensions}"
)
warnings.warn(
message,
category=iris.warnings.IrisCfNonSpanningVarWarning,
)

# Build CF variable relationships.
for variable_type in self._variable_types:
ignore = []
Expand All @@ -1466,28 +1495,8 @@ def _build(cf_variable):
warn=False,
)
# Sanity check dimensionality coverage.
for cf_name, cf_var in match.items():
# No span check is necessary if variable is attached to a mesh.
if is_mesh_var or cf_var.spans(cf_variable):
cf_group[cf_name] = self.cf_group[cf_name]
else:
# Register the ignored variable.
# N.B. 'ignored' variable from enclosing scope.
ignored.add(cf_name)
msg = (
"Ignoring variable {!r} referenced "
"by variable {!r}: Dimensions {!r} do not "
"span {!r}".format(
cf_name,
cf_variable.cf_name,
cf_var.dimensions,
cf_variable.dimensions,
)
)
warnings.warn(
msg,
category=iris.warnings.IrisCfNonSpanningVarWarning,
)
for cf_name in match:
_span_check(cf_name)

# Build CF data variable relationships.
if isinstance(cf_variable, CFDataVariable):
Expand All @@ -1514,29 +1523,7 @@ def _build(cf_variable):
for cf_var in self.cf_group.formula_terms.values():
for cf_root in cf_var.cf_terms_by_root:
if cf_root in cf_group and cf_var.cf_name not in cf_group:
# Sanity check dimensionality.
if cf_var.spans(cf_variable):
cf_group[cf_var.cf_name] = cf_var
else:
# Register the ignored variable.
# N.B. 'ignored' variable from enclosing scope.
ignored.add(cf_var.cf_name)
msg = (
"Ignoring formula terms variable {!r} "
"referenced by data variable {!r} via "
"variable {!r}: Dimensions {!r} do not "
"span {!r}".format(
cf_var.cf_name,
cf_variable.cf_name,
cf_root,
cf_var.dimensions,
cf_variable.dimensions,
)
)
warnings.warn(
msg,
category=iris.warnings.IrisCfNonSpanningVarWarning,
)
_span_check(cf_var.cf_name, cf_root)

# Add the CF group to the variable.
cf_variable.cf_group = cf_group
Expand Down
Loading