Changeset 3608

Timestamp:

08/23/08 16:48:00 (5 years ago)

Author:

getxsick

Message:

Never ending the docstrings story ;)

Location:

branch/UMPA/umpa/protocols

Files:

• ICMP.py (modified) (5 diffs)
• IP.py (modified) (12 diffs)
• Payload.py (modified) (6 diffs)
• TCP.py (modified) (10 diffs)
• UDP.py (modified) (7 diffs)
• _fields.py (modified) (4 diffs)
• _layer4.py (modified) (4 diffs)
• _protocols.py (modified) (1 diff)

branch/UMPA/umpa/protocols/ICMP.py

@@ -19 +19 @@
 # along with this library; if not, write to the Free Software Foundation, 
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+
+"""
+This module contains ICMP (Internet Control Message Protocol) protocol
+implementation.
+"""
 
 from umpa.protocols import _consts
@@ -282 +287 @@
 
 class _HChecksum(_fields.IntField):
+    """
+    A checksum of the ICMP protocol.
+    """
+
     bits = 16
     auto = True
@@ -291 +300 @@
 
 class ICMP(_protocols.Protocol):
+    """
+    Internet Control Message Protocol implementation.
+
+    It the most common protocol in the Internet on fourth layer
+    of the OSI model.
+    """
+    
     layer = 4
     protocol_id = _consts.PROTOCOL_ICMP
@@ -298 +314 @@
 
     def __init__(self, **kw):
+        """
+        Create a new ICMP().
+
+        @param **kw: pass to super-constructor.
+        """
+
         raise NotImplementedError("not finished yet")
         fields_list = [ _HType("Type"),
@@ -307 +329 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         return raw_value, bit
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         return raw_value, bit
 

branch/UMPA/umpa/protocols/IP.py

@@ -20 +20 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 
+"""
+This module contains IP (Internet Protocol) protocol implementation.
+"""
+
 from umpa.protocols import _consts
 from umpa.protocols import _fields
@@ -27 +31 @@
 
 class _HVersion(_fields.EnumField):
-    """The Version field indicates the format of the internet header.
-    
-    See RFC 791 for more.
-    """
+    """
+    The Version field indicates the format of the internet header.
+    
+    See RFC 791 for more.
+    """
+    
     bits = 4
     auto = True
@@ -41 +47 @@
 
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return _consts.IPVERSION_4
 
 class _HIHL(_fields.SpecialIntField):
-    """Internet Header Length is the length of the internet header in 32 bit
+    """
+    Internet Header Length is the length of the internet header in 32 bit
     words, and thus points to the beginning of the data.
     
     See RFC 791 for more.
     """
+
     bits = 4
     auto = True
-    def _generate_value(self):
+
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return 5 + self._tmp_value / 32 # 5 is a minimum value (see RFC 791)
 
 class _HTotalLength(_fields.SpecialIntField):
-    """Total Length is the length of the datagram, measured in octets,
+    """
+    Total Length is the length of the datagram, measured in octets,
     including internet header and data.
 
     See RFC 791 for more.
     """
+
     bits = 16
     auto = True
-    def _generate_value(self):
+    
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return self._tmp_value / _consts.BYTE
 
 class _HIdentification(_fields.IntField):
-    """An identifying value assigned by the sender to aid in assembling the
+    """
+    An identifying value assigned by the sender to aid in assembling the
     fragments of a datagram.
 
     See RFC 791 for more.
     """
+    
     bits = 16
     auto = True
-    def _generate_value(self):
+
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implementation of fragmentation
         # otherwise we can simple return 0 ;-)
@@ -79 +118 @@
 
 class _HFragmentOffset(_fields.IntField):
-    """This field indicates where in the datagram this fragment belongs.
-    
-    See RFC 791 for more.
-    """
+    """
+    This field indicates where in the datagram this fragment belongs.
+    
+    See RFC 791 for more.
+    """
+    
     bits = 13
     auto = True
-    def _generate_value(self):
+    
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implementation of fragmentation
         # otherwise we can simple return 0 ;-)
@@ -91 +139 @@
 
 class _HTTL(_fields.IntField):
-    """This field indicates the maximum time the datagram is allowed to
+    """
+    This field indicates the maximum time the datagram is allowed to
     remain in the internet system.
     
     See RFC 791 for more.
     """
+    
     bits = 8
     auto = True
-    def _generate_value(self):
+    
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: checking platform to get correct value of TTL
         # unfortunately, there isn't any official document which described
@@ -106 +163 @@
 
     def ttl(self, name):
-        """To set correct value of TTL for following platforms:
+        """
+        Set TTL field to default value of the passed platform.
+
+        Set correct value of TTL for the following platforms:
         AIX, DEC, FREEBSD, HPUX, IRIX, LINUX, MACOS, OS2, SOLARIS,
         SUNOS, ULTRIX, WINDOWS.
 
-        name argument can be pass as shown above or as TTL_NAME
+        @type name: C{str}
+        @param name: name of the platform (from the list above, TTL_ prefix
+                     also accepted.
         """
 
@@ -118 +180 @@
 
 class _HProtocol(_fields.SpecialIntField, _fields.EnumField):
-    """This field indicates the next level protocol used in the data portion
+    """
+    This field indicates the next level protocol used in the data portion
     of the internet datagram.
     
     See RFC 791 for more.
     """
+
     bits = 8
     auto = True
@@ -157 +221 @@
 
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return self._tmp_value
 
 class _HHeaderChecksum(_fields.IntField):
-    """A checksum on the header only.
-    
-    See RFC 791 for more.
-    """
+    """
+    A checksum of the header only.
+    
+    See RFC 791 for more.
+    """
+    
     bits = 16
     auto = True
-    def _generate_value(self):
+    
+    def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return 0        # HeaderChecksum field should be initialized by 0
 
@@ -172 +251 @@
 
 class IP(_protocols.Protocol):
-    """This is Internet Protocol.
+    """
+    Internet Protocol implementation.
+
     The main protocol in third layer of OSI model.
     """
+
     layer = 3      # layer of OSI
     protocol_id = _consts.ETHERTYPE_IP
@@ -186 +268 @@
 
     def __init__(self, **kw):
+        """
+        Create a new IP().
+
+        @param **kw: pass to super-constructor.
+        """
+
         tos = ('precedence0','precedence1', 'precedence2', 'delay',
                 'throughput', 'relibility', 'reserved0', 'reserved1')
@@ -237 +325 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        Set Padding field, calculate header and total length, set protocol of the upper
+        layer.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # Padding
         self._get_field('_padding')._tmp_value = \
@@ -265 +374 @@
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        Calculate header checksum.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # Header Checksum
         # a checksum on the header only.

branch/UMPA/umpa/protocols/Payload.py

@@ -20 +20 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 
+"""
+This module contains Payload "protocol" implementation.
+
+Payload is the abstract protocol of 5-7 layers of the OSI model.
+"""
+
 from umpa.protocols._fields import Field
 from umpa.protocols._protocols import Protocol
@@ -25 +31 @@
 
 class _HData(Field): # FIXME: should we move it to _fields.py as a common field?
-    """Data as a strings.
     """
+    Data as a strings.
+    """
+    
     bits = 0
     auto = False
 
     def _is_valid(self, val):
+        """
+        Validate if the value is not bigger than expected.
+
+        @param val: the new value.
+
+        @rtype: C{bool}
+        @return: C{True}.
+        """
         return True     # we use str() so everything is ok
 
     def set(self, value):
+        """
+        Set the new value of the field.
+
+        @param value: assign new value with str() casting.
+        """
         if self._is_valid(value):
             self._value = str(value)    # converting to str
@@ -43 +64 @@
 
     def clear(self):
-        super(Field, self).lear()
+        """
+        Clear the current value of the field.
+        """
+
+        super(Field, self).clear()
         self.bits = 0
 
     def _raw_value(self):
+        """
+        Convert the value to the raw mode.
+
+        Convert every character into the integer ordinal.
+        Merge the integer values.
+        Raw value's type is a number. It has to be in big-endian order.
+        The bits of the result of this method are inserted into the raw number
+        of the whole protocol.
+
+        @rtype: C{number}
+        @return: raw value of the field.
+        """
+
         raw = 0
         for char in self._value:
@@ -56 +94 @@
 
 class Payload(Protocol):
-    """Use this as a protocol upper 4th layer of OSI model.
     """
+    Payload -- data of 5-7 layers of the OSI model.
+    """
+
     layer = 5
     name = "Payload"
@@ -63 +103 @@
 
     def __init__(self, **kw):
+        """
+        Create a new Payload().
+
+        @param **kw: pass to super-constructor.
+        """
+
         fields_list = [ _HData("Data"), ]
 
@@ -68 +114 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        Nothing to do for Payload class here. Return required vars.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         return raw_value, bit
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        Nothing to do for Payload class here. Return required vars.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         return raw_value, bit
 

branch/UMPA/umpa/protocols/TCP.py

@@ -20 +20 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 
+"""
+This module contains TCP (Transmission Control Protocol) protocol
+implementation.
+"""
+
 from umpa.protocols import _consts
 from umpa.protocols import _fields
@@ -28 +33 @@
 
 class _HPort(_fields.EnumField):
+    """
+    TCP uses the notion of port numbers to identify sending and receiving
+    application end-points on a host, or Internet sockets.
+    """
+
     bits = 16
     auto = False
@@ -324 +334 @@
 
 class _HSequenceNumber(_fields.IntField):
-    """The sequence number of the first data octet in this segment (except
+    """
+    The sequence number of the first data octet in this segment (except
     when SYN is present).
 
     See RFC 793 for more.
     """
+
     bits = 32
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implemention real auto-filling here ;)
         # otherwise we can simple return 0
@@ -337 +356 @@
 
 class _HAcknowledgmentNumber(_fields.IntField):
-    """If the ACK control bit is set this field contains the value of the
+    """
+    If the ACK control bit is set this field contains the value of the
     next sequence number the sender of the segment is expecting to receive.
 
     See RFC 793 for more.
     """
+    
     bits = 32
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implemention real auto-filling here ;)
         # otherwise we can simple return 0
@@ -350 +378 @@
 
 class _HDataOffset(_fields.SpecialIntField):
-    """The number of 32 bit words in the TCP Header. This indicates where
+    """
+    The number of 32 bit words in the TCP Header. This indicates where
     the data begins.
 
     See RFC 793 for more.
     """
+    
     bits = 4
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # returns in 32-bits units
         return 5 + self._tmp_value / 32 # 5 is a minimum value
 
 class _HReserved(_fields.IntField):
-    """Reserved for future use.
+    """
+    Reserved for future use.
 
     See RFC 793 for more.
     """
+    
     bits = 6
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return 0
 
 class _HWindow(_fields.IntField):
-    """The number of data octets beginning with the one indicated in the
+    """
+    The number of data octets beginning with the one indicated in the
     acknowledgment field which the sender of this segment is willing to accept.
 
     See RFC 793 for more.
     """
+    
     bits = 16
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implemention real auto-filling here ;)
         # otherwise we can simple return 0
@@ -385 +440 @@
 
 class _HUrgentPointer(_fields.IntField):
-    """This field communicates the current value of the urgent pointer as a
+    """
+    This field communicates the current value of the urgent pointer as a
     positive offset from the sequence number in this segment.
 
     See RFC 793 for more.
     """
+    
     bits = 16
     auto = True
+    
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # TODO: implemention real auto-filling here ;)
         # otherwise we can simple return 0
@@ -398 +462 @@
 
 class TCP(_protocols.Protocol):
-    """This is Transmission Control Protocol.
+    """
+    Transmission Control Protocol implementation.
+
     It the most common protocol in the Internet on fourth layer
     of the OSI model.
     """
+    
     layer = 4       # layer of the OSI
     protocol_id = _consts.PROTOCOL_TCP
@@ -412 +479 @@
 
     def __init__(self, **kw):
+        """
+        Create a new TCP().
+
+        @param **kw: pass to super-constructor.
+        """
+
         control_bits = ('urg', 'ack', 'psh', 'rst', 'syn', 'fin')
         control_bits_predefined = dict.fromkeys(control_bits, 0)
@@ -450 +523 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        Set Padding field and calculate header length.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # Padding
         self._get_field('_padding')._tmp_value = \
@@ -461 +554 @@
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        Calculate header checksum with new instance of PseudoHeader object.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # rev_offset it the offset from the right side
         cksum_rev_offset = bit - self.get_offset('_checksum') - \

branch/UMPA/umpa/protocols/UDP.py

@@ -20 +20 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 
+"""
+This module contains UDP (Uset Datagram Protocol) protocol implementation.
+"""
+
 from umpa.protocols import _consts
 from umpa.protocols import _fields
@@ -28 +32 @@
 
 class _HPort(_fields.EnumField):
+    """
+    UDP uses ports to allow application-to-application communication.
+    """
+
     bits = 16
     auto = False
@@ -242 +250 @@
 
 class _HLength(_fields.SpecialIntField):
-    """Length  is the length  in octets  of this user datagram  including  this
+    """
+    Length  is the length  in octets  of this user datagram  including  this
     header  and the data.
-    """
+
+    See RFC 768 for more.
+    """
+    
     bits = 16
     auto = True
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         # returns in byte units
         return 8 + self._tmp_value/8    # minimum is 8
 
 class UDP(_protocols.Protocol):
-    """This is User Datagram Protocol.
+    """
+    User Datagram Protocol implementation.
     
     This protocol  provides  a procedure  for application  programs  to send
@@ -259 +278 @@
     are not guaranteed.
     """
+
     layer = 4
     protocol_id = _consts.PROTOCOL_UDP
@@ -267 +287 @@
 
     def __init__(self, **kw):
+        """
+        Create a new UDP().
+
+        @param **kw: pass to super-constructor.
+        """
+
         fields_list = [ _HPort("Source Port", 0),
                         _HPort("Destination Port", 0),
@@ -285 +311 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        Store temp value of protocols bits for checksum field.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # Length
         self._get_field('_checksum')._tmp_value = protocol_bits
@@ -291 +337 @@
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        Calculate header checksum with new instance of PseudoHeader object.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         cksum_rev_offset = 0
         # checking if user not defined his own value of checksum

branch/UMPA/umpa/protocols/_fields.py

@@ -151 +151 @@
         Convert the value to the raw mode.
 
-        Raw value is a number type. It has to be in big-endian order.
+        Raw value's type is a number. It has to be in big-endian order.
         The bits of the result of this method are inserted into the raw number
         of the whole protocol.
@@ -216 +216 @@
         Convert the value to the raw mode.
 
-        Raw value is a number type. It has to be in big-endian order.
+        Raw value's type is a number. It has to be in big-endian order.
         The bits of the result of this method are inserted into the raw number
         of the whole protocol.
@@ -383 +383 @@
         Convert the value to the raw mode.
 
-        Raw value is a number type. It has to be in big-endian order.
+        Raw value's type is a number. It has to be in big-endian order.
         The bits of the result of this method are inserted into the raw number
         of the whole protocol.
@@ -527 +527 @@
     def _generate_value(self):
         """
-        Generate value for undefined yet field.
+        Generate value for undefined field yet.
         
         @return: auto-generated value of the field.

branch/UMPA/umpa/protocols/_layer4.py

@@ -20 +20 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 
+"""
+This module contains usefull classes for 4th layer's protocols.
+
+TCP/UDP use special pseudo header to calculate checksum. These classes
+are provided.
+"""
+
 from umpa.protocols._protocols import Protocol
 from umpa.protocols.IP import IP
@@ -25 +32 @@
 
 class Layer4ChecksumField(IntField):
+    """
+    A checksum for the common classes of 4th layer of OSI model.
+
+    Especially UDP/TCP use it. The checksum is calculated from the Pseudo
+    Header, the main header and the payload.
+    """
+
     bits = 16
     auto = True
     def _generate_value(self):
+        """
+        Generate value for undefined field yet.
+        
+        @return: auto-generated value of the field.
+        """
+
         return 0
 
 class PseudoHeader(Protocol):
-    """This is class is useful for some protocols like TCP or UDP.
-    It has been used to calculate checksum of those protocols.
+    """
+    This is Pseudo Header.
+    
+    This class is useful for some protocols like TCP or UDP.
+    It's used to calculate checksum of those protocols.
     It's prefixed to the protocol header before calculating.
     """
+
     _ordered_fields = ('source_address', 'destination_address', 'reserved',
                     'protocol_id', 'total_length')
 
     def __init__(self, protocol_id, total_length):
+        """
+        Create a new PseudoHeader()
+
+        @type protocol_id: C{int}
+        @param protocol_id: id of the protocol which use PseudoHeader.
+
+        @type total_length: C{int}
+        @param total_length: length of the real header and payload.
+
+        """
 
         fields_list = [ IPv4AddrField("Source Address"),
@@ -48 +82 @@
 
     def _pre_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields before calling fillout() for them.
+
+        Parse lower protocol (usually IP) to get source/destination address.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         # we assign first localhost becuase if there is not IP instance
         # than better 0 than nothing (for nonstrict users)
@@ -63 +117 @@
 
     def _post_raw(self, raw_value, bit, protocol_container, protocol_bits):
+        """
+        Handle with fields after calling fillout() for them.
+
+        Nothing to do for PseudoHeader class here. Return required vars.
+
+        @type raw_value: C{int}
+        @param raw_value: currently raw value for the packet.
+
+        @type bit: C{int}
+        @param bit: currently length of the protocol.
+
+        @type protocol_container: C{tuple}
+        @param protocol_container: tuple of protocols included in the packet.
+
+        @type protocol_bits: C{int}
+        @param protocol_bits: currently length of the packet.
+
+        @return: C{raw_value, bit}
+        """
+
         return raw_value, bit

branch/UMPA/umpa/protocols/_protocols.py

@@ -36 +36 @@
 
 class Protocol(object):
-
-    """Superclass for every protocol's implementations.
+    """
+    Superclass for every protocol's implementations.
    
     You have to override following methods: