如何在Python包内的Jupyter Notebook中显示.gif

Question

我正在编写一个用于交互数据可视化的小型python程序包。 我们希望在程序包中包含gif，以便用户可以运行示例并学习如何与图形交互。

这是一个示例结构：

<package>
    +-->some_module/
        +--> static/
            +--> foo.gif
        +--> spam.py
    +-->examples/
       +--> example.ipynb

我们有几个类（例如， spam.py可能包含Spam类），并且这些类将具有.show_gif()方法，该方法将访问static中的gif（ foo.gif ）并将其显示给用户。

该代码被编写为在Jupyter笔记本中使用。 在包中，我们包括一些示例（例如example.ipynb ），这些示例将导入spam ，然后在相关类上调用.show_gif()方法。

目前，我们使用以下方式显示GIF：

from IPython.core.display import Image
Image(filename=path_to_gif)

当gif位于jupyter笔记本所在文件夹的子目录中时，此方法工作正常，但当gif位于程序包的同级目录中时则无效（如上例所示）。

编辑：

我相信我可以访问.gif，但不能在jupyter笔记本中显示它（请参见下文）

有类似的堆栈溢出问题（ 此问题 ），建议使用标准库中的importlib.resources module 。 但是，它们返回一个我不知道如何处理的BinaryIO实例，请参见：

import some_module.static as static

…

def show_gif(self):
    image = pkg_resources.open_binary(static, 'foo.gif')
    return Image(data=image)

这会引发错误，因为我给Image提供了错误的数据类型。 如何打开此.gif并将其显示在jupyter笔记本中？

Answer 1

使用任何方法找到gif文件的路径并打开以进行阅读； pkg_resources.open_binary()可以，尽管这是磁盘上的实际文件，所以有一些更简单的方法。 但是现在您有了一个打开的文件句柄，而不是内容本身-与在文件上调用open()相同。 要获取图像数据，您需要从文件句柄中read() 。

然后，您将拥有一个bytes对象，而不是一个文本字符串。 这不是问题，因为Image()接受构造函数中的bytes ：

with pkg_resources.open_binary(some_module, 'foo.gif') as src:
    imagedata = src.read()
image = Image(data=imagedata)