ranger.fsobject.directory.html « pydoc « doc - ranger - mirror of ranger

blob: 7779080904fda9553e6dd7c1ee4590bed4c3b5b2 (plain) (generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-12-14 18:31:30 +0000

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.fsobject.directory</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big><a href="ranger.html">ranger</a>.<a href="ranger.fsobject.html">fsobject</a>.directory</big></big></td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:/home/hut/code/ranger/ranger/fsobject/directory.py">/home/hut/code/ranger/ranger/fsobject/directory.py</a></td></tr></table> <tt># Copyright (C) 2009, 2010  Roman Zimbelmann <romanz@lavabit.com> # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program.  If not, see <<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</tt> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom>  <big>Modules</big></td></tr> <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a> </td><td width="25%" valign=top><a href="ranger.html">ranger</a> </td><td width="25%" valign=top><a href="stat.html">stat</a> </td><td width="25%" valign=top></td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%"><dl> <dt><a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>(<a href="builtins.html#object">builtins.object</a>) </dt><dd> <dl> <dt><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt></dl> </dd> <dt><a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>) </dt><dd> <dl> <dt><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt></dl> </dd> <dt><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="builtins.html#object">builtins.object</a>) </dt><dd> <dl> <dt><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt></dl> </dd> </dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="Directory">class Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>)</td></tr> <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.fsobject.directory.html#Directory">Directory</a></dd> <dd><a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a></dd> <dd><a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a></dd> <dd><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a></dd> <dd><a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a></dd> <dd><a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a></dd> <dd><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a></dd> <dd><a href="builtins.html#object">builtins.object</a></dd> </dl> <hr> Methods defined here: <dl><dt><a name="Directory-__bool__">__bool__</a> = <a href="#Directory-__nonzero__">__nonzero__</a>(self)</dt></dl> <dl><dt><a name="Directory-__eq__">__eq__</a>(self, other)</dt><dd><tt>Check for equality of the directories paths</tt></dd></dl> <dl><dt><a name="Directory-__hash__">__hash__</a>(self)</dt></dl> <dl><dt><a name="Directory-__init__">__init__</a>(self, path, **kw)</dt></dl> <dl><dt><a name="Directory-__len__">__len__</a>(self)</dt><dd><tt>The number of containing files</tt></dd></dl> <dl><dt><a name="Directory-__neq__">__neq__</a>(self, other)</dt><dd><tt>Check for inequality of the directories paths</tt></dd></dl> <dl><dt><a name="Directory-__nonzero__">__nonzero__</a>(self)</dt><dd><tt>Always True</tt></dd></dl> <dl><dt><a name="Directory-correct_pointer">correct_pointer</a>(self)</dt><dd><tt>Make sure the pointer is in the valid range</tt></dd></dl> <dl><dt><a name="Directory-cycle">cycle</a>(self, forward=True)</dt></dl> <dl><dt><a name="Directory-empty">empty</a>(self)</dt><dd><tt>Is the directory empty?</tt></dd></dl> <dl><dt><a name="Directory-get_list">get_list</a>(self)</dt></dl> <dl><dt><a name="Directory-get_selection">get_selection</a>(self)</dt><dd><tt>READ ONLY</tt></dd></dl> <dl><dt><a name="Directory-load_bit_by_bit">load_bit_by_bit</a>(self)</dt><dd><tt>Returns a generator which load a part of the directory in each iteration.</tt></dd></dl> <dl><dt><a name="Directory-load_content">load_content</a>(self, schedule=None)</dt><dd><tt>Loads the contents of the directory. Use this sparingly since it takes rather long.</tt></dd></dl> <dl><dt><a name="Directory-load_content_if_outdated">load_content_if_outdated</a>(self, *a, **k)</dt><dd><tt>Load the contents of the directory if it's outdated or not done yet</tt></dd></dl> <dl><dt><a name="Directory-load_content_once">load_content_once</a>(self, *a, **k)</dt><dd><tt>Load the contents of the directory if not done yet</tt></dd></dl> <dl><dt><a name="Directory-mark_all">mark_all</a>(self, val)</dt></dl> <dl><dt><a name="Directory-mark_item">mark_item</a>(self, item, val)</dt></dl> <dl><dt><a name="Directory-move_to_obj">move_to_obj</a>(self, arg)</dt></dl> <dl><dt><a name="Directory-request_reload">request_reload</a>(self)</dt></dl> <dl><dt><a name="Directory-request_resort">request_resort</a>(self)</dt></dl> <dl><dt><a name="Directory-search_fnc">search_fnc</a>(self, fnc, forward=True)</dt></dl> <dl><dt><a name="Directory-set_cycle_list">set_cycle_list</a>(self, lst)</dt></dl> <dl><dt><a name="Directory-sort">sort</a>(self)</dt><dd><tt>Sort the containing files</tt></dd></dl> <dl><dt><a name="Directory-sort_if_outdated">sort_if_outdated</a>(self)</dt><dd><tt>Sort the containing files if they are outdated</tt></dd></dl> <dl><dt><a name="Directory-toggle_all_marks">toggle_all_marks</a>(self)</dt></dl> <dl><dt><a name="Directory-toggle_mark">toggle_mark</a>(self, item)</dt></dl> <dl><dt><a name="Directory-unload">unload</a>(self)</dt></dl> <hr> Data and other attributes defined here: <dl><dt>content_loaded = False</dl> <dl><dt>content_outdated = False</dl> <dl><dt>cycle_list = None</dl> <dl><dt>disk_usage = 0</dl> <dl><dt>enterable = False</dl> <dl><dt>filenames = None</dl> <dl><dt>files = None</dl> <dl><dt>filter = None</dl> <dl><dt>is_directory = True</dl> <dl><dt>last_update_time = -1</dl> <dl><dt>load_content_mtime = -1</dl> <dl><dt>load_generator = None</dl> <dl><dt>loading = False</dl> <dl><dt>marked_items = None</dl> <dl><dt>mount_path = '/'</dl> <dl><dt>order_outdated = False</dl> <dl><dt>scroll_begin = 0</dl> <dl><dt>scroll_offset = 0</dl> <dl><dt>sort_dict = {'basename': <function sort_by_basename>, 'mtime': <function <lambda>>, 'size': <function <lambda>>, 'type': <function <lambda>>}</dl> <hr> Methods inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>: <dl><dt><a name="Directory-__repr__">__repr__</a>(self)</dt></dl> <dl><dt><a name="Directory-__str__">__str__</a>(self)</dt><dd><tt>returns a string containing the absolute path</tt></dd></dl> <dl><dt><a name="Directory-get_description">get_description</a>(self)</dt></dl> <dl><dt><a name="Directory-get_permission_string">get_permission_string</a>(self)</dt></dl> <dl><dt><a name="Directory-go">go</a>(self)</dt><dd><tt>enter the directory if the filemanager is running</tt></dd></dl> <dl><dt><a name="Directory-is_older_than">is_older_than</a>(self, seconds)</dt><dd><tt>returns whether this object wasn't <a href="#Directory-use">use</a>()d in the last n seconds</tt></dd></dl> <dl><dt><a name="Directory-load">load</a>(self)</dt><dd><tt>reads useful information about the filesystem-object from the filesystem and caches it for later use</tt></dd></dl> <dl><dt><a name="Directory-load_if_outdated">load_if_outdated</a>(self)</dt><dd><tt>Calls <a href="#Directory-load">load</a>() if the currently cached information is outdated or nonexistant.</tt></dd></dl> <dl><dt><a name="Directory-mark">mark</a>(self, boolean)</dt></dl> <dl><dt><a name="Directory-set_mimetype">set_mimetype</a>(self)</dt><dd><tt>assign attributes such as self.video according to the mimetype</tt></dd></dl> <dl><dt><a name="Directory-use">use</a>(self)</dt><dd><tt>mark the filesystem-object as used at the current time</tt></dd></dl> <hr> Data descriptors inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>: <dl><dt>filetype</dt> </dl> <dl><dt>mimetype</dt> </dl> <dl><dt>mimetype_tuple</dt> </dl> <dl><dt>shell_escaped_basename</dt> </dl> <hr> Data and other attributes inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>: <dl><dt>accessible = False</dl> <dl><dt>audio = False</dl> <dl><dt>basename = None</dl> <dl><dt>basename_lower = None</dl> <dl><dt>container = False</dl> <dl><dt>dirname = None</dl> <dl><dt>document = False</dl> <dl><dt>exists = False</dl> <dl><dt>extension = None</dl> <dl><dt>force_load = False</dl> <dl><dt>image = False</dl> <dl><dt>infostring = None</dl> <dl><dt>is_device = False</dl> <dl><dt>is_fifo = False</dl> <dl><dt>is_file = False</dl> <dl><dt>is_link = False</dl> <dl><dt>is_socket = False</dl> <dl><dt>last_used = None</dl> <dl><dt>loaded = False</dl> <dl><dt>marked = False</dl> <dl><dt>media = False</dl> <dl><dt>path = None</dl> <dl><dt>permissions = None</dl> <dl><dt>runnable = False</dl> <dl><dt>size = 0</dl> <dl><dt>stat = None</dl> <dl><dt>stopped = False</dl> <dl><dt>tagged = False</dl> <dl><dt>video = False</dl> <hr> Data descriptors inherited from <a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>: <dl><dt>__dict__</dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Data and other attributes inherited from <a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>: <dl><dt>mimetypes = {}</dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>: <dl><dt>fm = None</dl> <hr> Methods inherited from <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>: <dl><dt><a name="Directory-get_height">get_height</a>(self)</dt><dd><tt>OVERRIDE THIS</tt></dd></dl> <dl><dt><a name="Directory-move">move</a>(self, narg=None, **keywords)</dt></dl> <dl><dt><a name="Directory-pointer_is_synced">pointer_is_synced</a>(self)</dt></dl> <dl><dt><a name="Directory-sync_index">sync_index</a>(self, **kw)</dt></dl> <hr> Data and other attributes inherited from <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>: <dl><dt>settings = {}</dl> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> <td colspan=3 valign=bottom>  <big>Functions</big></td></tr> <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td> <td width="100%"><dl><dt><a name="-accept_file">accept_file</a>(fname, hidden_filter, name_filter)</dt></dl> <dl><dt><a name="-sort_by_basename">sort_by_basename</a>(path)</dt><dd><tt>returns path.basename (for sorting)</tt></dd></dl> <dl><dt><a name="-sort_by_basename_icase">sort_by_basename_icase</a>(path)</dt><dd><tt>returns case-insensitive path.basename (for sorting)</tt></dd></dl> <dl><dt><a name="-sort_by_directory">sort_by_directory</a>(path)</dt><dd><tt>returns 0 if path is a directory, otherwise 1 (for sorting)</tt></dd></dl> <dl><dt><a name="-time">time</a>(...)</dt><dd><tt><a href="#-time">time</a>() -> floating point number   Return the current time in seconds since the Epoch. Fractions of a second may be present if the system clock provides them.</tt></dd></dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom>  <big>Data</big></td></tr> <tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td> <td width="100%">BAD_INFO = '?'</td></tr></table> </body></html>