Skip to content
Navigation Menu
{{ message }}
forked from igerber/diff-diff
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_visualization_plotly.py
More file actions
522 lines (403 loc) · 17.7 KB
/
Copy pathtest_visualization_plotly.py
File metadata and controls
522 lines (403 loc) · 17.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
"""Plotly-only visualization tests — no matplotlib dependency.
This file tests the plotly backend without requiring matplotlib,
exercising the advertised ``pip install diff-diff[plotly]`` path.
"""
from unittest.mock import MagicMock
import numpy as np
import pytest
go = pytest.importorskip("plotly.graph_objects")
# ── Fixtures ──────────────────────────────────────────────────────────────────
@pytest.fixture
def cs_results():
"""Mock CallawaySantAnnaResults."""
results = MagicMock()
results.groups = [2004, 2006]
results.time_periods = [2003, 2004, 2005, 2006, 2007]
results.group_time_effects = {
(2004, 2003): {
"effect": 0.02,
"se": 0.1,
"p_value": 0.84,
"n_treated": 50,
"n_control": 100,
},
(2004, 2004): {
"effect": 0.5,
"se": 0.12,
"p_value": 0.001,
"n_treated": 50,
"n_control": 100,
},
(2006, 2006): {
"effect": 0.4,
"se": 0.12,
"p_value": 0.001,
"n_treated": 30,
"n_control": 100,
},
}
return results
@pytest.fixture
def sensitivity_results():
"""Mock SensitivityResults."""
results = MagicMock()
results.M_values = np.array([0, 0.5, 1.0, 1.5, 2.0])
results.bounds = [(0.3, 0.7), (0.2, 0.8), (0.1, 0.9), (0.0, 1.0), (-0.1, 1.1)]
results.robust_cis = [(0.1, 0.9), (0.0, 1.0), (-0.1, 1.1), (-0.2, 1.2), (-0.3, 1.3)]
results.original_estimate = 0.5
results.breakdown_M = 1.5
return results
@pytest.fixture
def honest_results():
"""Mock HonestDiDResults."""
results = MagicMock()
results.alpha = 0.05
results.M = 1.0
results.event_study_bounds = {
-2: {"ci_lb": -0.3, "ci_ub": 0.3},
-1: {"ci_lb": -0.2, "ci_ub": 0.2},
0: {"ci_lb": 0.1, "ci_ub": 0.9},
1: {"ci_lb": 0.2, "ci_ub": 1.0},
}
original = MagicMock()
original.period_effects = {
-2: MagicMock(effect=0.05, se=0.1),
-1: MagicMock(effect=0.0, se=0.1),
0: MagicMock(effect=0.5, se=0.12),
1: MagicMock(effect=0.6, se=0.13),
}
results.original_results = original
return results
@pytest.fixture
def bacon_results():
"""Mock BaconDecompositionResults."""
results = MagicMock()
results.comparisons = [
MagicMock(comparison_type="treated_vs_never", estimate=1.0, weight=0.5),
MagicMock(comparison_type="earlier_vs_later", estimate=0.8, weight=0.3),
MagicMock(comparison_type="later_vs_earlier", estimate=0.6, weight=0.2),
]
results.twfe_estimate = 0.85
results.effect_by_type.return_value = {
"treated_vs_never": 1.0,
"earlier_vs_later": 0.8,
"later_vs_earlier": 0.6,
}
results.weight_by_type.return_value = {
"treated_vs_never": 0.5,
"earlier_vs_later": 0.3,
"later_vs_earlier": 0.2,
}
return results
# ── Color Parser (no matplotlib needed) ──────────────────────────────────────
class TestColorParser:
"""_color_to_rgba must work without matplotlib installed."""
def test_hex_6digit(self):
from diff_diff.visualization._common import _color_to_rgba
assert _color_to_rgba("#2563eb", 0.5) == "rgba(37, 99, 235, 0.5)"
def test_hex_3digit(self):
from diff_diff.visualization._common import _color_to_rgba
assert _color_to_rgba("#abc", 0.3) == "rgba(170, 187, 204, 0.3)"
def test_named_common(self):
from diff_diff.visualization._common import _color_to_rgba
assert _color_to_rgba("red", 1.0) == "rgba(255, 0, 0, 1.0)"
assert _color_to_rgba("lightgray", 0.5) == "rgba(211, 211, 211, 0.5)"
def test_named_css_extended(self):
"""Colors outside the original hand-maintained subset."""
from diff_diff.visualization._common import _color_to_rgba
assert _color_to_rgba("lightblue", 0.3) == "rgba(173, 216, 230, 0.3)"
assert _color_to_rgba("cornflowerblue", 0.5) == "rgba(100, 149, 237, 0.5)"
assert _color_to_rgba("tomato", 1.0) == "rgba(255, 99, 71, 1.0)"
def test_rgb_string(self):
from diff_diff.visualization._common import _color_to_rgba
assert _color_to_rgba("rgb(100, 200, 50)", 0.7) == "rgba(100, 200, 50, 0.7)"
def test_rgba_string_alpha_override(self):
from diff_diff.visualization._common import _color_to_rgba
result = _color_to_rgba("rgba(100, 200, 50, 0.9)", 0.3)
assert result == "rgba(100, 200, 50, 0.3)"
def test_unknown_color_raises(self):
from diff_diff.visualization._common import _color_to_rgba
with pytest.raises(ValueError, match="Cannot parse color"):
_color_to_rgba("not_a_real_color")
# ── Plotly Smoke Tests (no matplotlib) ────────────────────────────────────────
class TestPlotlySensitivity:
"""Plotly backend for plot_sensitivity."""
def test_basic(self, sensitivity_results):
from diff_diff.visualization import plot_sensitivity
fig = plot_sensitivity(sensitivity_results, backend="plotly", show=False)
assert isinstance(fig, go.Figure)
def test_named_color(self, sensitivity_results):
from diff_diff.visualization import plot_sensitivity
fig = plot_sensitivity(
sensitivity_results,
bounds_color="cornflowerblue",
ci_color="tomato",
backend="plotly",
show=False,
)
assert isinstance(fig, go.Figure)
class TestPlotlyHonestEventStudy:
"""Plotly backend for plot_honest_event_study."""
def test_basic(self, honest_results):
from diff_diff.visualization import plot_honest_event_study
fig = plot_honest_event_study(honest_results, backend="plotly", show=False)
assert isinstance(fig, go.Figure)
def test_named_color(self, honest_results):
from diff_diff.visualization import plot_honest_event_study
fig = plot_honest_event_study(
honest_results,
original_color="lightblue",
honest_color="steelblue",
backend="plotly",
show=False,
)
assert isinstance(fig, go.Figure)
class TestPlotlyBaconBar:
"""Plotly backend for plot_bacon with plot_type='bar'."""
def test_bar_basic(self, bacon_results):
from diff_diff.visualization import plot_bacon
fig = plot_bacon(bacon_results, plot_type="bar", backend="plotly", show=False)
assert isinstance(fig, go.Figure)
def test_scatter_weighted_avg(self, bacon_results):
from diff_diff.visualization import plot_bacon
fig = plot_bacon(bacon_results, show_weighted_avg=True, backend="plotly", show=False)
assert isinstance(fig, go.Figure)
# Should have shapes from weighted avg + TWFE + zero vlines
assert len(fig.layout.shapes) >= 4
class TestPlotlyEventStudyExtended:
"""Extended plotly event study coverage."""
def test_css_color_outside_original_subset(self):
from diff_diff import plot_event_study
effects = {-1: 0.0, 0: 0.5, 1: 0.6}
se = {-1: 0.0, 0: 0.15, 1: 0.15}
fig = plot_event_study(
effects=effects,
se=se,
color="steelblue",
shade_color="lavender",
pre_periods=[-1],
post_periods=[0, 1],
shade_pre=True,
backend="plotly",
show=False,
)
assert isinstance(fig, go.Figure)
class TestPlotlyHeatmapMasking:
"""Regression: mask_insignificant must grey out, not NaN-ify cells."""
def test_mask_preserves_values(self, cs_results):
from diff_diff.visualization import plot_group_time_heatmap
fig = plot_group_time_heatmap(
cs_results, mask_insignificant=True, backend="plotly", show=False
)
assert isinstance(fig, go.Figure)
# Should have 2 traces: main heatmap + grey overlay
assert len(fig.data) == 2
# Main heatmap should NOT have NaN where cells were insignificant
import numpy as np
main_z = fig.data[0].z
assert np.any(np.isfinite(main_z))
def test_no_mask_single_trace(self, cs_results):
from diff_diff.visualization import plot_group_time_heatmap
fig = plot_group_time_heatmap(
cs_results, mask_insignificant=False, backend="plotly", show=False
)
assert isinstance(fig, go.Figure)
assert len(fig.data) == 1 # Only main heatmap, no overlay
def test_cmap_not_swapped(self, cs_results):
"""RdBu_r should not be swapped — last color should be warm (red)."""
from diff_diff.visualization import plot_group_time_heatmap
fig = plot_group_time_heatmap(cs_results, cmap="RdBu_r", backend="plotly", show=False)
assert isinstance(fig, go.Figure)
# Plotly resolves named colorscales to tuples. RdBu_r ends with red.
cs = fig.data[0].colorscale
# Last entry should be a reddish color (high R value)
last_color = cs[-1][1] # e.g. "rgb(103,0,31)"
assert "103" in last_color or "178" in last_color # dark red end of RdBu_r
class TestTopLevelExports:
"""Regression: new plot functions must be in diff_diff.__all__."""
def test_all_plots_in_all(self):
import diff_diff
for name in [
"plot_bacon",
"plot_event_study",
"plot_group_effects",
"plot_sensitivity",
"plot_honest_event_study",
"plot_power_curve",
"plot_pretrends_power",
"plot_synth_weights",
"plot_staircase",
"plot_dose_response",
"plot_group_time_heatmap",
]:
assert name in diff_diff.__all__, f"{name} missing from diff_diff.__all__"
def test_no_duplicates_in_all(self):
import diff_diff
seen = set()
for name in diff_diff.__all__:
assert name not in seen, f"Duplicate in __all__: {name}"
seen.add(name)
class TestPlotlyEventStudyHover:
"""Regression: plotly event study must preserve period labels in hover."""
def test_string_periods_in_customdata(self):
from diff_diff import plot_event_study
effects = {"pre": 0.0, "post": 0.5}
se = {"pre": 0.1, "post": 0.15}
fig = plot_event_study(effects=effects, se=se, backend="plotly", show=False)
# At least one point trace should have customdata with original labels
point_traces = [t for t in fig.data if t.mode == "markers"]
assert len(point_traces) > 0
for trace in point_traces:
assert trace.customdata is not None, "Missing customdata on point trace"
assert trace.hovertemplate is not None, "Missing hovertemplate"
# ── Marker Mapping ──────────────────────────────────────────────────────────
class TestMarkerMapping:
"""Unit tests for _mpl_marker_to_plotly_symbol."""
def test_common_markers(self):
from diff_diff.visualization._common import _mpl_marker_to_plotly_symbol
assert _mpl_marker_to_plotly_symbol("o") == "circle"
assert _mpl_marker_to_plotly_symbol("s") == "square"
assert _mpl_marker_to_plotly_symbol("D") == "diamond"
assert _mpl_marker_to_plotly_symbol("^") == "triangle-up"
assert _mpl_marker_to_plotly_symbol("v") == "triangle-down"
assert _mpl_marker_to_plotly_symbol("+") == "cross"
assert _mpl_marker_to_plotly_symbol("x") == "x"
assert _mpl_marker_to_plotly_symbol("*") == "star"
def test_dot_marker(self):
from diff_diff.visualization._common import _mpl_marker_to_plotly_symbol
assert _mpl_marker_to_plotly_symbol(".") == "circle"
def test_unknown_marker_returns_circle(self):
from diff_diff.visualization._common import _mpl_marker_to_plotly_symbol
assert _mpl_marker_to_plotly_symbol("Z") == "circle"
assert _mpl_marker_to_plotly_symbol("???") == "circle"
# ── Plotly Styling Kwargs ───────────────────────────────────────────────────
class TestPlotlyEventStudyStyling:
"""Verify styling kwargs reach plotly traces."""
def test_marker_and_size_threaded(self):
from diff_diff import plot_event_study
effects = {-1: 0.0, 0: 0.5, 1: 0.6}
se = {-1: 0.1, 0: 0.15, 1: 0.15}
fig = plot_event_study(
effects=effects,
se=se,
marker="s",
markersize=12,
backend="plotly",
show=False,
)
point_traces = [t for t in fig.data if t.mode == "markers"]
assert len(point_traces) > 0
for trace in point_traces:
assert trace.marker.size == 12
assert trace.marker.symbol == "square"
def test_default_marker_values(self):
from diff_diff import plot_event_study
effects = {0: 0.5}
se = {0: 0.1}
fig = plot_event_study(effects=effects, se=se, backend="plotly", show=False)
point_traces = [t for t in fig.data if t.mode == "markers"]
assert len(point_traces) > 0
# Default: marker="o" -> circle, markersize=8
for trace in point_traces:
assert trace.marker.size == 8
assert trace.marker.symbol == "circle"
class TestPlotlyHonestEventStudyStyling:
"""Verify styling kwargs reach honest event study plotly traces."""
def test_marker_symbol_threaded(self, honest_results):
from diff_diff.visualization import plot_honest_event_study
fig = plot_honest_event_study(
honest_results, marker="D", markersize=14, backend="plotly", show=False
)
point_traces = [t for t in fig.data if t.mode == "markers"]
assert len(point_traces) > 0
for trace in point_traces:
assert trace.marker.size == 14
assert trace.marker.symbol == "diamond"
class TestPlotlySensitivityStyling:
"""Verify ci_linewidth reaches plotly CI line traces."""
def test_ci_linewidth_threaded(self, sensitivity_results):
from diff_diff.visualization import plot_sensitivity
fig = plot_sensitivity(sensitivity_results, ci_linewidth=3.0, backend="plotly", show=False)
# CI traces are lines (not fills) with name "Robust CI"
ci_traces = [t for t in fig.data if t.mode == "lines" and t.name == "Robust CI"]
assert len(ci_traces) > 0
for trace in ci_traces:
assert trace.line.width == 3.0
class TestPlotlyBaconStyling:
"""Verify marker/markersize reach Bacon scatter plotly traces."""
def test_marker_and_size_threaded(self, bacon_results):
from diff_diff.visualization import plot_bacon
fig = plot_bacon(
bacon_results,
marker="^",
markersize=100,
backend="plotly",
show=False,
)
scatter_traces = [t for t in fig.data if t.mode == "markers"]
assert len(scatter_traces) > 0
for trace in scatter_traces:
assert trace.marker.symbol == "triangle-up"
# sqrt(100) = 10
assert trace.marker.size == 10
class TestPlotlyPowerCurveStyling:
"""Verify linewidth and show_grid reach plotly power curve."""
def test_linewidth_threaded(self):
from diff_diff.visualization import plot_power_curve
fig = plot_power_curve(
effect_sizes=[0.1, 0.2, 0.3],
powers=[0.3, 0.6, 0.9],
linewidth=3.5,
backend="plotly",
show=False,
)
line_traces = [t for t in fig.data if t.mode == "lines"]
assert len(line_traces) > 0
assert line_traces[0].line.width == 3.5
def test_show_grid_false(self):
from diff_diff.visualization import plot_power_curve
fig = plot_power_curve(
effect_sizes=[0.1, 0.2, 0.3],
powers=[0.3, 0.6, 0.9],
show_grid=False,
backend="plotly",
show=False,
)
assert fig.layout.xaxis.showgrid is False
assert fig.layout.yaxis.showgrid is False
def test_show_grid_true(self):
from diff_diff.visualization import plot_power_curve
fig = plot_power_curve(
effect_sizes=[0.1, 0.2, 0.3],
powers=[0.3, 0.6, 0.9],
show_grid=True,
backend="plotly",
show=False,
)
assert fig.layout.xaxis.showgrid is True
assert fig.layout.yaxis.showgrid is True
class TestPlotlyPretrendsPowerStyling:
"""Verify linewidth and show_grid reach plotly pretrends power curve."""
def test_linewidth_threaded(self):
from diff_diff.visualization import plot_pretrends_power
fig = plot_pretrends_power(
M_values=[0.0, 0.5, 1.0],
powers=[0.1, 0.5, 0.8],
linewidth=4.0,
backend="plotly",
show=False,
)
line_traces = [t for t in fig.data if t.mode == "lines"]
assert len(line_traces) > 0
assert line_traces[0].line.width == 4.0
def test_show_grid_false(self):
from diff_diff.visualization import plot_pretrends_power
fig = plot_pretrends_power(
M_values=[0.0, 0.5, 1.0],
powers=[0.1, 0.5, 0.8],
show_grid=False,
backend="plotly",
show=False,
)
assert fig.layout.xaxis.showgrid is False
assert fig.layout.yaxis.showgrid is False
You can’t perform that action at this time.