File: addnewformat_unit_test.py

package info (click to toggle)
python-sigima 1.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 24,956 kB
  • sloc: python: 33,326; makefile: 3
file content (125 lines) | stat: -rw-r--r-- 3,846 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.

"""
Test adding new I/O formats
"""

from __future__ import annotations

from typing import Type

import numpy as np

from sigima.io import ImageIORegistry, SignalIORegistry
from sigima.io.base import FormatInfo
from sigima.io.image.base import SingleImageFormatBase
from sigima.io.signal.base import SignalFormatBase
from sigima.tests.env import execenv


def _get_image_format_number() -> int:
    """Get the number of standard image formats"""
    return len(ImageIORegistry.get_formats())


def _add_image_format() -> Type[SingleImageFormatBase]:
    """Add a new image format to the registry"""

    class MyImageFormat(SingleImageFormatBase):
        """Object representing MyImageFormat image file type"""

        FORMAT_INFO = FormatInfo(
            name="MyImageFormat",
            extensions="*.myimg",
            readable=True,
            writeable=False,
        )

        @staticmethod
        def read_data(filename: str) -> np.ndarray:
            """Read data and return it

            Args:
                filename (str): path to MyImageFormat file

            Returns:
                np.ndarray: image data
            """
            # Implement reading logic here

    return MyImageFormat


def test_add_image_format() -> None:
    """Test adding a new image format"""
    n1 = _get_image_format_number()
    execenv.print(f"Number of standard image formats: {n1}")
    execenv.print("Adding MyImageFormat... ", end="")
    image_class = _add_image_format()
    n2 = _get_image_format_number()
    assert n2 == n1 + 1, "Image format was not added correctly"
    execenv.print("OK")
    execenv.print(f"New number of image formats:      {n2}")
    assert (
        sum(isinstance(fmt, image_class) for fmt in ImageIORegistry.get_formats()) == 1
    )
    finfo = image_class.FORMAT_INFO
    finfo_str = "\n".join([(" " * 4) + line for line in str(finfo).splitlines()])
    assert finfo_str in ImageIORegistry.get_format_info(mode="text")


def _get_signal_format_number() -> int:
    """Get the number of standard signal formats"""
    return len(SignalIORegistry.get_formats())


def _add_signal_format() -> Type[SignalFormatBase]:
    """Add a new signal format to the registry"""

    class MySignalFormat(SignalFormatBase):
        """Object representing MySignalFormat signal file type"""

        FORMAT_INFO = FormatInfo(
            name="MySignalFormat",
            extensions="*.mysig",
            readable=True,
            writeable=False,
        )

        def read_xydata(self, filename: str) -> np.ndarray:
            """Read data and metadata from file, write metadata to object, return xydata

            Args:
                filename: Name of file to read

            Returns:
                NumPy array xydata
            """
            # Implement reading logic here
            print(f"Reading data from {filename}")

    return MySignalFormat


def test_add_signal_format() -> None:
    """Test adding a new signal format"""
    n1 = _get_signal_format_number()
    execenv.print(f"Number of standard signal formats: {n1}")
    execenv.print("Adding MySignalFormat... ", end="")
    signal_class = _add_signal_format()
    n2 = _get_signal_format_number()
    assert n2 == n1 + 1, "Signal format was not added correctly"
    execenv.print("OK")
    execenv.print(f"New number of signal formats:      {n2}")
    assert (
        sum(isinstance(fmt, signal_class) for fmt in SignalIORegistry.get_formats())
        == 1
    )
    finfo = signal_class.FORMAT_INFO
    finfo_str = "\n".join([(" " * 4) + line for line in str(finfo).splitlines()])
    assert finfo_str in SignalIORegistry.get_format_info(mode="text")


if __name__ == "__main__":
    test_add_image_format()
    test_add_signal_format()