Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Package pyffi :: Package object_models :: Module binary_type :: Class FixedString
[hide private]
[frames] | no frames]

Class FixedString

source code

            object --+                
                     |                
utils.graph.DetailNode --+            
                         |            
          any_type.AnyType --+        
                             |        
        simple_type.SimpleType --+    
                                 |    
            object --+           |    
                     |           |    
utils.graph.DetailNode --+       |    
                         |       |    
          any_type.AnyType --+   |    
                             |   |    
                    BinaryType --+    
                                 |    
                  BinarySimpleType --+
                                     |
                    object --+       |
                             |       |
         editable.EditableBase --+   |
                                 |   |
         editable.EditableLineEdit --+
                                     |
                                    FixedString

String of fixed length. Default length is 0, so you must override this class and set the _len class variable.

>>> from tempfile import TemporaryFile
>>> f = TemporaryFile()
>>> class String8(FixedString):
...     _len = 8
>>> s = String8()
>>> if f.write('abcdefghij'.encode()): pass # ignore result for py3k
>>> if f.seek(0): pass # ignore result for py3k
>>> s.read(f)
>>> str(s)
'abcdefgh'
>>> if f.seek(0): pass # ignore result for py3k
>>> s.value = 'Hi There'
>>> s.write(f)
>>> if f.seek(0): pass # ignore result for py3k
>>> m = String8()
>>> m.read(f)
>>> str(m)
'Hi There'
Nested Classes [hide private]

Inherited from simple_type.SimpleType: __metaclass__

Instance Methods [hide private]
 
__init__(self)
Initialize the string.		 source code
str
__str__(self)
String representation.		 source code
C{bytes}
get_value(self)
Return the string.		 source code
 
set_value(self, value)
Set string to C{value}.		 source code
 
read(self, stream)
Read string from stream.		 source code
 
write(self, stream)
Write string to stream.		 source code
 
get_size(self)
Return number of bytes this type occupies in a file.		 source code

Inherited from simple_type.SimpleType: get_detail_display, is_interchangeable

Inherited from any_type.AnyType: __hash__

Inherited from utils.graph.DetailNode: get_detail_child_edge_types, get_detail_child_names, get_detail_child_nodes, get_detail_iterator, replace_global_node

Inherited from editable.EditableBase: get_editor_value, set_editor_value

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

Class Variables [hide private]
  _len = 0

Inherited from simple_type.SimpleType (private): _value

Properties [hide private]
  value
A property which wraps the actual data.

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
Initialize the string.
Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 
String representation. This implementation is simply a wrapper around str on _value.
Returns: str
String representation.
Overrides: object.__str__
(inherited documentation)

get_value(self)

source code 
Return the string.
Returns: C{bytes}
The stored string.
Overrides: simple_type.SimpleType.get_value

set_value(self, value)

source code 
Set string to C{value}.
Parameters:
  • value (str (encoded as default) or C{bytes}) - The value to assign.
Overrides: simple_type.SimpleType.set_value

read(self, stream)

source code 
Read string from stream.
Parameters:
  • stream (file) - The stream to read from.
Overrides: any_type.AnyType.read

write(self, stream)

source code 
Write string to stream.
Parameters:
  • stream (file) - The stream to write to.
Overrides: any_type.AnyType.write

get_size(self)

source code 
Return number of bytes this type occupies in a file.
Returns:
Number of bytes.
Overrides: BinaryType.get_size

Property Details [hide private]

value

A property which wraps the actual data. This property always calls set_value to assign the value, and ensures that the value is valid (type, range, ...). Unless you know what you are doing, always use the value property to change the data.
Get Method:
unreachable.get_value(self) - Return the string.
Set Method:
unreachable.set_value(self, value) - Set string to C{value}.

   Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Generated by Epydoc 3.0.1 on Mon Oct 10 19:03:56 2011 http://epydoc.sourceforge.net