Module `open_atmos_jupyter_utils.temporary_file`

Expand source code

# pylint: disable=missing-module-docstring

import os
import sys
import tempfile
from ipywidgets import HTML, Button
from IPython.display import FileLink

if 'google.colab' in sys.modules:
    # pylint: disable-next=import-error
    from google import colab
    ABSOLUTE_PATH = '/content'
else:
    ABSOLUTE_PATH = os.getcwd()
    RELATIVE_PATH = '.'


class TemporaryFile:
    """ Jupyter-friendly temporary files with Colab-compatible download-link generation """

    def __init__(self, suffix='.pdf', filename=None):
        if filename is None:
            _, self.absolute_path = tempfile.mkstemp(
                dir=ABSOLUTE_PATH,
                suffix=suffix
            )
        else:
            self.absolute_path = os.path.join(ABSOLUTE_PATH, filename)
        self.basename = os.path.basename(self.absolute_path)

    def __str__(self):
        return self.absolute_path

    def make_link_widget(self):
        """ returns a click-to-download widget to be display()-ed in a Jupyter notebook """
        if 'google.colab' in sys.modules:
            link = Button(description=self.basename)
            link.on_click(lambda _: colab.files.download(self.absolute_path))
        else:
            link = HTML()
            filename = str(os.path.join(RELATIVE_PATH, self.basename))
            # pylint: disable-next=protected-access
            link.value = FileLink(filename)._format_path()
        return link

Classes

class TemporaryFile (suffix='.pdf', filename=None)

Jupyter-friendly temporary files with Colab-compatible download-link generation

Expand source code

class TemporaryFile:
    """ Jupyter-friendly temporary files with Colab-compatible download-link generation """

    def __init__(self, suffix='.pdf', filename=None):
        if filename is None:
            _, self.absolute_path = tempfile.mkstemp(
                dir=ABSOLUTE_PATH,
                suffix=suffix
            )
        else:
            self.absolute_path = os.path.join(ABSOLUTE_PATH, filename)
        self.basename = os.path.basename(self.absolute_path)

    def __str__(self):
        return self.absolute_path

    def make_link_widget(self):
        """ returns a click-to-download widget to be display()-ed in a Jupyter notebook """
        if 'google.colab' in sys.modules:
            link = Button(description=self.basename)
            link.on_click(lambda _: colab.files.download(self.absolute_path))
        else:
            link = HTML()
            filename = str(os.path.join(RELATIVE_PATH, self.basename))
            # pylint: disable-next=protected-access
            link.value = FileLink(filename)._format_path()
        return link

Methods

def make_link_widget(self)

returns a click-to-download widget to be display()-ed in a Jupyter notebook

Expand source code

def make_link_widget(self):
    """ returns a click-to-download widget to be display()-ed in a Jupyter notebook """
    if 'google.colab' in sys.modules:
        link = Button(description=self.basename)
        link.on_click(lambda _: colab.files.download(self.absolute_path))
    else:
        link = HTML()
        filename = str(os.path.join(RELATIVE_PATH, self.basename))
        # pylint: disable-next=protected-access
        link.value = FileLink(filename)._format_path()
    return link