Refactoring. Using black code style

Author: gil9red

struct__examples__parse_binary_files/hello_world.py

@@ -1,19 +1,18 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 import struct
 
 
-msg = struct.pack('>I12s', 12, b'Hello World!')
+msg = struct.pack(">I12s", 12, b"Hello World!")
 print(msg)  # b'\x00\x00\x00\x0cHello World!'
 print()
 
-data = struct.unpack('>I12s', msg)
+data = struct.unpack(">I12s", msg)
 print(data)  # (12, b'Hello World!')
 
-data = struct.unpack('>I12s', b'\x00\x00\x00\x0cHello World!')
+data = struct.unpack(">I12s", b"\x00\x00\x00\x0cHello World!")
 print(data)  # (12, b'Hello World!')
-

struct__examples__parse_binary_files/read_BMP_header/main.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 # SOURCE: https://ru.wikipedia.org/wiki/BMP
@@ -14,41 +14,40 @@
 
 # https://en.wikipedia.org/wiki/BMP_file_format#DIB_header_(bitmap_information_header)
 SIZE_BY_HEADER_TYPE = {
-    12: 'BITMAPCOREHEADER / OS21XBITMAPHEADER',
-    64: 'OS22XBITMAPHEADER',
-    16: 'OS22XBITMAPHEADER',
-    40: 'BITMAPINFOHEADER',
-    52: 'BITMAPV2INFOHEADER',
-    56: 'BITMAPV3INFOHEADER',
-    108: 'BITMAPV4HEADER',
-    124: 'BITMAPV5HEADER',
+    12: "BITMAPCOREHEADER / OS21XBITMAPHEADER",
+    64: "OS22XBITMAPHEADER",
+    16: "OS22XBITMAPHEADER",
+    40: "BITMAPINFOHEADER",
+    52: "BITMAPV2INFOHEADER",
+    56: "BITMAPV3INFOHEADER",
+    108: "BITMAPV4HEADER",
+    124: "BITMAPV5HEADER",
 }
 
 
 def print_info(file_name: str):
-    with open(file_name, 'rb') as f:
+    with open(file_name, "rb") as f:
         # Bitmap file header
         # BITMAPFILEHEADER
         bfType = f.read(2)
-        print('bfType:', bfType)
+        print("bfType:", bfType)
 
         data = f.read(12)
-        bfSize, bfReserved1, bfReserved2, bfOffBits \
-            = struct.unpack('<IHHI', data)
-        print('bfSize:', bfSize)
-        print('bfReserved1:', bfReserved1)
-        print('bfReserved2:', bfReserved2)
-        print('bfOffBits:', bfOffBits)
+        bfSize, bfReserved1, bfReserved2, bfOffBits = struct.unpack("<IHHI", data)
+        print("bfSize:", bfSize)
+        print("bfReserved1:", bfReserved1)
+        print("bfReserved2:", bfReserved2)
+        print("bfOffBits:", bfOffBits)
 
         # DIB header
         data = f.read(4)
-        size = struct.unpack('<I', data)[0]
-        print('size:', size)
-        print('Header:', SIZE_BY_HEADER_TYPE.get(size, '<Unknown>'))
+        size = struct.unpack("<I", data)[0]
+        print("size:", size)
+        print("Header:", SIZE_BY_HEADER_TYPE.get(size, "<Unknown>"))
 
 
-if __name__ == '__main__':
-    for file_name in glob.glob('*.bmp'):
+if __name__ == "__main__":
+    for file_name in glob.glob("*.bmp"):
         print(file_name)
         print_info(file_name)
         print()

struct__examples__parse_binary_files/read_JPEG_header/main.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 # SOURCE: http://vip.sugovica.hu/Sardi/kepnezo/JPEG%20File%20Layout%20and%20Format.htm
@@ -15,14 +15,14 @@
 def print_info(file_name: str):
     print(file_name)
 
-    with open(file_name, 'rb') as f:
+    with open(file_name, "rb") as f:
         # JFIF APP0
 
         # Read SOI
         data = f.read(2)
 
-        if data != b'\xff\xd8':
-            print('Not valid JPEG!')
+        if data != b"\xff\xd8":
+            print("Not valid JPEG!")
             return
 
         # APP0 marker FF E0
@@ -37,37 +37,37 @@ def print_info(file_name: str):
         # Find 0xff, 0xc0 to identify SOF0 marker
         while data:
             data = f.read(1)
-            if data == b'\xff' and f.read(1) == b'\xc0':
+            if data == b"\xff" and f.read(1) == b"\xc0":
                 break
 
         # This value equals to 8 + components*3 value
-        length, = struct.unpack('>H', f.read(2))
+        (length,) = struct.unpack(">H", f.read(2))
         # print('Length:', length)
 
         # This is in bits/sample, usually 8 (12 and 16 not supported by most software).
-        data_precision, = struct.unpack('>b', f.read(1))
+        (data_precision,) = struct.unpack(">b", f.read(1))
         # print('Data precision:', data_precision)
 
-        height, width = struct.unpack('>HH', f.read(4))
-        print(f'    Size: {width}x{height}')
+        height, width = struct.unpack(">HH", f.read(4))
+        print(f"    Size: {width}x{height}")
 
         # Usually 1 = grey scaled, 3 = color YcbCr or YIQ 4 = color CMYK
-        number_of_components, = struct.unpack('>b', f.read(1))
+        (number_of_components,) = struct.unpack(">b", f.read(1))
         # print('Number of components:', number_of_components)
 
         # Each component:
         #   component Id(1byte): (1 = Y, 2 = Cb, 3 = Cr, 4 = I, 5 = Q)
         #   sampling factors (1byte) (bit 0-3 vertical., 4-7 horizontal.)
         #   quantization table number (1 byte)
-        component_id, \
-        sampling_factors, \
-        quantization_table_number = struct.unpack('>bbb', f.read(3))
+        component_id, sampling_factors, quantization_table_number = struct.unpack(
+            ">bbb", f.read(3)
+        )
         # print('Component id:', component_id)
         # print('Sampling factors:', sampling_factors)
         # print('Quantization table number:', quantization_table_number)
 
 
-if __name__ == '__main__':
-    for file_name in glob.glob('*.jpg') + glob.glob('*.jpeg'):
+if __name__ == "__main__":
+    for file_name in glob.glob("*.jpg") + glob.glob("*.jpeg"):
         print_info(file_name)
         print()

struct__examples__parse_binary_files/read_PNG_header/main.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 # SOURCE: http://www.libpng.org/pub/png/spec/1.2/PNG-Structure.html
@@ -10,7 +10,6 @@
 
 import glob
 import struct
-
 import zlib
 
 
@@ -22,19 +21,19 @@ def print_info(file_name: str):
     print(file_name)
 
     def read_chunk(f) -> (int, bytes, bytes, int):
-        chunk_length, = struct.unpack('>I', f.read(4))
+        (chunk_length,) = struct.unpack(">I", f.read(4))
         chunk_type = f.read(4)
         chunk_data = f.read(chunk_length)
-        chunk_CRC, = struct.unpack('>I', f.read(4))
+        (chunk_CRC,) = struct.unpack(">I", f.read(4))
 
         return chunk_length, chunk_type, chunk_data, chunk_CRC
 
-    with open(file_name, 'rb') as f:
+    with open(file_name, "rb") as f:
         # HEADER
         data = f.read(8)
 
-        if data != b'\x89PNG\r\n\x1a\n':
-            print('Not valid PNG!')
+        if data != b"\x89PNG\r\n\x1a\n":
+            print("Not valid PNG!")
             return
 
         # After the header comes a series of chunks, each of which conveys certain information about the image.
@@ -56,17 +55,19 @@ def read_chunk(f) -> (int, bytes, bytes, int):
         # Check CRC
         assert crc32_from_bytes(chunk_type + chunk_data) == chunk_CRC
 
-        width, \
-        height, \
-        bit_depth, \
-        color_type, \
-        compression_method, \
-        filter_method, \
-        interlace_method = struct.unpack('>IIbbbbb', chunk_data)
-        print(f'    Size: {width}x{height}')
+        (
+            width,
+            height,
+            bit_depth,
+            color_type,
+            compression_method,
+            filter_method,
+            interlace_method,
+        ) = struct.unpack(">IIbbbbb", chunk_data)
+        print(f"    Size: {width}x{height}")
 
 
-if __name__ == '__main__':
-    for file_name in glob.glob('*.png'):
+if __name__ == "__main__":
+    for file_name in glob.glob("*.png"):
         print_info(file_name)
         print()

struct__examples__parse_binary_files/read_mp3_header/main.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 # SOURCE: https://en.wikipedia.org/wiki/List_of_file_signatures
@@ -12,24 +12,25 @@
 
 
 def is_id3(data: bytes) -> bool:
-    return data[:3] == b'ID3'
+    return data[:3] == b"ID3"
 
 
 def is_mp3(data: bytes) -> bool:
     if is_id3(data):
         return True
 
     first_2 = data[:2]
-    for signature in [b'\xFF\xFB', b'\xFF\xF3', b'\xFF\xF2']:
+    for signature in [b"\xFF\xFB", b"\xFF\xF3", b"\xFF\xF2"]:
         if first_2 == signature:
             return True
 
     return False
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # SimplePyScripts\
     from pathlib import Path
+
     ROOT_DIR = Path(__file__).resolve().parent.parent.parent
 
     for file_name in ROOT_DIR.rglob("*.mp3"):
@@ -38,20 +39,24 @@ def is_mp3(data: bytes) -> bool:
         data = file_name.read_bytes()
         _is_mp3 = is_mp3(data)
         _is_id3 = is_id3(data)
-        print(f'    IS MP3: {_is_mp3}')
-        print(f'    IS ID3: {_is_id3}')
+        print(f"    IS MP3: {_is_mp3}")
+        print(f"    IS ID3: {_is_id3}")
         if _is_id3:
             header = data[:10]
 
             #  3b      2b      1b     4b
-            file_id, version, flags, size = struct.unpack('<3sHB4s', header)
-            real_size = int("".join(map(lambda x: bin(x)[2:].zfill(8), size)).replace('0', ''), 2)
-
-            print(f'    ID3.header: {"".join(map(lambda x: hex(x)[2:].zfill(2), header))}')
-            print(f'    ID3.file_id: {file_id}')
-            print(f'    ID3.version: {version}')
-            print(f'    ID3.flags: {bin(flags)[2:].zfill(8)}')
+            file_id, version, flags, size = struct.unpack("<3sHB4s", header)
+            real_size = int(
+                "".join(map(lambda x: bin(x)[2:].zfill(8), size)).replace("0", ""), 2
+            )
+
+            print(
+                f'    ID3.header: {"".join(map(lambda x: hex(x)[2:].zfill(2), header))}'
+            )
+            print(f"    ID3.file_id: {file_id}")
+            print(f"    ID3.version: {version}")
+            print(f"    ID3.flags: {bin(flags)[2:].zfill(8)}")
             print(f'    ID3.size: {" ".join(map(lambda x: hex(x)[2:].zfill(2), size))}')
-            print(f'    ID3.real_size: {real_size} bytes')
+            print(f"    ID3.real_size: {real_size} bytes")
 
         print()

struct__examples__parse_binary_files/read_zip_headers/main.py

@@ -1,35 +1,38 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-__author__ = 'ipetrash'
+__author__ = "ipetrash"
 
 
 # SOURCE: https://pep8.ru/doc/tutorial-3.1/11.html
 
 
 import struct
 
+# pip install tabulate
+from tabulate import tabulate
 
-with open('myfile.zip', 'rb') as f:
+
+with open("myfile.zip", "rb") as f:
     rows = []
-    headers = ('file_name', 'crc32', 'comp_size', 'uncomp_size')
+    headers = ("file_name", "crc32", "comp_size", "uncomp_size")
 
     data = f.read()
     start = 0
 
     # Показать первые три заголовка
     for _ in range(3):
         start += 14
-        fields = struct.unpack('<IIIHH', data[start:start + 16])
+        fields = struct.unpack("<IIIHH", data[start : start + 16])
         crc32, comp_size, uncomp_size, file_name_size, extra_size = fields
 
         start += 16
-        file_name = data[start:start + file_name_size]
-        file_name = str(file_name, 'utf-8')
+        file_name = data[start : start + file_name_size]
+        file_name = str(file_name, "utf-8")
         start += file_name_size
 
         print(
-            f'file_name: {file_name}, crc32: {hex(crc32)}, comp_size: {comp_size}, uncomp_size: {uncomp_size}'
+            f"file_name: {file_name}, crc32: {hex(crc32)}, comp_size: {comp_size}, uncomp_size: {uncomp_size}"
         )
         rows.append((file_name, hex(crc32), comp_size, uncomp_size))
 
@@ -38,7 +41,7 @@
 
     print()
 
-    # RESULT:
+    print(tabulate(rows, headers, tablefmt="grid"))
     # +-------------+------------+-------------+---------------+
     # | file_name   | crc32      |   comp_size |   uncomp_size |
     # +=============+============+=============+===============+
@@ -48,7 +51,3 @@
     # +-------------+------------+-------------+---------------+
     # | result.csv  | 0xefede9b1 |           8 |             6 |
     # +-------------+------------+-------------+---------------+
-
-    # pip install tabulate
-    from tabulate import tabulate
-    print(tabulate(rows, headers, tablefmt="grid"))