Module redvox.tests.api1000.common.test_typing

Expand source code
from unittest import TestCase
from typing import Any, Dict, List, Set

from redvox.api1000.wrapped_redvox_packet.wrapped_packet import WrappedRedvoxPacketM

from redvox.api1000.errors import ApiMError, ApiMTypeError, ApiMOtherError

from redvox.api1000.common.typing import check_type
from redvox.api1000.proto.redvox_api_m_pb2 import RedvoxPacketM


class TypingTests(TestCase):
    def test_primitives_ok(self):
        good_types: List[Any] = [
            [1, [int]],
            [1.0, [float]],
            [True, [bool]],
            ["foo", [str]],
            [[1], [list]],
            [{1}, [set]],
            [{1: 2}, [dict]],
        ]
        good_type: List[Any]
        for good_type in good_types:
            check_type(*good_type)

    def test_primitive_bad(self):
        bad_types: List[Any] = [
            [1, [float, bool, str, list, set, dict]],
            [1.0, [int, bool, str, list, set, dict]],
            [True, [int, float, str, list, set, dict]],
            ["foo", [int, float, bool, list, set, dict]],
            [[1], [int, float, bool, str, set, dict]],
            [{1}, [int, float, bool, str, list, dict]],
            [{1: 2}, [int, float, bool, str, list, set]]
        ]

        bad_type: List[Any]
        for bad_type in bad_types:
            with self.assertRaises(ApiMTypeError) as ctx:
                check_type(*bad_type)
            self.assertTrue("Expected type(s)" in str(ctx.exception))

    def test_custom_exception(self):
        with self.assertRaises(ApiMOtherError) as ctx:
            check_type(1.0, [int], exception=ApiMOtherError)
        self.assertTrue("Expected type(s)" in str(ctx.exception))
        self.assertTrue("ApiMOtherError" in str(ctx.exception))

    def test_additional_info(self):
        with self.assertRaises(ApiMTypeError) as ctx:
            check_type(1.0, [int], additional_info="foo")
        self.assertTrue("Expected type(s)" in str(ctx.exception))
        self.assertTrue("foo" in str(ctx.exception))

    # def test_sdk_types(self):
    #     packet_proto: RedvoxPacketM = RedvoxPacketM()
    #     packet: WrappedRedvoxPacketM = WrappedRedvoxPacketM(packet_proto)
    #     good_types: List[Any] = [
    #         [packet, WrappedRedvoxPacketM]
    #     ]
    #
    #     good_type: List[Any]
    #     for good_type in good_types:
    #         check_type(*good_type)

Classes

class RedvoxPacketM (*args, **kwargs)

A ProtocolMessage

Ancestors

  • google.protobuf.pyext._message.CMessage
  • google.protobuf.message.Message

Class variables

var BYTE
var CENTIMETERS
var DECIBEL
var DECIMAL_DEGREES
var DEGREES_CELSIUS
var DESCRIPTOR
var DoubleSamplePayload

A ProtocolMessage

var EventStream

A ProtocolMessage

var KILOPASCAL
var LSB_PLUS_MINUS_COUNTS
var LUX
var METERS
var METERS_PER_SECOND
var METERS_PER_SECOND_SQUARED
var MICROAMPERES
var MICROSECONDS_SINCE_UNIX_EPOCH
var MICROTESLA
var MetadataEntry

A ProtocolMessage

var NORMALIZED_COUNTS
var PCM
var PERCENTAGE
var RADIANS
var RADIANS_PER_SECOND
var SamplePayload

A ProtocolMessage

var Sensors

A ProtocolMessage

var StationInformation

A ProtocolMessage

var SummaryStatistics

A ProtocolMessage

var TimingInformation

A ProtocolMessage

var TimingPayload

A ProtocolMessage

var UNITLESS
var UNKNOWN
var Unit

Instance variables

var api

Field redvox_api_m.RedvoxPacketM.api

var event_streams

Field redvox_api_m.RedvoxPacketM.event_streams

var metadata

Field redvox_api_m.RedvoxPacketM.metadata

var sensors

Field redvox_api_m.RedvoxPacketM.sensors

var station_information

Field redvox_api_m.RedvoxPacketM.station_information

var sub_api

Field redvox_api_m.RedvoxPacketM.sub_api

var timing_information

Field redvox_api_m.RedvoxPacketM.timing_information

class TypingTests (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code
class TypingTests(TestCase):
    def test_primitives_ok(self):
        good_types: List[Any] = [
            [1, [int]],
            [1.0, [float]],
            [True, [bool]],
            ["foo", [str]],
            [[1], [list]],
            [{1}, [set]],
            [{1: 2}, [dict]],
        ]
        good_type: List[Any]
        for good_type in good_types:
            check_type(*good_type)

    def test_primitive_bad(self):
        bad_types: List[Any] = [
            [1, [float, bool, str, list, set, dict]],
            [1.0, [int, bool, str, list, set, dict]],
            [True, [int, float, str, list, set, dict]],
            ["foo", [int, float, bool, list, set, dict]],
            [[1], [int, float, bool, str, set, dict]],
            [{1}, [int, float, bool, str, list, dict]],
            [{1: 2}, [int, float, bool, str, list, set]]
        ]

        bad_type: List[Any]
        for bad_type in bad_types:
            with self.assertRaises(ApiMTypeError) as ctx:
                check_type(*bad_type)
            self.assertTrue("Expected type(s)" in str(ctx.exception))

    def test_custom_exception(self):
        with self.assertRaises(ApiMOtherError) as ctx:
            check_type(1.0, [int], exception=ApiMOtherError)
        self.assertTrue("Expected type(s)" in str(ctx.exception))
        self.assertTrue("ApiMOtherError" in str(ctx.exception))

    def test_additional_info(self):
        with self.assertRaises(ApiMTypeError) as ctx:
            check_type(1.0, [int], additional_info="foo")
        self.assertTrue("Expected type(s)" in str(ctx.exception))
        self.assertTrue("foo" in str(ctx.exception))

    # def test_sdk_types(self):
    #     packet_proto: RedvoxPacketM = RedvoxPacketM()
    #     packet: WrappedRedvoxPacketM = WrappedRedvoxPacketM(packet_proto)
    #     good_types: List[Any] = [
    #         [packet, WrappedRedvoxPacketM]
    #     ]
    #
    #     good_type: List[Any]
    #     for good_type in good_types:
    #         check_type(*good_type)

Ancestors

  • unittest.case.TestCase

Methods

def test_additional_info(self)
Expand source code
def test_additional_info(self):
    with self.assertRaises(ApiMTypeError) as ctx:
        check_type(1.0, [int], additional_info="foo")
    self.assertTrue("Expected type(s)" in str(ctx.exception))
    self.assertTrue("foo" in str(ctx.exception))
def test_custom_exception(self)
Expand source code
def test_custom_exception(self):
    with self.assertRaises(ApiMOtherError) as ctx:
        check_type(1.0, [int], exception=ApiMOtherError)
    self.assertTrue("Expected type(s)" in str(ctx.exception))
    self.assertTrue("ApiMOtherError" in str(ctx.exception))
def test_primitive_bad(self)
Expand source code
def test_primitive_bad(self):
    bad_types: List[Any] = [
        [1, [float, bool, str, list, set, dict]],
        [1.0, [int, bool, str, list, set, dict]],
        [True, [int, float, str, list, set, dict]],
        ["foo", [int, float, bool, list, set, dict]],
        [[1], [int, float, bool, str, set, dict]],
        [{1}, [int, float, bool, str, list, dict]],
        [{1: 2}, [int, float, bool, str, list, set]]
    ]

    bad_type: List[Any]
    for bad_type in bad_types:
        with self.assertRaises(ApiMTypeError) as ctx:
            check_type(*bad_type)
        self.assertTrue("Expected type(s)" in str(ctx.exception))
def test_primitives_ok(self)
Expand source code
def test_primitives_ok(self):
    good_types: List[Any] = [
        [1, [int]],
        [1.0, [float]],
        [True, [bool]],
        ["foo", [str]],
        [[1], [list]],
        [{1}, [set]],
        [{1: 2}, [dict]],
    ]
    good_type: List[Any]
    for good_type in good_types:
        check_type(*good_type)