File input

Overview

FileInput is a field widget to search for files in the SEPAL folders. it inherits from the SepalWidget class. Any argument from the original Layout ipyvuetify class can be used to complement it.

from pysepal import sepalwidgets as sw

# correct colors for the documentation
# set to dark in SEPAL by default
import ipyvuetify as v
v.theme.dark = False

file_input = sw.FileInput()
file_input

/home/docs/checkouts/readthedocs.org/user_builds/sepal-ui/envs/latest/lib/python3.10/site-packages/google/api_core/_python_version_support.py:273: FutureWarning: You are using a Python version (3.10.19) which Google will stop supporting in new releases of google.api_core once it reaches its end of life (2026-10-04). Please upgrade to the latest Python version, or at least Python 3.11, to continue receiving updates for google.api_core past that date.
  warnings.warn(message, FutureWarning)

the value can be retrieve from the v_model trait.

Methods

select_file

Manually select a file from it’s path. No verification on the extension is performed.

from pysepal import sepalwidgets as sw
from pathlib import Path

# correct colors for the documentation
# set to dark in SEPAL by default
import ipyvuetify as v
v.theme.dark = False

path = Path.home()/'test.txt'
path.write_text("hello world")

file_input = sw.FileInput()
file_input.select_file(path)
file_input

reset

Clear the File selection and move to the root folder if something was selected.

from pysepal import sepalwidgets as sw
from pathlib import Path

# correct colors for the documentation
# set to dark in SEPAL by default
import ipyvuetify as v
v.theme.dark = False

path = Path.home()/'test.txt'
path.write_text("hello world")

file_input = sw.FileInput()
file_input.select_file(path)
file_input.reset()
file_input

Note

More information can be found here.