ipyfilechooser

A simple Python file chooser widget for use in Jupyter/IPython in conjunction with ipywidgets. The selected path and file are available via .selected_path and .selected_filename respectvely or as a single combined filepath via .selected. The dialog can be reset to its default path and filename by using .reset().

When a typed filename matches an existing file entry in the current folder the entry will be highlighted. If a typed filename matches a folder entry in the current view the selection button is disabled ensure the user is aware of the match. To select a folder simply leave the filename field empty.

To emphasize the risk of overwriting existing files, the selected filepath is displayed in green if the file does not exist and orange if it does.

Usage

from ipyfilechooser import FileChooser

# Create and display a FileChooser widget
fc = FileChooser('/Users/crahan/FC demo')
display(fc)

# Print the selected path, filename, or both
print(fc.selected_path)
print(fc.selected_filename)
print(fc.selected)

# Change defaults and reset the dialog
fc.default_path = '/Users/crahan/'
fc.default_filename = 'output.txt'
fc.reset()

# Shorthand reset
fc.reset(path='/Users/crahan/', filename='output.txt')

# Restrict navigation to /Users
fc.sandbox_path = '/Users'

# Change hidden files
fc.show_hidden = True

# Customize dir icon
fc.dir_icon = '/'
fc.dir_icon_append = True

# Switch to folder-only mode
fc.show_only_dirs = True

# Set a file filter pattern (uses https://docs.python.org/3/library/fnmatch.html)
fc.filter_pattern = '*.txt'

# Set multiple file filter patterns (uses https://docs.python.org/3/library/fnmatch.html)
fc.filter_pattern = ['*.jpg', '*.png']

# Change the title (use '' to hide)
fc.title = '<b>FileChooser title</b>'

# Sample callback function
def change_title(chooser):
    chooser.title = '<b>Callback function executed</b>'

# Register callback function
fc.register_callback(change_title)

Functions and properties

fc.reset()
fc.refresh()
fc.register_callback(function_name)
fc.show_hidden
fc.dir_icon
fc.dir_icon_append
fc.show_only_dirs
fc.rows
fc.title
fc.filter_pattern
fc.default
fc.default_path
fc.default_filename
fc.sandbox_path
fc.value
fc.selected
fc.selected_path
fc.selected_filename

Screenshots

Closed vs open dialog

Existing vs new file selection

Quick navigation dropdown

Use folder icons

Restrict navigation

Release notes

0.6.0

• The ability to restrict file browsing to a sandbox_path folder has finally been added!
• Filenames can not contain path separator characters or parent folder strings (i.e., '..')
• use_dir_icons has been replaced with dir_icon which allows for customizing the folder icon
• dir_icon_append can now be used to put the folder icon before or after the folder name
• Better error handling with ParentPathError, InvalidPathError, and InvalidFileNameError
• Better and more consistent handling of Windows drive letters and paths
• Fix bug where resetting the filechooser would not reenable the select/change button
• Properly handle folder permission errors by raising a warning

0.5.0

• Widget width is now configurable using the layout property and a Layout object
• Folder paths are now normalized using os.path.normpath to properly handle '/' and '\' on Windows
• The widget now supports the value property to align with other widget types
• The label showing the selected value now reflows the text to new lines as required (and shows a scrollbar if the value is too long)
• Buttons now have a minimum width to ensure their text is always visible, regardless of widget width

0.4.4

• Added typing hints (@Mandroide)
• Updated max line length check from 90 to 120 characters
• Fixed filter_pattern values not being treated as case-insensitive
• General code cleanup

0.4.3

• Prevent applying the selected value if the filename doesn't match one of the filter_pattern values

0.4.2

• Added ability to specify a list of fnmatch pattern strings for filter_pattern

0.4.1

• Fixed issue with select_default not being applied on reset

0.4.0

• Option added to specify a file filter (@andriykorchak)
• Add support for ValueWidget and get_interact_value()
• Updated sample notebook with filter example
• Updated Development Status to Production/Stable

0.3.5

• Option added to only display folders (@andriykorchak)

0.3.4

• Option added to display folder icons (@ptooley)

0.3.3

• Option added to add self as an argument to the callback function (@ptooley)

0.3.2

• Return None if file is not selected (@danjjl)

0.3.1

• Option to register a callback function (register_callback(function_name))

0.3.0

• Ability to select a folder
• Support for Windows drive letters
• Option to use the defaults as the selected value

0.2.0

• First public release