Make sure display_data always contain metadata

[martinRenou]

References

Attempt to fix #264

[jtpio]

Thanks!

Looks like having that default should indeed be fine anyway.

[martinRenou]

(Edited the top comment with a screenshot, that seems to work)

[martinRenou]

Checking the other notebooks before making this non-draft

[bollwyvl]

seems legit!

[martinRenou]

I honestly believe we shouldn't do this, and that py3dmol should not use IPython.display.publish_display_data directly. But if ipykernel is resilient with this, then maybe pyolite should be too.

[jtpio]

Thanks!

[psychemedia]

@martinRenou Re: "I honestly believe we shouldn't do this, and that py3dmol should not use IPython.display.publish_display_data directly." Is there an approach you think they should take? I am happen to open an issue on their repo "observing" that their perhaps atypical/non-standard(?) approach caused this project to have to error trap on what appears to be an exceptional case so far.

[martinRenou]

I am not 100% of this. But this publish_display_data seems somewhat like a private API to me. I would suggest using display(obj, raw=True) instead.

[martinRenou]

Although this is documented API https://ipython.readthedocs.io/en/stable/api/generated/IPython.display.html#IPython.display.publish_display_data. So maybe it's an issue on IPython's side which should set the metadata to an empty dict by default.