如何更改 jupyter notebook / jupyterlab 中单个单元格的背景颜色？

Question

我设计了一个笔记本，以便将用户可以更改的变量分组到整个笔记本中的不同单元格中。我想用不同的背景颜色突出显示这些单元格，以便用户可以清楚地看到旋钮所在的位置。

我怎样才能做到这一点？

NB：This related question 是关于 static 代码突出显示（用于手册），并且接受的答案建议基本上将所有内容都放在标记 cmets 中。就我而言，我希望突出显示的代码位于可运行单元格中。

Answer 1

这就是 jupyter-notebook (v6.3.0) 和 jupyter-nbconvert --to=html (v6.0.7) 中对我有用的方法。

这与@krassowski 和@Gabe 的回答在两个方面有所不同：

1. 交互式笔记本使用类名.cell 和.input_area，但nbconvert HTML 使用.jp-CodeCell 和.jp-Editor 和.highlight。此代码处理所有这些。

2. 我更喜欢“线条魔法”而不是“细胞魔法”，因为线条魔法不会改变细胞其余部分的评估。

from IPython.core.magic import register_line_magic
from IPython.display import HTML, display
import json

@register_line_magic
def bg(color, cell=None):    
    script = (
        "var n = [this.closest('.cell,.jp-CodeCell')];"
        "n = n.concat([].slice.call(n[0].querySelectorAll('.input_area,.highlight,.jp-Editor')));"
        f"n.forEach(e=>e.style.background='{color}');"
        "this.parentNode.removeChild(this)"
    )
    display(HTML(f'<img src onerror="{script}" style="display:none">'))  

%bg yellow

Answer 2

给你（假设你使用 Python 内核）：

from IPython.display import HTML, display

def set_background(color):    
    script = (
        "var cell = this.closest('.jp-CodeCell');"
        "var editor = cell.querySelector('.jp-Editor');"
        "editor.style.background='{}';"
        "this.parentNode.removeChild(this)"
    ).format(color)
    
    display(HTML('<img src onerror="{}" style="display:none">'.format(script)))

然后像这样使用它：

set_background('honeydew')

解决方案有点老套，我很乐意看到更优雅的解决方案。 演示：

使用 JupyterLab 0.32.1 在 Firefox 60 和 Chrome 67 中测试。

编辑让它成为细胞魔法，你可以简单地这样做：

from IPython.core.magic import register_cell_magic

@register_cell_magic
def background(color, cell):
    set_background(color)
    return eval(cell)

并像这样使用它：

%%background honeydew
my_important_param = 42

Answer 3

如果您只需要更改用nbconvert转换的单元格的颜色， 在您的文件夹中创建一个模板mytemplate.tpl 并添加：

{% extends 'full.tpl'%}
{% block any_cell %}
{% if 'highlight' in cell['metadata'].get('tags', []) %}
    <div style="background:lightpink">
        {{ super() }}
    </div>
{% else %}
    {{ super() }}
{% endif %}
{% endblock any_cell %}

（改编自官方docs）

.. 然后将标签“highlight”添加到您的单元格。在 Jupyter 实验室中，您可以在左侧对选定的单元格执行此操作：

现在，使用模板通过 nbconvert 转换笔记本：

jupyter nbconvert --to html 'mynb.ipynb' --template=mytemplate.tpl

生成的 HTML 将如下所示：

我发现这适合向读者突出显示特定单元格。

Answer 4

对krassowski's code 的小补充（尝试将其添加为评论，但无法使格式生效）。

from IPython.core.magic import register_cell_magic
from IPython.display import HTML, display

@register_cell_magic
def bgc(color, cell=None):
    script = (
        "var cell = this.closest('.jp-CodeCell');"
        "var editor = cell.querySelector('.jp-Editor');"
        "editor.style.background='{}';"
        "this.parentNode.removeChild(this)"
    ).format(color)

    display(HTML('<img src onerror="{}">'.format(script)))

这样你就可以将它用作魔法和普通的函数调用：

bgc('yellow')
bla = 'bla'*3

或

%%bgc yellow
bla = 'bla'*3