[#374] Remove pre-write actions in Python

Author: mikir

compiler/extensions/python/freemarker/Bitmask.py.ftl

@@ -236,18 +236,15 @@ class ${name}:
     </#if>
         return bitposition + self.bitsizeof_packed(context_node, bitposition)
 
-    def write(self, writer: zserio.BitStreamWriter, *, zserio_call_initialize_offsets: bool = True) -> None:
+    def write(self, writer: zserio.BitStreamWriter) -> None:
     <#if withCodeComments>
         """
         Serializes this bitmask object to the bit stream.
 
         :param writer: Bit stream writer where to serialize this bitmask object.
-        :param zserio_call_initialize_offsets: True to call automatically initialize_offsets method before
-               writing, otherwise False.
         """
 
     </#if>
-        del zserio_call_initialize_offsets
         writer.write_${runtimeFunction.suffix}(self._value<#rt>
                                                <#lt><#if runtimeFunction.arg??>, ${runtimeFunction.arg}</#if>)
 

compiler/extensions/python/freemarker/Choice.py.ftl

@@ -549,30 +549,19 @@ ${I}pass
 ${I}pass
     </#if>
 </#macro>
-    def write(self, zserio_writer: zserio.BitStreamWriter, *,
-              zserio_call_initialize_offsets: bool = True) -> None:
+    def write(self, zserio_writer: zserio.BitStreamWriter) -> None:
     <#if withCodeComments>
         """
         Serializes this Zserio object to the bit stream.
 
         :param zserio_writer: Bit stream writer where to serialize this Zserio object.
-        :param zserio_call_initialize_offsets: True to call automatically initialize_offsets method before
-               writing, otherwise False.
         """
 
     </#if>
     <#if fieldList?has_content>
-        <#if hasFieldWithOffset>
-        if zserio_call_initialize_offsets:
-            self.initialize_offsets(zserio_writer.bitposition)
-        <#else>
-        del zserio_call_initialize_offsets
-        </#if>
-
         <@choice_if "choice_write_member", "choice_no_match"/>
     <#else>
         del zserio_writer
-        del zserio_call_initialize_offsets
     </#if>
 
     def write_packed(self, zserio_context_node: zserio.array.PackingContextNode,

compiler/extensions/python/freemarker/CompoundField.inc.ftl

@@ -279,7 +279,7 @@ ${I}zserio_writer.write_${field.runtimeFunction.suffix}(self.<@field_member_name
         <#elseif field.array??>
 ${I}self.<@field_member_name field/>.write<@array_field_packed_suffix field, packed/>(zserio_writer)
         <#else>
-${I}self.<@field_member_name field/>.write(zserio_writer<#if field.compound??>, zserio_call_initialize_offsets=False</#if>)
+${I}self.<@field_member_name field/>.write(zserio_writer)
         </#if>
     </#if>
 </#macro>

compiler/extensions/python/freemarker/Enumeration.py.ftl

@@ -178,18 +178,15 @@ class ${name}(enum.Enum):
     </#if>
         return bitposition + self.bitsizeof_packed(context_node, bitposition)
 
-    def write(self, writer: zserio.BitStreamWriter, *, zserio_call_initialize_offsets: bool = True) -> None:
+    def write(self, writer: zserio.BitStreamWriter) -> None:
     <#if withCodeComments>
         """
         Serializes this enumeration object to the bit stream.
 
         :param writer: Bit stream writer where to serialize this enumeration object.
-        :param zserio_call_initialize_offsets: True to call automatically initialize_offsets method before
-               writing, otherwise False.
         """
 
     </#if>
-        del zserio_call_initialize_offsets
         writer.write_${runtimeFunction.suffix}(self.value<#rt>
                                                <#lt><#if runtimeFunction.arg??>, ${runtimeFunction.arg}</#if>)
 

compiler/extensions/python/freemarker/Pubsub.py.ftl

@@ -113,6 +113,7 @@ class ${name}:
 
     def _publish(self, topic: str, message: typing.Any, context: typing.Any) -> None:
         writer = zserio.BitStreamWriter()
+        message.initialize_offsets(writer.bitposition)
         message.write(writer)
         self._pubsub.publish(topic, writer.byte_array, context)
 </#if>

compiler/extensions/python/freemarker/SqlTable.py.ftl

@@ -365,6 +365,7 @@ class ${name}:
         ${field.snakeCaseName}_ = row_in_list[${field?index}]
         if isinstance(${field.snakeCaseName}_, ${field.typeInfo.typeFullName}):
             writer = zserio.BitStreamWriter()
+            ${field.snakeCaseName}_.initialize_offsets(writer.bitposition)
             ${field.snakeCaseName}_.write(writer)
             row_in_list[${field?index}] = writer.byte_array
 

compiler/extensions/python/freemarker/Structure.py.ftl

@@ -515,26 +515,16 @@ ${I}<#rt>
             <#break>
         </#if>
     </#list>
-    def write(self, zserio_writer: zserio.BitStreamWriter, *,
-              zserio_call_initialize_offsets: bool = True) -> None:
+    def write(self, zserio_writer: zserio.BitStreamWriter) -> None:
     <#if withCodeComments>
         """
         Serializes this Zserio object to the bit stream.
 
         :param zserio_writer: Bit stream writer where to serialize this Zserio object.
-        :param zserio_call_initialize_offsets: True to call automatically initialize_offsets method before
-               writing, otherwise False.
         """
 
     </#if>
     <#if fieldList?has_content>
-        <#if hasFieldWithOffset>
-        if zserio_call_initialize_offsets:
-            self.initialize_offsets(zserio_writer.bitposition)
-        <#else>
-        del zserio_call_initialize_offsets
-        </#if>
-
         <#list fieldList as field>
         <@compound_write_field field, name, 2/>
             <#if field?has_next && needsWriteNewLines>
@@ -543,7 +533,6 @@ ${I}<#rt>
         </#list>
     <#else>
         del zserio_writer
-        del zserio_call_initialize_offsets
     </#if>
 
     def write_packed(self, zserio_context_node: zserio.array.PackingContextNode,

compiler/extensions/python/freemarker/Union.py.ftl

@@ -493,32 +493,21 @@ ${I}pass
 <#macro union_write_field field indent packed index>
     <@compound_write_field field, name, indent, packed, index/>
 </#macro>
-    def write(self, zserio_writer: zserio.BitStreamWriter, *,
-              zserio_call_initialize_offsets: bool = True) -> None:
+    def write(self, zserio_writer: zserio.BitStreamWriter) -> None:
     <#if withCodeComments>
         """
         Serializes this Zserio object to the bit stream.
 
         :param zserio_writer: Bit stream writer where to serialize this Zserio object.
-        :param zserio_call_initialize_offsets: True to call automatically initialize_offsets method before
-               writing, otherwise False.
         """
 
     </#if>
     <#if fieldList?has_content>
-        <#if hasFieldWithOffset>
-        if zserio_call_initialize_offsets:
-            self.initialize_offsets(zserio_writer.bitposition)
-        <#else>
-        del zserio_call_initialize_offsets
-        </#if>
-
         zserio_writer.write_varsize(self._choice_tag)
 
         <@union_if "union_write_field", "union_no_match"/>
     <#else>
         del zserio_writer
-        del zserio_call_initialize_offsets
     </#if>
 
     def write_packed(self, zserio_context_node: zserio.array.PackingContextNode,

compiler/extensions/python/runtime/src/zserio/array.py

@@ -1924,4 +1924,4 @@ def write(writer: BitStreamWriter, value: typing.Any) -> None:
         :param value: Zserio object type to write.
         """
 
-        value.write(writer, zserio_call_initialize_offsets=False)
+        value.write(writer)

compiler/extensions/python/runtime/src/zserio/serialization.py

@@ -12,6 +12,8 @@ def serialize(obj: typing.Any) -> BitBuffer:
     """
     Serializes generated object to the bit buffer.
 
+    Before serialization, the method calls on the given zserio object method initialize_offsets().
+
     Because serialization to the bit buffer does not have to be byte aligned (divisible by 8), it's possible
     that not all bits of the last byte are used. In this case, only most significant bits of the corresponded
     size are used.
@@ -31,6 +33,7 @@ def serialize(obj: typing.Any) -> BitBuffer:
     """
 
     writer = BitStreamWriter()
+    obj.initialize_offsets(writer.bitposition)
     obj.write(writer)
 
     return BitBuffer(writer.byte_array, writer.bitposition)
@@ -63,6 +66,8 @@ def serialize_to_bytes(obj: typing.Any) -> bytes:
     """
     Serializes generated object to the byte buffer.
 
+    Before serialization, the method calls on the given zserio object method initialize_offsets().
+
     This is a convenient method for users which do not need exact number of bits to which the given object
     will be serialized.
 
@@ -117,7 +122,9 @@ def deserialize_bytes(obj_class: typing.Type[typing.Any], buffer: bytes, *args)
 
 def serialize_to_file(obj: typing.Any, filename: str) -> None:
     """
-    Serializes generated object to the byte buffer.
+    Serializes generated object to the file.
+
+    Before serialization, the method calls on the given zserio object method initialize_offsets().
 
     This is a convenient method for users to easily write given generated object to file.
 
@@ -136,6 +143,7 @@ def serialize_to_file(obj: typing.Any, filename: str) -> None:
     """
 
     writer = BitStreamWriter()
+    obj.initialize_offsets(writer.bitposition)
     obj.write(writer)
     writer.to_file(filename)
 

compiler/extensions/python/runtime/src/zserio/service.py

@@ -33,6 +33,7 @@ def byte_array(self) -> bytes:
 
         if not self._is_byte_array_initialized:
             writer = BitStreamWriter()
+            self._zserio_object.initialize_offsets(writer.bitposition)
             self._zserio_object.write(writer)
             self._byte_array = writer.byte_array
             self._is_byte_array_initialized = True

compiler/extensions/python/runtime/tests/test_serialization.py

@@ -9,6 +9,7 @@ class DummyObject:
     def __init__(self, parameter, value = 0):
         self._parameter = parameter
         self._value = value
+        self._offsets_initialized = False
 
     @classmethod
     def from_reader(cls, reader, parameter):
@@ -24,11 +25,17 @@ def get_value(self):
     def bitsizeof(_bitposition = 0):
         return 31 # to make an unaligned type
 
+    def initialize_offsets(self, bitposition: int) -> int:
+        self._offsets_initialized = True
+        return bitposition + DummyObject.bitsizeof(bitposition)
+
     def read(self, reader):
         self._value = reader.read_bits(self.bitsizeof(0))
 
     def write(self, writer):
-        writer.write_bits(self._value, self.bitsizeof(0))
+        # don't write anything if offsets are not initialized to force test failure
+        if self._offsets_initialized:
+            writer.write_bits(self._value, self.bitsizeof(0))
 
 class SerializationTest(unittest.TestCase):
 

compiler/extensions/python/runtime/tests/test_service.py

@@ -7,6 +7,7 @@ def test_service_data(self):
         class ZserioObject:
             def __init__(self, value):
                 self._value = value
+                self._offsets_initialized = False
 
             def __eq__(self, other):
                 return self._value == other._value
@@ -15,8 +16,14 @@ def __eq__(self, other):
             def bitsizeof(_bitposition):
                 return 31 # to make an unaligned type
 
+            def initialize_offsets(self, bitposition: int) -> int:
+                self._offsets_initialized = True
+                return bitposition + ZserioObject.bitsizeof(bitposition)
+
             def write(self, writer):
-                writer.write_bits(self._value, self.bitsizeof(0))
+                # don't write anything if offsets are not initialized to force test failure
+                if self._offsets_initialized:
+                    writer.write_bits(self._value, self.bitsizeof(0))
 
         zserio_object = ZserioObject(0xABCD)
         service_data = ServiceData(zserio_object)

compiler/extensions/python/src/zserio/extension/python/CompoundTypeTemplateData.java

@@ -24,8 +24,6 @@ public CompoundTypeTemplateData(TemplateDataContext context, CompoundType compou
         compoundParametersData = new CompoundParameterTemplateData(context, compoundType, this);
         compoundFunctionsData = new CompoundFunctionTemplateData(context, compoundType, this);
 
-        hasFieldWithOffset = compoundType.hasFieldWithOffset();
-
         final List<Field> fieldTypeList = compoundType.getFields();
         fieldList = new ArrayList<CompoundFieldTemplateData>(fieldTypeList.size());
         for (Field fieldType : fieldTypeList)
@@ -51,11 +49,6 @@ public CompoundFunctionTemplateData getCompoundFunctionsData()
         return compoundFunctionsData;
     }
 
-    public boolean getHasFieldWithOffset()
-    {
-        return hasFieldWithOffset;
-    }
-
     public Iterable<CompoundFieldTemplateData> getFieldList()
     {
         return fieldList;
@@ -69,7 +62,6 @@ public TemplateInstantiationTemplateData getTemplateInstantiation()
     private final boolean withRangeCheckCode;
     private final CompoundParameterTemplateData compoundParametersData;
     private final CompoundFunctionTemplateData compoundFunctionsData;
-    private final boolean hasFieldWithOffset;
     private final List<CompoundFieldTemplateData> fieldList;
     private final TemplateInstantiationTemplateData templateInstantiation;
 }

test/language/indexed_offsets/python/AutoIndexedOffsetArrayTest.py

@@ -60,6 +60,7 @@ def testWrite(self):
         createWrongOffsets = True
         autoIndexedOffsetArray = self._createAutoIndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
+        autoIndexedOffsetArray.initialize_offsets(writer.bitposition)
         autoIndexedOffsetArray.write(writer)
         self._checkAutoIndexedOffsetArray(autoIndexedOffsetArray)
         reader = zserio.BitStreamReader(writer.byte_array, writer.bitposition)
@@ -73,6 +74,7 @@ def testWriteWithPosition(self):
         writer = zserio.BitStreamWriter()
         bitPosition = 8
         writer.write_bits(0, bitPosition)
+        autoIndexedOffsetArray.initialize_offsets(writer.bitposition)
         autoIndexedOffsetArray.write(writer)
 
         offsetShift = 1
@@ -83,7 +85,7 @@ def testWriteWrongOffsets(self):
         autoIndexedOffsetArray = self._createAutoIndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
         with self.assertRaises(zserio.PythonRuntimeException):
-            autoIndexedOffsetArray.write(writer, zserio_call_initialize_offsets=False)
+            autoIndexedOffsetArray.write(writer)
 
     @staticmethod
     def _writeAutoIndexedOffsetArrayToStream(writer, writeWrongOffsets):

test/language/indexed_offsets/python/Bit5IndexedOffsetArrayTest.py

@@ -60,6 +60,7 @@ def testWrite(self):
         createWrongOffsets = True
         bit5IndexedOffsetArray = self._createBit5IndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
+        bit5IndexedOffsetArray.initialize_offsets(writer.bitposition)
         bit5IndexedOffsetArray.write(writer)
         self._checkBit5IndexedOffsetArray(bit5IndexedOffsetArray)
         reader = zserio.BitStreamReader(writer.byte_array, writer.bitposition)
@@ -73,6 +74,7 @@ def testWriteWithPosition(self):
         writer = zserio.BitStreamWriter()
         bitPosition = 8
         writer.write_bits(0, bitPosition)
+        bit5IndexedOffsetArray.initialize_offsets(writer.bitposition)
         bit5IndexedOffsetArray.write(writer)
 
         offsetShift = 1
@@ -83,7 +85,7 @@ def testWriteWrongOffsets(self):
         bit5IndexedOffsetArray = self._createBit5IndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
         with self.assertRaises(zserio.PythonRuntimeException):
-            bit5IndexedOffsetArray.write(writer, zserio_call_initialize_offsets=False)
+            bit5IndexedOffsetArray.write(writer)
 
     @staticmethod
     def _writeBit5IndexedOffsetArrayToStream(writer, writeWrongOffsets):

test/language/indexed_offsets/python/BoolIndexedOffsetArrayTest.py

@@ -60,6 +60,7 @@ def testWrite(self):
         createWrongOffsets = True
         boolIndexedOffsetArray = self._createBoolIndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
+        boolIndexedOffsetArray.initialize_offsets(writer.bitposition)
         boolIndexedOffsetArray.write(writer)
         self._checkBoolIndexedOffsetArray(boolIndexedOffsetArray)
         reader = zserio.BitStreamReader(writer.byte_array, writer.bitposition)
@@ -73,6 +74,7 @@ def testWriteWithPosition(self):
         writer = zserio.BitStreamWriter()
         bitPosition = 8
         writer.write_bits(0, bitPosition)
+        boolIndexedOffsetArray.initialize_offsets(writer.bitposition)
         boolIndexedOffsetArray.write(writer)
 
         offsetShift = 1
@@ -83,7 +85,7 @@ def testWriteWrongOffsets(self):
         boolIndexedOffsetArray = self._createBoolIndexedOffsetArray(createWrongOffsets)
         writer = zserio.BitStreamWriter()
         with self.assertRaises(zserio.PythonRuntimeException):
-            boolIndexedOffsetArray.write(writer, zserio_call_initialize_offsets=False)
+            boolIndexedOffsetArray.write(writer)
 
     @staticmethod
     def _writeBoolIndexedOffsetArrayToStream(writer, writeWrongOffsets):