rework of __str__

penguinolog · Feb 21, 2017 · df4b9ce · df4b9ce
1 parent 8a1afd0
commit df4b9ce
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 32 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,8 @@ Version 0.7.0
 -------------
 * Fixed long for python 2
 
+* __str__ has been reworked
+
 * Documentation has been updated
 
 Version 0.6.1

diff --git a/README.rst b/README.rst
@@ -22,8 +22,9 @@ Python binfield implementation for binary data manipulation.
     Why? Python supports binary data manipulation via binary operations out of the box and it's fast,
     but it's hard to read and painful during prototyping, especially for complex (nested) structures.
 
-    This library is desined to fix this issue: it allows to operate with binary data like dict with read-only keys:
+    This library is desined to fix this issue: it allows to operate with binary data like dict with constant indexes:
     you just need to define structure class and create an instance with start data.
+    Now you can use indexes for reading and writing data
 
 Example on real data (TCP header, constant part):
 
@@ -57,41 +58,65 @@ Example on real data (TCP header, constant part):
     # Construct from frame
     # (limitation: endianless convertation is not supported, make it by another tools)
     header = TCPHeader(0x0000BD1A043708050000078B000007F601BBAF0A)
+
     # Do not print header due to huge length (will be printed all bits)
+    >>> repr(header)
+    'TCPHeader(x=0x0000BD1A043708050000078B000007F601BBAF0A, base=16)'
+
+    >>> repr(header.source_port)
+    '<source_port(x=0xAF0A, base=16) at 0x7F890C8B9348>'
 
     >>> print(header.source_port)
-    44810<0xAF0A (0b1010111100001010 & 0b1111111111111111)>
+    <44810 == 0xAF0A == (0b1010111100001010 & 0b1111111111111111)>
+
+    >>> header.source_port == 44810  # Transparent comparsion with integers
+    True
+
+    >>> int(header.source_port)  # Painless conversion to int
+    44810
 
     >>> print(header.destination_port)
-    443<0x01BB (0b0000000110111011 & 0b1111111111111111)>  # Request multiple bytes
+    <443 == 0x01BB == (0b0000000110111011 & 0b1111111111111111)> # Request multiple bytes
 
     >>> print(header.data_offset)  # Request multiple bits
-    5<0x05 (0b0101 & 0b1111)>
+    <5 == 0x05 == (0b0101 & 0b1111)>
+
+    >>> print(header.destination_port[1: 3])  # Request several bits from nested block too
+    <1 == 0x01 == (0b01 & 0b11)>
 
     >>> print(header.flags)  # Request nested mapping block
-    64<0x0040 (0b0001000000 & 0b1111111111)
-      NS  = 0<0x00 (0b0 & 0b1)>
-      CWR = 0<0x00 (0b0 & 0b1)>
-      ECE = 0<0x00 (0b0 & 0b1)>
-      URG = 0<0x00 (0b0 & 0b1)>
-      ACK = 0<0x00 (0b0 & 0b1)>
-      PSH = 0<0x00 (0b0 & 0b1)>
-      RST = 1<0x01 (0b1 & 0b1)>
-      SYN = 0<0x00 (0b0 & 0b1)>
-      FIN = 0<0x00 (0b0 & 0b1)>
+    <16 == 0x0010 == (0b000010000 & 0b111111111)
+      NS  = <0 == 0x00 == (0b0 & 0b1)>
+      CWR = <0 == 0x00 == (0b0 & 0b1)>
+      ECE = <0 == 0x00 == (0b0 & 0b1)>
+      URG = <0 == 0x00 == (0b0 & 0b1)>
+      ACK = <1 == 0x01 == (0b1 & 0b1)>
+      PSH = <0 == 0x00 == (0b0 & 0b1)>
+      RST = <0 == 0x00 == (0b0 & 0b1)>
+      SYN = <0 == 0x00 == (0b0 & 0b1)>
+      FIN = <0 == 0x00 == (0b0 & 0b1)>
     >
 
     >>> print(header.flags.ACK == 0x01)  # Request single bit from nested mapping
     True
 
-    >>> print(header.window_size)
-    1079<0x0437 (0b0000010000110111 & 0b1111111111111111)>
-
-    >>> print(header.checksum)
-    48410<0xBD1A (0b1011110100011010 & 0b1111111111111111)>
-
     >>> print(header[: 4])  # Ignore indexes and just get few bits using slice
-    10<0x0A (0b1010 & 0b1111)>
+    <10 == 0x0A == (0b1010 & 0b1111)>
+
+    # Modification of nested data (if no type conversion was used) changes original object:
+    header.flags.FIN = 1
+    >>> print(header.flags)
+    <272 == 0x0110 == (0b100010000 & 0b111111111)
+      NS  = <0 == 0x00 == (0b0 & 0b1)>
+      CWR = <0 == 0x00 == (0b0 & 0b1)>
+      ECE = <0 == 0x00 == (0b0 & 0b1)>
+      URG = <0 == 0x00 == (0b0 & 0b1)>
+      ACK = <1 == 0x01 == (0b1 & 0b1)>
+      PSH = <0 == 0x00 == (0b0 & 0b1)>
+      RST = <0 == 0x00 == (0b0 & 0b1)>
+      SYN = <0 == 0x00 == (0b0 & 0b1)>
+      FIN = <1 == 0x01 == (0b1 & 0b1)>
+    >
 
 **Pros**:
 

diff --git a/binfield/binfield.py b/binfield/binfield.py
@@ -33,11 +33,13 @@
     int_types = int,
 else:
     binary_type = str
-    # pylint: disable=unicode-builtin, undefined-variable
+    # pylint: disable=unicode-builtin, undefined-variable, long-builtin
     # noinspection PyUnresolvedReferences
     text_type = unicode  # NOQA
-    # pylint: enable=unicode-builtin, undefined-variable
-    int_types = int, long
+    # noinspection PyUnresolvedReferences
+    int_types = int, long  # NOQA
+    # pylint: enable=unicode-builtin, undefined-variable, long-builtin
+
 
 string_types = str if _PY3 else text_type, binary_type
 
@@ -1072,7 +1074,9 @@ def process_element(self, src, indent=0, no_indent_start=False):
             return (
                 "{nl}"
                 "{spc:<{indent}}"
-                "{data}<0x{data:0{length}X} (0b{data:0{bit_length}b}{mask})"
+                "<{data} == "
+                "0x{data:0{length}X} == "
+                "(0b{data:0{bit_length}b}{mask})"
                 "{result}\n"
                 "{spc:<{indent}}>".format(
                     nl='\n' if no_indent_start else '',
@@ -1089,7 +1093,7 @@ def process_element(self, src, indent=0, no_indent_start=False):
         indent = 0 if no_indent_start else indent
         return (
             '{spc:<{indent}}'
-            '{data}<0x{data:0{length}X} (0b{data:0{blength}b}{mask})>'
+            '<{data} == 0x{data:0{length}X} == (0b{data:0{blength}b}{mask})>'
             ''.format(
                 spc='',
                 indent=indent,

diff --git a/test/test_baseFunc.py b/test/test_baseFunc.py
@@ -151,7 +151,7 @@ def test_not_mapped_no_len(self):
 
         bf |= 0xff
         self.assertEqual(
-            '255<0xFF (0b11111111)>',
+            '<255 == 0xFF == (0b11111111)>',
             str(bf),
         )
 
@@ -297,12 +297,12 @@ class NestedMappedBinField(BinField):
         self.assertNotEqual(hash(nested_copy), hash(nbf.nested_block))
         self.assertEqual(nbf, 0b11001101)  # Original
         self.assertEqual(
-            '205<0xCD (0b11001101 & 0b11111111)\n'
-            '  test_index   = 1<0x01 (0b1 & 0b1)>\n'
+            '<205 == 0xCD == (0b11001101 & 0b11111111)\n'
+            '  test_index   = <1 == 0x01 == (0b1 & 0b1)>\n'
             '  nested_block = \n'
-            '    6<0x06 (0b00110 & 0b11111)\n'
-            '      single_bit = 0<0x00 (0b0 & 0b1)>\n'
-            '      multiple   = 3<0x03 (0b11 & 0b11)>\n'
+            '    <6 == 0x06 == (0b00110 & 0b11111)\n'
+            '      single_bit = <0 == 0x00 == (0b0 & 0b1)>\n'
+            '      multiple   = <3 == 0x03 == (0b11 & 0b11)>\n'
             '    >\n'
             '>',
             str(nbf),