Skip to content

Commit 0a1e36d

Browse files
committed
Add friendlier error when .show() used
Fixes #8499
1 parent 90714c1 commit 0a1e36d

File tree

4 files changed

+30
-0
lines changed

4 files changed

+30
-0
lines changed

locale/circuitpython.pot

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,12 @@ msgstr ""
434434
msgid ", in %q\n"
435435
msgstr ""
436436

437+
#: shared-bindings/displayio/Display.c
438+
#: shared-bindings/displayio/EPaperDisplay.c
439+
#: shared-bindings/framebufferio/FramebufferDisplay.c
440+
msgid ".show(x) removed. Use .root_group = x"
441+
msgstr ""
442+
437443
#: py/objcomplex.c
438444
msgid "0.0 to a complex power"
439445
msgstr ""

shared-bindings/busdisplay/BusDisplay.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,13 @@ static busdisplay_busdisplay_obj_t *native_display(mp_obj_t display_obj) {
245245
return MP_OBJ_TO_PTR(native_display);
246246
}
247247

248+
// Undocumented show() implementation with a friendly error message.
249+
STATIC mp_obj_t busdisplay_busdisplay_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
250+
mp_raise_AttributeError(translate(".show(x) removed. Use .root_group = x"));
251+
return mp_const_none;
252+
}
253+
MP_DEFINE_CONST_FUN_OBJ_2(busdisplay_busdisplay_show_obj, busdisplay_busdisplay_obj_show);
254+
248255
//| def refresh(
249256
//| self,
250257
//| *,
@@ -491,6 +498,7 @@ STATIC mp_obj_t busdisplay_busdisplay_obj_fill_row(size_t n_args, const mp_obj_t
491498
MP_DEFINE_CONST_FUN_OBJ_KW(busdisplay_busdisplay_fill_row_obj, 1, busdisplay_busdisplay_obj_fill_row);
492499

493500
STATIC const mp_rom_map_elem_t busdisplay_busdisplay_locals_dict_table[] = {
501+
{ MP_ROM_QSTR(MP_QSTR_show), MP_ROM_PTR(&busdisplay_busdisplay_show_obj) },
494502
{ MP_ROM_QSTR(MP_QSTR_refresh), MP_ROM_PTR(&busdisplay_busdisplay_refresh_obj) },
495503
{ MP_ROM_QSTR(MP_QSTR_fill_row), MP_ROM_PTR(&busdisplay_busdisplay_fill_row_obj) },
496504

shared-bindings/epaperdisplay/EPaperDisplay.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,13 @@ static epaperdisplay_epaperdisplay_obj_t *native_display(mp_obj_t display_obj) {
246246
return MP_OBJ_TO_PTR(native_display);
247247
}
248248

249+
// Undocumented show() implementation with a friendly error message.
250+
STATIC mp_obj_t epaperdisplay_epaperdisplay_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
251+
mp_raise_AttributeError(translate(".show(x) removed. Use .root_group = x"));
252+
return mp_const_none;
253+
}
254+
MP_DEFINE_CONST_FUN_OBJ_2(epaperdisplay_epaperdisplay_show_obj, epaperdisplay_epaperdisplay_obj_show);
255+
249256
//| def update_refresh_mode(
250257
//| self, start_sequence: ReadableBuffer, seconds_per_frame: float = 180
251258
//| ) -> None:
@@ -391,6 +398,7 @@ MP_PROPERTY_GETSET(epaperdisplay_epaperdisplay_root_group_obj,
391398
(mp_obj_t)&epaperdisplay_epaperdisplay_set_root_group_obj);
392399

393400
STATIC const mp_rom_map_elem_t epaperdisplay_epaperdisplay_locals_dict_table[] = {
401+
{ MP_ROM_QSTR(MP_QSTR_show), MP_ROM_PTR(&epaperdisplay_epaperdisplay_show_obj) },
394402
{ MP_ROM_QSTR(MP_QSTR_update_refresh_mode), MP_ROM_PTR(&epaperdisplay_epaperdisplay_update_refresh_mode_obj) },
395403
{ MP_ROM_QSTR(MP_QSTR_refresh), MP_ROM_PTR(&epaperdisplay_epaperdisplay_refresh_obj) },
396404

shared-bindings/framebufferio/FramebufferDisplay.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,13 @@ static framebufferio_framebufferdisplay_obj_t *native_display(mp_obj_t display_o
9898
return MP_OBJ_TO_PTR(native_display);
9999
}
100100

101+
// Undocumented show() implementation with a friendly error message.
102+
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
103+
mp_raise_AttributeError(translate(".show(x) removed. Use .root_group = x"));
104+
return mp_const_none;
105+
}
106+
MP_DEFINE_CONST_FUN_OBJ_2(framebufferio_framebufferdisplay_show_obj, framebufferio_framebufferdisplay_obj_show);
107+
101108
//| def refresh(
102109
//| self,
103110
//| *,
@@ -348,6 +355,7 @@ MP_PROPERTY_GETSET(framebufferio_framebufferdisplay_root_group_obj,
348355
(mp_obj_t)&framebufferio_framebufferdisplay_set_root_group_obj);
349356

350357
STATIC const mp_rom_map_elem_t framebufferio_framebufferdisplay_locals_dict_table[] = {
358+
{ MP_ROM_QSTR(MP_QSTR_show), MP_ROM_PTR(&framebufferio_framebufferdisplay_show_obj) },
351359
{ MP_ROM_QSTR(MP_QSTR_refresh), MP_ROM_PTR(&framebufferio_framebufferdisplay_refresh_obj) },
352360
{ MP_ROM_QSTR(MP_QSTR_fill_row), MP_ROM_PTR(&framebufferio_framebufferdisplay_fill_row_obj) },
353361

0 commit comments

Comments
 (0)