FileManager
A simple manager for selecting directories and files. Warning Be careful! To use the / path on Android devices, you need
special permissions. Therefore, you are likely to get an error. Or with Warning The preview mode is intended only for viewing images and will
not display other types of files. New in version 1.0.0. Added a feature that allows you to show the available disks first, then the
files contained in them. Works correctly on: Windows, Linux, OSX, Android.
Not tested on iOS.Usage
path = '/' # path to the directory that will be opened in the file manager
file_manager = MDFileManager(
exit_manager=self.exit_manager, # function called when the user reaches directory tree root
select_path=self.select_path, # function called when selecting a file/directory
)
file_manager.show(path)
preview
mode:file_manager = MDFileManager(
exit_manager=self.exit_manager,
select_path=self.select_path,
preview=True,
)
Example
from kivy.core.window import Window
from kivy.lang import Builder
from kivymd.app import MDApp
from kivymd.uix.filemanager import MDFileManager
from kivymd.toast import toast
KV = '''
MDBoxLayout:
orientation: 'vertical'
MDToolbar:
title: "MDFileManager"
left_action_items: [['menu', lambda x: None]]
elevation: 10
MDFloatLayout:
MDRoundFlatIconButton:
text: "Open manager"
icon: "folder"
pos_hint: {'center_x': .5, 'center_y': .6}
on_release: app.file_manager_open()
'''
class Example(MDApp):
def __init__(self, **kwargs):
super().__init__(**kwargs)
Window.bind(on_keyboard=self.events)
self.manager_open = False
self.file_manager = MDFileManager(
exit_manager=self.exit_manager,
select_path=self.select_path,
preview=True,
)
def build(self):
return Builder.load_string(KV)
def file_manager_open(self):
self.file_manager.show('/') # output manager to the screen
self.manager_open = True
def select_path(self, path):
'''It will be called when you click on the file name
or the catalog selection button.
:type path: str;
:param path: path to the selected directory or file;
'''
self.exit_manager()
toast(path)
def exit_manager(self, *args):
'''Called when the user reaches the root of the directory tree.'''
self.manager_open = False
self.file_manager.close()
def events(self, instance, keyboard, keycode, text, modifiers):
'''Called when buttons are pressed on the mobile device.'''
if keyboard in (1001, 27):
if self.manager_open:
self.file_manager.back()
return True
Example().run()
def file_manager_open(self):
self.file_manager.show_disks()
API - kivymd.uix.filemanager.filemanager
- class kivymd.uix.filemanager.filemanager.MDFileManager(**kwargs)
RelativeLayout class, see module documentation for more information.
- icon
The icon that will be used on the directory selection button.
icon
is anStringProperty
and defaults to check.
- icon_folder
The icon that will be used for folder icons when using
preview = True
.icon
is anStringProperty
and defaults to check.
- exit_manager
Function called when the user reaches directory tree root.
exit_manager
is anObjectProperty
and defaults to lambda x: None.
- select_path
Function, called when selecting a file/directory.
select_path
is anObjectProperty
and defaults to lambda x: None.
- ext
List of file extensions to be displayed in the manager. For example, [‘.py’, ‘.kv’] - will filter out all files, except python scripts and Kv Language.
ext
is anListProperty
and defaults to [].
- search
It can take the values ‘all’ ‘dirs’ ‘files’ - display only directories or only files or both them. By default, it displays folders, and files. Available options are: ‘all’, ‘dirs’, ‘files’.
search
is anOptionProperty
and defaults to all.
- current_path
Current directory.
current_path
is anStringProperty
and defaults to /.
- use_access
Show access to files and directories.
use_access
is anBooleanProperty
and defaults to True.
- preview
Shows only image previews.
preview
is anBooleanProperty
and defaults to False.
Shows hidden files.
show_hidden_files
is anBooleanProperty
and defaults to False.
- sort_by
It can take the values ‘nothing’ ‘name’ ‘date’ ‘size’ ‘type’ - sorts files by option By default, sort by name. Available options are: ‘nothing’, ‘name’, ‘date’, ‘size’, ‘type’.
sort_by
is anOptionProperty
and defaults to name.
- sort_by_desc
Sort by descending.
sort_by_desc
is anBooleanProperty
and defaults to False.
- selector
It can take the values ‘any’ ‘file’ ‘folder’ ‘multi’ By default, any. Available options are: ‘any’, ‘file’, ‘folder’, ‘multi’.
selector
is anOptionProperty
and defaults to any.
- selection
Contains the list of files that are currently selected.
selection
is a read-onlyListProperty
and defaults to [].
- show_disks(self)
- show(self, path: str)
Forms the body of a directory tree.
- Parameters
path – The path to the directory that will be opened in the file manager.
- get_content(self)
Returns a list of the type [[Folder List], [file list]].
- close(self)
Closes the file manager window.
- select_dir_or_file(self, path: str, widget: Union[BodyManagerWithPreview, Factory.BodyManager])
Called by tap on the name of the directory or file.
- back(self)
Returning to the branch down in the directory tree.
- select_directory_on_press_button(self, *args)
Called when a click on a floating button.