Improved auto-generated source code readability

parser/source_builder.py

@@ -7,6 +7,9 @@ class SourceBuilder:
         self.indent_size = indent_size
         self.out_stream = out_stream
 
+        # Was a new line added automatically before? If so, avoid it
+        self.auto_added_line = False
+
     def indent(self):
         """Indents the current source code line by the current indentation level"""
         self.write(' ' * (self.current_indent * self.indent_size))
@@ -29,10 +32,17 @@ class SourceBuilder:
         if string and string[-1] == ':':
             self.current_indent += 1
 
+        # Clear state after the user adds a new line
+        self.auto_added_line = False
+
     def end_block(self):
         """Ends an indentation block, leaving an empty line afterwards"""
         self.current_indent -= 1
-        self.writeln()
+
+        # If we did not add a new line automatically yet, now it's the time!
+        if not self.auto_added_line:
+            self.writeln()
+            self.auto_added_line = True
 
     def __str__(self):
         self.out_stream.seek(0)

tl/tlobject.py

@@ -73,7 +73,7 @@ class TLObject:
                         result=match.group(3),
                         is_function=is_function)
 
-    def __str__(self):
+    def __repr__(self):
         fullname = ('{}.{}'.format(self.namespace, self.name) if self.namespace is not None
                     else self.name)
 
@@ -84,6 +84,23 @@ class TLObject:
                                       ' '.join([str(arg) for arg in self.args]),
                                       self.result)
 
+    def __str__(self):
+        fullname = ('{}.{}'.format(self.namespace, self.name) if self.namespace is not None
+                    else self.name)
+
+        # Some arguments are not valid for being represented, such as the flag indicator or generic definition
+        # (these have no explicit values until used)
+        valid_args = [arg for arg in self.args
+                if not arg.flag_indicator and not arg.generic_definition]
+
+        args = ', '.join(['{} = {{}}'.format(arg.name) for arg in valid_args])
+        args_format = ', '.join(['self.{}'.format(arg.name) for arg in valid_args])
+
+        return ("'({} (ID: {}) = ({}))'.format({})"
+                .format(fullname, hex(self.id), args, args_format))
+
+
+
 
 class TLArg:
     def __init__(self, name, type, generic_definition):

tl_generator.py

@@ -137,6 +137,15 @@ def generate_tlobjects(scheme_file):
                         builder.writeln('pass')
                 builder.end_block()
 
+                # Write the __repr__(self) and __str__(self) functions
+                builder.writeln('def __repr__(self):')
+                builder.writeln("return '{}'".format(repr(tlobject)))
+                builder.end_block()
+
+                builder.writeln('def __str__(self):')
+                builder.writeln("return {}".format(str(tlobject)))
+                # builder.end_block()  # There is no need to end the last block
+
     # Once all the objects have been generated, we can now group them in a single file
     filename = os.path.join('tl', 'all_tlobjects.py')
     with open(filename, 'w', encoding='utf-8') as file:

unit_test.py

@@ -101,11 +101,11 @@ class UnitTest(unittest.TestCase):
             assert value == 25.0, 'Example double should be 25.0 but is {}'.format(value)
 
             value = reader.read(7)
-            assert value == bytes([26, 27, 28, 29, 30, 31, 32]), 'Example bytes should be {} but is {}'\
+            assert value == bytes([26, 27, 28, 29, 30, 31, 32]), 'Example bytes should be {} but is {}' \
                 .format(bytes([26, 27, 28, 29, 30, 31, 32]), value)
 
             value = reader.read_large_int(128, signed=False)
-            assert value == 2**127, 'Example large integer should be {} but is {}'.format(2**127, value)
+            assert value == 2 ** 127, 'Example large integer should be {} but is {}'.format(2 ** 127, value)
 
         # Test Telegram that types are written right
         with BinaryWriter() as writer:
@@ -187,8 +187,8 @@ class UnitTest(unittest.TestCase):
 
         # Now test more cases
         for repr, real in zip(
-            ['24-9D-FE-49-20-45-DF-C3', '60-44-F3-33', '61-5F-61-31'],
+                ['24-9D-FE-49-20-45-DF-C3', '60-44-F3-33', '61-5F-61-31'],
-            [2638544546736496579, 1615131443, 1633640753]
+                [2638544546736496579, 1615131443, 1633640753]
         ):
             bytez = get_bytes(repr)
             if len(bytez) > 8:
@@ -205,7 +205,7 @@ class UnitTest(unittest.TestCase):
 
         plain_text = AES.decrypt_ige(cipher_text, key, iv)
         real = get_bytes('FB-17-EB-54-86-B6-49-1C-DF-D8-24-E6-D9-82-37-44-66-18-84-9F-BA-0D-89-B5-81-0D-47-B2-1B-CB-56-3F-7F-69-3A-22-0A-30-39-71-EE-1F-40-B2-A7-1A-4B-BD-76-7E-7A-FD-20-68-58-5F-03-00-00-00-FE-00-01-00-C7-1C-AE-B9-C6-B1-C9-04-8E-6C-52-2F-70-F1-3F-73-98-0D-40-23-8E-3E-21-C1-49-34-D0-37-56-3D-93-0F-48-19-8A-0A-A7-C1-40-58-22-94-93-D2-25-30-F4-DB-FA-33-6F-6E-0A-C9-25-13-95-43-AE-D4-4C-CE-7C-37-20-FD-51-F6-94-58-70-5A-C6-8C-D4-FE-6B-6B-13-AB-DC-97-46-51-29-69-32-84-54-F1-8F-AF-8C-59-5F-64-24-77-FE-96-BB-2A-94-1D-5B-CD-1D-4A-C8-CC-49-88-07-08-FA-9B-37-8E-3C-4F-3A-90-60-BE-E6-7C-F9-A4-A4-A6-95-81-10-51-90-7E-16-27-53-B5-6B-0F-6B-41-0D-BA-74-D8-A8-4B-2A-14-B3-14-4E-0E-F1-28-47-54-FD-17-ED-95-0D-59-65-B4-B9-DD-46-58-2D-B1-17-8D-16-9C-6B-C4-65-B0-D6-FF-9C-A3-92-8F-EF-5B-9A-E4-E4-18-FC-15-E8-3E-BE-A0-F8-7F-A9-FF-5E-ED-70-05-0D-ED-28-49-F4-7B-F9-59-D9-56-85-0C-E9-29-85-1F-0D-81-15-F6-35-B1-05-EE-2E-4E-15-D0-4B-24-54-BF-6F-4F-AD-F0-34-B1-04-03-11-9C-D8-E3-B9-2F-CC-5B-FE-00-01-00-22-8A-8F-62-58-9E-D1-9F-4B-53-EC-FB-22-E0-52-6B-8E-09-2E-B6-4B-90-53-30-A7-1F-52-1F-5B-3C-8F-AC-12-5B-D3-35-22-2A-1E-3E-9F-BD-33-73-B3-5C-1A-A6-8E-01-35-B4-8C-92-AE-D9-A0-86-6C-EF-CA-C9-09-4E-3B-B8-E5-F6-76-EE-F9-E7-CE-F1-DF-9E-F1-2E-92-55-DF-CF-80-68-70-AD-D1-AB-B2-34-54-E0-BF-38-A6-F4-C4-5B-64-96-8F-C7-14-18-84-7A-0A-44-38-56-1A-E4-9E-16-81-9D-AF-CC-A5-0E-17-D1-9E-DB-DE-DD-14-7D-04-71-99-06-32-3E-92-CE-D4-6E-76-10-DF-17-D9-2E-97-6A-F0-81-CC-ED-D5-20-10-60-AD-D8-7B-C2-FB-7D-87-CD-1E-B7-0E-28-1A-78-61-9C-8A-CA-81-A0-03-B2-40-7F-AE-BB-E3-21-96-74-01-A6-E2-C0-D8-17-C9-19-78-AD-1C-51-12-DC-29-8F-50-CA-8A-2F-56-89-A4-AC-E0-0F-C1-71-E4-C7-33-71-AE-83-30-59-D1-33-C2-D6-A6-F1-E8-FC-1F-77-3D-ED-E9-BF-B5-1C-6F-C0-9E-81-4B-B2-5A-51-C3-94-6B-BD-AD-5C-FF-DD-4B-0C-DB-E8-DA-0D-CB-57-B5-AC-D0-95-9E-FC-8F-F8')
-        assert  plain_text == real, 'Decrypted text does not equal the real value (expected "{}", got "{}")'\
+        assert plain_text == real, 'Decrypted text does not equal the real value (expected "{}", got "{}")'\
             .format(get_representation(real), get_representation(plain_text))
 
     @staticmethod
@@ -216,7 +216,7 @@ class UnitTest(unittest.TestCase):
 
         cipher_text = AES.encrypt_ige(original_text, key, iv)
         real = get_bytes('57-A9-1C-BB-4A-B5-C7-B1-51-9E-A9-24-15-94-4B-63-CB-2F-50-93-B7-54-11-D8-F1-77-13-AE-DE-58-12-AF-C2-E1-10-1D-2C-38-7D-DD-A2-BD-6B-43-84-7E-B1-E5-51-69-62-36-A1-86-8D-02-25-B9-AA-0B-E2-32-13-2A-0F-D1-58-67-47-07-C9-FE-E0-0F-EE-EC-92-B8-65-BD-C4-69-31-B6-10-4E-8F-20-B6-8F-72-79-A0-A3-8F-63-37-4B-95-5F-A4-B0-E6-EE-49-BE-76-47-3E-F9-FF-AA-F6-B7-16-CD-24-09-B1-63-26-02-13-B8-99-BD-19-7F-E2-A5-91-BE-52-86-FF-EA-C9-05-3C-D6-19-AE-E6-D1-25-7F-38-AF-66-CF-F8-B7-E6-53-E3-F6-98-0D-EF-A8-BA-97-6F-20-09-69-29-73-12-5E-0F-77-10-DC-22-BB-23-25-1D-53-A6-10-26-EB-EB-5E-C4-86-04-F5-30-5B-BA-53-AE-EA-84-28-34-91-75-B8-F2-0B-74-D1-00-3A-7E-FE-F0-B5-BE-0E-86-21-61-5F-81-75-23-49-45-CB-07-57-78-AB-9B-80-A2-0A-46-DB-35-49-6A-08-5B-8B-55-4E-6E-1B-E0-E0-3E-E7-2A-06-A0-5D-4F-EA-71-1A-24-F4-F4-AF-95-4B-F2-9A-C5-FD-7F-6A-DD-61-2D-B3-29-DB-5B-D9-A8-CF-60-8F-36-85-04-B5-85-3F-78-EB-09-0C-B4-F4-2D-B8-67-71-2A-4B-1B-08-0C-18-A2-9E-30-13-0C-23-18-7A-43-73-D3-DC-38-F5-9A-4A-08-28-BD-A2-DC-A8-70-33-63-9E-A9-72-DF-72-A5-43-AB-A2')
-        assert  cipher_text == real, 'Decrypted text does not equal the real value (expected "{}", got "{}")'\
+        assert cipher_text == real, 'Decrypted text does not equal the real value (expected "{}", got "{}")'\
             .format(get_representation(real), get_representation(cipher_text))
 
     @staticmethod