formatted_tuple.py

#
# SPDX-FileCopyrightText: Copyright (c) 2018-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: MIT
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#


def formatted_tuple_from_data(fmtTuple, data, offset=0):
    size = fmtTuple._size()
    return fmtTuple._make(data[offset : offset + size])


class FormattedTuple(object):
    namedtuple = None
    struct = None

    @classmethod
    def post_make(cls, instance):
        return instance

    @classmethod
    def _make(cls, data: object):
        from .ints_to_bytes import _byte_view  # local import to avoid cycle

        buffer = _byte_view(data)
        instance = cls.namedtuple._make(cls.struct.unpack_from(buffer))
        return cls.post_make(instance)

    @classmethod
    def _size(cls):
        return cls.struct.size