# Adapted from https://github.com/kivy-garden/filebrowser """ FileBrowser =========== The :class:`FileBrowser` widget is an advanced file browser. You use it similarly to FileChooser usage. It provides a shortcut bar with links to special and system directories. When touching next to a shortcut in the links bar, it'll expand and show all the directories within that directory. It also facilitates specifying custom paths to be added to the shortcuts list. It provides a icon and list view to choose files from. And it also accepts filter and filename inputs. To create a FileBrowser which prints the currently selected file as well as the current text in the filename field when 'Select' is pressed, with a shortcut to the Documents directory added to the favorites bar:: import os from kivy.app import App class TestApp(App): def build(self): user_path = os.path.join(get_home_directory(), 'Documents') browser = FileBrowser(select_string='Select', favorites=[(user_path, 'Documents')]) browser.bind(on_success=self._fbrowser_success, on_submit=self._fbrowser_submit) return browser def _fbrowser_success(self, instance): print(instance.selection) def _fbrowser_submit(self, instance): print(instance.selection) TestApp().run() :Events: `on_success`: Fired when the `Select` buttons `on_release` event is called. `on_submit`: Fired when a file has been selected with a double-tap. .. image:: _static/filebrowser.png :align: right """ import string from functools import partial from os import walk from os.path import dirname, expanduser, getmtime, isdir, isfile, join, sep from kivy import Config from kivy.clock import Clock from kivy.lang import Builder from kivy.properties import BooleanProperty, ListProperty, ObjectProperty, OptionProperty, StringProperty from kivy.uix.boxlayout import BoxLayout from kivy.uix.filechooser import FileChooserListLayout, FileChooserListView from kivy.uix.treeview import TreeView, TreeViewLabel from kivy.utils import platform from katrain.gui.theme import Theme if platform == "win": from ctypes import windll, create_unicode_buffer def last_modified_first(files, filesystem): return sorted(f for f in files if filesystem.is_dir(f)) + sorted( [f for f in files if not filesystem.is_dir(f)], key=lambda f: -getmtime(f) ) def get_home_directory(): if platform == "win": user_path = expanduser("~") if not isdir(join(user_path, "Desktop")): user_path = dirname(user_path) else: user_path = expanduser("~") return user_path def get_drives(): drives = [] if platform == "win": bitmask = windll.kernel32.GetLogicalDrives() for letter in string.ascii_uppercase: if bitmask & 1: name = create_unicode_buffer(64) # get name of the drive drive = letter + ":" if isdir(drive): drives.append((drive, name.value)) bitmask >>= 1 elif platform == "linux": drives.append((sep, sep)) drives.append((expanduser("~"), "~/")) places = (sep + "mnt", sep + "media") for place in places: if isdir(place): for directory in next(walk(place))[1]: drives.append((place + sep + directory, directory)) elif platform == "macosx" or platform == "ios": drives.append((expanduser("~"), "~/")) vol = sep + "Volume" if isdir(vol): for drive in next(walk(vol))[1]: drives.append((vol + sep + drive, drive)) return drives class I18NFileChooserListView(FileChooserListView): font_name = StringProperty(Theme.DEFAULT_FONT) show_hidden = BooleanProperty(True) # avoid errors class I18NFileChooserListLayout(FileChooserListLayout): _ENTRY_TEMPLATE = "I18NFileListEntry" log_level = Config.get("kivy", "log_level") Config.set("kivy", "log_level", "error") Builder.load_string( """ [I18NFileListEntry@FloatLayout+TreeViewNode]: locked: False entries: [] path: ctx.path is_selected: self.path in ctx.controller().selection orientation: 'horizontal' size_hint_y: None height: '24dp' # Don't allow expansion of the ../ node is_leaf: not ctx.isdir or ctx.name.endswith('..' + ctx.sep) or self.locked on_touch_down: self.collide_point(*args[1].pos) and ctx.controller().entry_touched(self, args[1]) on_touch_up: self.collide_point(*args[1].pos) and ctx.controller().entry_released(self, args[1]) BoxLayout: pos: root.pos size_hint_x: None width: root.width - dp(10) Label: id: filename text_size: self.width, None halign: 'left' shorten: True text: ctx.name font_name: ctx.controller().font_name Label: text_size: self.width, None size_hint_x: None halign: 'right' text: '{}'.format(ctx.get_nice_size()) : layout: layout I18NFileChooserListLayout: id: layout controller: root """ ) Config.set("kivy", "log_level", log_level) Builder.load_string( """ #:import metrics kivy.metrics #:import abspath os.path.abspath #:import i18n katrain.core.lang.i18n : on_touch_down: self.parent.browser.path = self.path if self.collide_point(*args[1].pos) and self.path else self.parent.browser.path on_is_open: self.is_open and self.parent.trigger_populate(self) : orientation: 'vertical' spacing: 5 padding: [6, 6, 6, 6] select_state: select_button.state file_text: file_text filename: file_text.text browser: list_view on_favorites: link_tree.reload_favs(self.favorites) on_selection: file_text.text = root.selection[0] if root.selection else "" BoxLayout: orientation: 'horizontal' spacing: 5 Splitter: sizable_from: 'right' min_size: '153sp' size_hint: (.2, 1) id: splitter ScrollView: LinkTree: id: link_tree browser: root.browser size_hint_y: None height: self.minimum_height on_parent: self.fill_tree(root.favorites) root_options: {'text': 'Locations', 'no_selection':True} BoxLayout: size_hint_x: .8 orientation: 'vertical' Label: size_hint_y: None height: '22dp' text_size: self.size padding_x: '10dp' text: abspath(root.path) track_lang: i18n._('') valign: 'middle' I18NFileChooserListView: id: list_view path: root.path sort_func: root.sort_func filters: root.filters + [f.upper() for f in root.filters] filter_dirs: root.filter_dirs show_hidden: root.show_hidden multiselect: root.multiselect dirselect: root.dirselect rootpath: root.rootpath on_submit: root.dispatch('on_submit') track_lang: i18n._('') GridLayout: size_hint: (1, None) height: file_text.line_height * 2 cols: 2 rows: 2 spacing: [5] TextInput: id: file_text hint_text: i18n._('Filename') multiline: False height: '40dp' AutoSizedRoundedRectangleButton: id: select_button padding_x: 15 height: '40dp' size_hint_x: None text: i18n._(root.select_string) on_release: root.button_clicked() """ ) class TreeLabel(TreeViewLabel): path = StringProperty("") """Full path to the location this node points to. :class:`~kivy.properties.StringProperty`, defaults to '' """ class LinkTree(TreeView): # link to the favorites section of link bar _favs = ObjectProperty(None) _computer_node = None def fill_tree(self, fav_list): user_path = get_home_directory() self._favs = self.add_node(TreeLabel(text="Favorites", is_open=True, no_selection=True)) self.reload_favs(fav_list) libs = self.add_node(TreeLabel(text="Libraries", is_open=True, no_selection=True)) places = ("Documents", "Music", "Pictures", "Videos") for place in places: if isdir(join(user_path, place)): self.add_node(TreeLabel(text=place, path=join(user_path, place)), libs) self._computer_node = self.add_node(TreeLabel(text="Computer", is_open=True, no_selection=True)) self._computer_node.bind(on_touch_down=self._drives_touch) self.reload_drives() def _drives_touch(self, obj, touch): if obj.collide_point(*touch.pos): self.reload_drives() def reload_drives(self): nodes = [(node, node.text + node.path) for node in self._computer_node.nodes if isinstance(node, TreeLabel)] sigs = [s[1] for s in nodes] nodes_new = [] sig_new = [] for path, name in get_drives(): if platform == "win": text = "{}({})".format((name + " ") if name else "", path) else: text = name nodes_new.append((text, path)) sig_new.append(text + path + sep) for node, sig in nodes: if sig not in sig_new: self.remove_node(node) for text, path in nodes_new: if text + path + sep not in sigs: self.add_node(TreeLabel(text=text, path=path + sep), self._computer_node) def reload_favs(self, fav_list): user_path = get_home_directory() favs = self._favs remove = [] for node in self.iterate_all_nodes(favs): if node != favs: remove.append(node) for node in remove: self.remove_node(node) places = ("Desktop", "Downloads") for place in places: if isdir(join(user_path, place)): self.add_node(TreeLabel(text=place, path=join(user_path, place)), favs) for path, name in fav_list: if isdir(path): self.add_node(TreeLabel(text=name, path=path), favs) def trigger_populate(self, node): if not node.path or node.nodes: return parent = node.path _next = next(walk(parent)) if _next: for path in _next[1]: self.add_node(TreeLabel(text=path, path=parent + sep + path), node) class I18NFileBrowser(BoxLayout): """I18NFileBrowser class, see module documentation for more information.""" __events__ = ("on_success", "on_submit") file_must_exist = BooleanProperty(False) # whether new file paths can be pointed at select_state = OptionProperty("normal", options=("normal", "down")) """State of the 'select' button, must be one of 'normal' or 'down'. The state is 'down' only when the button is currently touched/clicked, otherwise 'normal'. This button functions as the typical Ok/Select/Save button. :data:`select_state` is an :class:`~kivy.properties.OptionProperty`. """ select_string = StringProperty("Ok") """Label of the 'select' button. :data:`select_string` is an :class:`~kivy.properties.StringProperty`, defaults to 'Ok'. """ filename = StringProperty("") """The current text in the filename field. Read only. When multiselect is True, the list of selected filenames is shortened. If shortened, filename will contain an ellipsis. :data:`filename` is an :class:`~kivy.properties.StringProperty`, defaults to ''. .. versionchanged:: 1.1 """ selection = ListProperty([]) """Read-only :class:`~kivy.properties.ListProperty`. Contains the list of files that are currently selected in the current tab. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.selection`. .. versionchanged:: 1.1 """ path = StringProperty("/") """ :class:`~kivy.properties.StringProperty`, defaults to the current working directory as a unicode string. It specifies the path on the filesystem that browser should refer to. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.path`. .. versionadded:: 1.1 """ filters = ListProperty([]) """:class:`~kivy.properties.ListProperty`, defaults to [], equal to ``'*'``. Specifies the filters to be applied to the files in the directory. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.filters`. Filering keywords that the user types into the filter field as a comma separated list will be reflected here. .. versionadded:: 1.1 """ filter_dirs = BooleanProperty(False) """ :class:`~kivy.properties.BooleanProperty`, defaults to False. Indicates whether filters should also apply to directories. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.filter_dirs`. .. versionadded:: 1.1 """ show_hidden = BooleanProperty(False) """ :class:`~kivy.properties.BooleanProperty`, defaults to False. Determines whether hidden files and folders should be shown. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.show_hidden`. .. versionadded:: 1.1 """ multiselect = BooleanProperty(False) """ :class:`~kivy.properties.BooleanProperty`, defaults to False. Determines whether the user is able to select multiple files or not. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.multiselect`. .. versionadded:: 1.1 """ dirselect = BooleanProperty(False) """ :class:`~kivy.properties.BooleanProperty`, defaults to False. Determines whether directories are valid selections or not. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.dirselect`. .. versionadded:: 1.1 """ rootpath = StringProperty(None, allownone=True) """ Root path to use instead of the system root path. If set, it will not show a ".." directory to go up to the root path. For example, if you set rootpath to /users/foo, the user will be unable to go to /users or to any other directory not starting with /users/foo. :class:`~kivy.properties.StringProperty`, defaults to None. See :kivy_fchooser:`kivy.uix.filechooser.FileChooserController.rootpath`. .. versionadded:: 1.1 """ favorites = ListProperty([]) """A list of the paths added to the favorites link bar. Each element is a tuple where the first element is a string containing the full path to the location, while the second element is a string with the name of path to be displayed. :data:`favorites` is an :class:`~kivy.properties.ListProperty`, defaults to '[]'. """ sort_func = ObjectProperty(last_modified_first) """ Provides a function to be called with a list of filenames as the first argument and the filesystem implementation as the second argument. It returns a list of filenames sorted for display in the view.""" def on_success(self): pass def on_submit(self): pass def __init__(self, **kwargs): super(I18NFileBrowser, self).__init__(**kwargs) Clock.schedule_once(self._post_init) def _post_init(self, *largs): self.ids.list_view.bind( selection=partial(self._attr_callback, "selection"), path=partial(self._attr_callback, "path"), filters=partial(self._attr_callback, "filters"), filter_dirs=partial(self._attr_callback, "filter_dirs"), show_hidden=partial(self._attr_callback, "show_hidden"), multiselect=partial(self._attr_callback, "multiselect"), dirselect=partial(self._attr_callback, "dirselect"), rootpath=partial(self._attr_callback, "rootpath"), ) def _shorten_filenames(self, filenames): if not len(filenames): return "" elif len(filenames) == 1: return filenames[0] elif len(filenames) == 2: return filenames[0] + ", " + filenames[1] else: return filenames[0] + ", _..._, " + filenames[-1] def _attr_callback(self, attr, obj, value): setattr(self, attr, getattr(obj, attr)) def button_clicked(self): if isdir(self.file_text.text): self.path = self.file_text.text elif not self.file_must_exist or isfile(self.file_text.text): self.dispatch("on_success")