Trees       Indices       Help   
bitpim
Module prototypes :: Class CSVSTRING
[hide private]
[frames] | no frames]

Class CSVSTRING

source code

       object --+    
                |    
BaseProtogenClass --+
                    |
                   CSVSTRING
Known Subclasses:

A text string enclosed in quotes, with a way to escape quotes that a supposed to be part of the string. Typical of Samsung phones.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
A string value can be specified to this constructor, or in the value keyword arg.		 source code
 
_update(self, args, kwargs) source code
 
readfrombuffer(self, buf)
Get our value from the buffer		 source code
 
writetobuffer(self, buf)
Scribble ourselves to the buf		 source code
 
packetsize(self)
Returns size in bytes that we occupy		 source code
 
getvalue(self)
Returns the string we are		 source code

Inherited from BaseProtogenClass: autologread, autologwrite, iscontainer, packetspan, update

Inherited from BaseProtogenClass (private): _complainaboutunusedargs, _consumekw, _ismostderived

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

source code 

A string value can be specified to this constructor, or in the value keyword arg.

Parameters:
  • constant - (Optional) A constant value. All reads must have this value
  • terminator - (Default=,) The string terminator (or None). If set there will always be a terminator when writing. The terminator is not returned when getting the value.
  • quotechar - (Default=Double Quote) Quote character that surrounds string
  • readescape - (Default=True) Interpret PPP escape char (0x7d)
  • maxsizeinbytes - (Optional) On writing, truncate strings longer than this (length is before any escaping and quoting
  • default - (Optional) Our default value
  • raiseonunterminatedread - (Default True) raise NotTerminatedException if there is no terminator on the value being read in. terminator must also be set.
  • raiseontruncate - (Default True) raise ValueLengthException if the supplied value is too large to fit within sizeinbytes.
  • raiseonmissingquotes - (Default True) raise MissingQuotesException if the string does not have quote characters around it
  • value - (Optional) Value
  • invalidchars - (Default=quotechar) A string containing invalid characters which would be removed before writing to buffer.
  • encoding - (Default=None) If specified Unicode charset.
  • raiseonunicodeerror - (Default=True) raise exception if fail to encode/decode Unicode.
Overrides: object.__init__

_update(self, args, kwargs)

source code 
Overrides: BaseProtogenClass._update

readfrombuffer(self, buf)

source code 

Get our value from the buffer

Overrides: BaseProtogenClass.readfrombuffer
(inherited documentation)

writetobuffer(self, buf)

source code 

Scribble ourselves to the buf

Overrides: BaseProtogenClass.writetobuffer
(inherited documentation)

packetsize(self)

source code 

Returns size in bytes that we occupy

Overrides: BaseProtogenClass.packetsize
(inherited documentation)

getvalue(self)

source code 

Returns the string we are

Overrides: BaseProtogenClass.getvalue

   Trees       Indices       Help   
bitpim
Generated by Epydoc 3.0.1 on Sun Jan 24 16:20:54 2010 http://epydoc.sourceforge.net