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

allow formatting the diff of ndarray attributes #3728

Merged
merged 3 commits into from
Feb 23, 2020
Merged

allow formatting the diff of ndarray attributes #3728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17beb66
allow comparing with ndarrays
keewis Jan 29, 2020
db06a15
add a test for the attrs diff repr
keewis Jan 29, 2020
62efdcc
use array_equiv instead of using all since the comparison may warn
keewis Jan 29, 2020
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
13 changes: 12 additions & 1 deletion xarray/core/formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,13 @@ def diff_dim_summary(a, b):


def _diff_mapping_repr(a_mapping, b_mapping, compat, title, summarizer, col_width=None):
def is_array_like(value):
return (
hasattr(value, "ndim")
and hasattr(value, "shape")
and hasattr(value, "dtype")
)
Comment on lines +503 to +508
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really sure if this is how array_like is defined

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable at the moment; unless anyone knows better?
This could move into utils if we get more confident (almost surprised we don't do this test elsewhere...)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have mostly been using __array_function__ instead, but that is not really sufficient: pint defines __array_function__ even if it wraps python scalars. In that case pint.Quantity is not array-like.


def extra_items_repr(extra_keys, mapping, ab_side):
extra_repr = [summarizer(k, mapping[k], col_width) for k in extra_keys]
if extra_repr:
Expand All @@ -522,7 +529,11 @@ def extra_items_repr(extra_keys, mapping, ab_side):
is_variable = True
except AttributeError:
# compare attribute value
compatible = a_mapping[k] == b_mapping[k]
if is_array_like(a_mapping[k]) or is_array_like(b_mapping[k]):
compatible = array_equiv(a_mapping[k], b_mapping[k])
else:
compatible = a_mapping[k] == b_mapping[k]

is_variable = False

if not compatible:
Expand Down
39 changes: 39 additions & 0 deletions xarray/tests/test_formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

import numpy as np
import pandas as pd
import pytest

import xarray as xr
from xarray.core import formatting
Expand Down Expand Up @@ -275,6 +276,44 @@ def test_diff_array_repr(self):
except AssertionError:
assert actual == expected.replace(", dtype=int64", "")

@pytest.mark.filterwarnings("error")
def test_diff_attrs_repr_with_array(self):
attrs_a = {"attr": np.array([0, 1])}

attrs_b = {"attr": 1}
expected = dedent(
"""\
Differing attributes:
L attr: [0 1]
R attr: 1
"""
).strip()
actual = formatting.diff_attrs_repr(attrs_a, attrs_b, "equals")
assert expected == actual

attrs_b = {"attr": np.array([-3, 5])}
expected = dedent(
"""\
Differing attributes:
L attr: [0 1]
R attr: [-3 5]
"""
).strip()
actual = formatting.diff_attrs_repr(attrs_a, attrs_b, "equals")
assert expected == actual

# should not raise a warning
attrs_b = {"attr": np.array([0, 1, 2])}
expected = dedent(
"""\
Differing attributes:
L attr: [0 1]
R attr: [0 1 2]
"""
).strip()
actual = formatting.diff_attrs_repr(attrs_a, attrs_b, "equals")
assert expected == actual

def test_diff_dataset_repr(self):
ds_a = xr.Dataset(
data_vars={
Expand Down