Skip to content

landingai.notebook_utils

This module contains common notebook utilities that are used across the example notebooks in this repo. It's only intended for examples provided by this repo. When using the SDK in your own project, you don't need to use this module.

display_video(path_to_file)

Return a notebook-independent video object that can be shown on Jupyter and Colab.

Source code in landingai/notebook_utils.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def display_video(path_to_file: str):  # type: ignore
    """Return a notebook-independent video object that can be shown on Jupyter and Colab."""
    if is_running_in_colab_notebook():
        from IPython.display import HTML
        from base64 import b64encode

        mp4 = open(path_to_file, "rb").read()
        data_url = "data:video/mp4;base64," + b64encode(mp4).decode()
        return HTML(
            """
        <video width=400 controls>
            <source src="%s" type="video/mp4">
        </video>
        """
            % data_url
        )
    else:
        from IPython.display import Video

        return Video(path_to_file)

is_running_in_colab_notebook()

Return True if the code is running in a Google Colab notebook.

Source code in landingai/notebook_utils.py 
 8
 9
10
11
12
13
14
15
def is_running_in_colab_notebook() -> bool:
    """Return True if the code is running in a Google Colab notebook."""
    try:
        from IPython import get_ipython

        return get_ipython().__class__.__module__ == "google.colab._shell"  # type: ignore
    except ImportError:
        return False  # Probably standard Python interpreter

is_running_in_jupyter_notebook()

Return True if the code is running in a Jupyter notebook.

Source code in landingai/notebook_utils.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def is_running_in_jupyter_notebook() -> bool:
    """Return True if the code is running in a Jupyter notebook."""
    try:
        from IPython import get_ipython

        # See: https://stackoverflow.com/questions/15411967/how-can-i-check-if-code-is-executed-in-the-ipython-notebook
        shell = get_ipython().__class__.__name__
        if shell == "ZMQInteractiveShell":
            return True  # Jupyter notebook or qtconsole
        elif shell == "TerminalInteractiveShell":
            return False  # Terminal running IPython
        else:
            return False  # Other type (?)
    except ImportError:
        return False  # Probably standard Python interpreter

is_running_in_notebook() cached

Return True if the code is running in a notebook.

Source code in landingai/notebook_utils.py 
35
36
37
38
@lru_cache(maxsize=None)
def is_running_in_notebook() -> bool:
    """Return True if the code is running in a notebook."""
    return is_running_in_colab_notebook() or is_running_in_jupyter_notebook()