ranger - mirror of ranger - a simple, vim-like file manager

diff options

Diffstat (limited to 'doc/uml/python_imports')

-rw-r--r--

1 files changed, 1 insertions, 0 deletions

<!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/work/ranger/ranger/fsobject/directory.py">/home/hut/work/ranger/ranger/fsobject/directory.py</a></td></tr></table> <tt># Copyright (c) 2009, 2010 hut <hut@lavabit.com> # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</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></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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) </dt><dd> <dl> <dt><a href="ranger.fsobject.directory.html#NoDirectoryGiven">NoDirectoryGiven</a> </dt></dl> </dd> <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-__eq__">__eq__</a>(self, other)</dt><dd><tt>Check for equality of the directories paths</tt></dd></dl> <dl><dt><a name="Directory-__getitem__">__getitem__</a>(self, key)</dt><dd><tt>Get the file by its index</tt></dd></dl> <dl><dt><a name="Directory-__hash__">__hash__</a>(self)</dt></dl> <dl><dt><a name="Directory-__init__">__init__</a>(self, path)</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-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>cycle_list = None</dl> <dl><dt>enterable = False</dl> <dl><dt>filenames = None</dl> <dl><dt>files = None</dl> <dl><dt>filter = None</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>old_directories_first = None</dl> <dl><dt>old_filter = None</dl> <dl><dt>old_reverse = None</dl> <dl><dt>old_show_hidden = None</dl> <dl><dt>old_sort = None</dl> <dl><dt>scroll_begin = 0</dl> <dl><dt>scroll_offset = 0</dl> <dl><dt>sort_dict = {'basename': <function sort_by_basename at 0x7f28d0ab3160>, 'mtime': <function <lambda> at 0x7f28d0ab37c0>, 'size': <function <lambda> at 0x7f28d0ab3738>, 'type': <function <lambda> at 0x7f28d0ab3848>}</dl> <hr> Methods inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>: <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-load_once">load_once</a>(self)</dt><dd><tt>calls <a href="#Directory-load">load</a>() if it has not been called at least once yet</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 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>content_loaded = 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>islink = 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>mimetype_tuple = ()</dl> <dl><dt>path = None</dl> <dl><dt>permissions = None</dl> <dl><dt>readlink = 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>type = 'unknown'</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, relative=0, absolute=None, pages=None, narg=None)</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 = <ranger.ext.openstruct.OpenStruct object at 0x7f28d0aa5bd0></dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="NoDirectoryGiven">class NoDirectoryGiven</a>(<a href="builtins.html#Exception">builtins.Exception</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#NoDirectoryGiven">NoDirectoryGiven</a></dd> <dd><a href="builtins.html#Exception">builtins.Exception</a></dd> <dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> <dd><a href="builtins.html#object">builtins.object</a></dd> </dl> <hr> Data descriptors defined here: <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Methods inherited from <a href="builtins.html#Exception">builtins.Exception</a>: <dl><dt><a name="NoDirectoryGiven-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> <hr> Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>: <dl><dt>__new__ = <built-in method __new__ of type object at 0x7f28d265e120><dd><tt>T.<a href="#NoDirectoryGiven-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> <hr> Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt><a name="NoDirectoryGiven-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> <dl><dt><a name="NoDirectoryGiven-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> <dl><dt><a name="NoDirectoryGiven-__reduce__">__reduce__</a>(...)</dt></dl> <dl><dt><a name="NoDirectoryGiven-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> <dl><dt><a name="NoDirectoryGiven-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> <dl><dt><a name="NoDirectoryGiven-__setstate__">__setstate__</a>(...)</dt></dl> <dl><dt><a name="NoDirectoryGiven-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__str__">__str__</a>() <==> str(x)</tt></dd></dl> <dl><dt><a name="NoDirectoryGiven-with_traceback">with_traceback</a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#NoDirectoryGiven-with_traceback">with_traceback</a>(tb) -- set self.__traceback__ to tb and return self.</tt></dd></dl> <hr> Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt>__cause__</dt> <dd><tt>exception cause</tt></dd> </dl> <dl><dt>__context__</dt> <dd><tt>exception context</tt></dd> </dl> <dl><dt>__dict__</dt> </dl> <dl><dt>__traceback__</dt> </dl> <dl><dt>args</dt> </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="-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_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 = None</td></tr></table> </body></html>


context:
space:
mode: