Trees       Indices       Help   
Package flumotion :: Package component :: Package misc :: Package httpserver :: Module localprovider :: Class LocalFile
[hide private]

Class LocalFile

source code

             object --+    
                      |    
      fileprovider.File --+
                          |
extern.log.log.Loggable --+
                          |
                         LocalFile

I offer a fake asynchronous wrapper around a synchronous file. I'm not thread-safe, I should only be used to read small blocks from a local file system and I don't support cloning.

Instance Methods [hide private]
 
__init__(self, path, mimeType)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 source code
 
__str__(self)
str(x)		 source code
long
getsize(self)
Returns: the size of the file		 source code
int
getmtime(self)
Returns: the modification time of the file		 source code
long
tell(self)
Returns: the current read/write position in the file		 source code
 
seek(self, offset)
Moves the reading/writing position inside the file.		 source code
 
read(self, size)
Reads the specified amount of data asynchronously.		 source code
 
close(self)
Close and cleanup the file.		 source code
 
__del__(self) source code
dict
getLogFields(self)
Returns: a dictionary of log fields related to the file usage		 source code

Inherited from fileprovider.File: getMimeType

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  logCategory = 'fileprovider-local'
Implementors can provide a category to log their messages under.
  _errorLookup = {2: <class 'flumotion.component.misc.httpserver...
  mimeType = None
hash(x)
  _file = None
hash(x)
  _info = None
hash(x)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, path, mimeType)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

getsize(self)

source code 
Returns: long
the size of the file
Overrides: fileprovider.File.getsize
(inherited documentation)

getmtime(self)

source code 
Returns: int
the modification time of the file
Overrides: fileprovider.File.getmtime
(inherited documentation)

tell(self)

source code 
Returns: long
the current read/write position in the file
Overrides: fileprovider.File.tell
(inherited documentation)

seek(self, offset)

source code 

Moves the reading/writing position inside the file. Only support absolute offset from file start.

Parameters:
  • offset - the byte offset from the start of the file to go to
Overrides: fileprovider.File.seek
(inherited documentation)

read(self, size)

source code 

Reads the specified amount of data asynchronously.

Parameters:
  • size - the amount of byte to read from the file
Returns:
a deferred fired with the read data or a failure. The data can be empty or smaller than the wanted size if the end of file is reached.
Overrides: fileprovider.File.read
(inherited documentation)

close(self)

source code 

Close and cleanup the file.

Overrides: fileprovider.File.close
(inherited documentation)

getLogFields(self)

source code 
Returns: dict
a dictionary of log fields related to the file usage
Overrides: fileprovider.File.getLogFields
(inherited documentation)

Class Variable Details [hide private]

_errorLookup

Value:
{2: <class 'flumotion.component.misc.httpserver.fileprovider.NotFoundE\
rror'>,
 13: <class 'flumotion.component.misc.httpserver.fileprovider.AccessEr\
ror'>,
 20: <class 'flumotion.component.misc.httpserver.fileprovider.NotFound\
Error'>,
 21: <class 'flumotion.component.misc.httpserver.fileprovider.CannotOp\
enError'>}

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sun Nov 15 09:17:33 2009 http://epydoc.sourceforge.net