Test returned datatypes

bindings/python/test_rig.py

@@ -59,100 +59,155 @@ class TestClass:
         rig = Hamlib.Rig(RIG_MODEL)
         assert rig is not None
 
-        rig.caps
+        assert rig.close() is None
-        rig.close()
+        assert rig.ext_token_lookup("") is None
-        rig.ext_token_lookup("")
         option = Hamlib.value_t()
-        ant = 0  # FIXME use constants RIG_ANT_* when available
+        ant = 0  # FIXME should use a RIG_ANT_* constant but it isn't available in the bindings
-        rig.get_ant(option, ant, 0)
+        assert isinstance(rig.get_ant(option, ant), list)
-        option.i == 0
+        assert isinstance(rig.get_ant(option, ant, Hamlib.RIG_VFO_CURR), list)
-        rig.get_chan_all()
+        assert option.i == 0
-        rig.get_channel(0, 0, 0)
+        assert rig.get_chan_all() is None
-        rig.get_channel(0, 0)
+        channel = 0
-        rig.get_conf("")
+        readonly = 0
-        rig.get_ctcss_sql()
+        assert isinstance(rig.get_channel(channel), Hamlib.channel)
-        rig.get_ctcss_tone()
+        assert isinstance(rig.get_channel(channel, Hamlib.RIG_VFO_CURR), Hamlib.channel)
-        rig.get_dcd()
+        assert isinstance(rig.get_channel(channel, Hamlib.RIG_VFO_CURR, readonly), Hamlib.channel)
-        rig.get_dcs_code()
+        assert isinstance(rig.get_conf(""), str)
-        rig.get_dcs_sql()
+        assert isinstance(rig.get_ctcss_sql(), int)
-        rig.get_ext_func(0)
+        assert isinstance(rig.get_ctcss_sql(0), int)
-        rig.get_ext_level(0)
+        assert isinstance(rig.get_ctcss_tone(), int)
-        rig.get_ext_parm(0)
+        assert isinstance(rig.get_ctcss_tone(0), int)
-        rig.get_freq()
+        assert isinstance(rig.get_dcd(), int)
-        rig.get_func(0)
+        assert isinstance(rig.get_dcd(Hamlib.RIG_VFO_CURR,), int)
-        rig.get_info()
+        assert isinstance(rig.get_dcs_code(), int)
-        rig.get_level(0)
+        assert isinstance(rig.get_dcs_code(0), int)
-        rig.get_level_f(0)
+        assert isinstance(rig.get_dcs_sql(), int)
-        rig.get_level_i(0)
+        assert isinstance(rig.get_dcs_sql(0), int)
-        rig.get_mem()
+        assert isinstance(rig.get_ext_func(0), int)
-        rig.get_mode()
+        assert isinstance(rig.get_ext_func(0, 0), int)
-        rig.get_parm(0)
+        assert rig.get_ext_level(0) is None
-        rig.get_parm_f(0)
+        assert rig.get_ext_level(0, 0) is None
-        rig.get_parm_i(0)
+        assert rig.get_ext_parm(0) is None
-        rig.get_powerstat()
+        assert isinstance(rig.get_freq(), float)
-        rig.get_ptt()
+        assert isinstance(rig.get_freq(Hamlib.RIG_VFO_CURR), float)
-        rig.get_rit()
+        assert isinstance(rig.get_func(0), int)
-        rig.get_rptr_offs()
+        assert isinstance(rig.get_func(0, 0), int)
-        rig.get_rptr_shift()
+        assert rig.get_info() is None
-        rig.get_split_freq()
+        assert rig.get_level(0) is None
-        rig.get_split_mode()
+        assert isinstance(rig.get_level_f(0), float)
-        # FIXME rig.get_split_vfo()
+        assert isinstance(rig.get_level_i(0), int)
-        rig.get_trn()
+        assert isinstance(rig.get_mem(), int)
-        rig.get_ts()
+        assert isinstance(rig.get_mem(Hamlib.RIG_VFO_CURR), int)
-        rig.get_vfo()
+        assert isinstance(rig.get_mode(), list)
-        # FIXME rig.get_vfo_info()
+        assert isinstance(rig.get_mode(Hamlib.RIG_VFO_CURR), list)
-        rig.get_xit()
+        assert rig.get_parm(0) is None
-        rig.has_get_level(0)
+        assert isinstance(rig.get_parm_f(0), float)
-        rig.has_scan(0)
+        assert isinstance(rig.get_parm_i(0), int)
-        rig.has_set_func(0)
+        assert isinstance(rig.get_powerstat(), int)
-        rig.has_set_parm(0)
+        assert isinstance(rig.get_ptt(), int)
-        rig.has_vfo_op(0)
+        assert isinstance(rig.get_ptt(Hamlib.RIG_VFO_CURR), int)
-        rig.lookup_mem_caps(0)
+        assert isinstance(rig.get_rit(), int)
-        rig.mem_count()
+        assert isinstance(rig.get_rit(Hamlib.RIG_VFO_CURR), int)
-        rig.open()
+        assert isinstance(rig.get_rptr_offs(), int)
-        rig.passband_narrow(0)
+        assert isinstance(rig.get_rptr_offs(Hamlib.RIG_VFO_CURR), int)
-        rig.passband_normal(0)
+        assert isinstance(rig.get_rptr_shift(), int)
-        rig.passband_wide(0)
+        assert isinstance(rig.get_rptr_shift(Hamlib.RIG_VFO_CURR), int)
-        rig.recv_dtmf()
+        assert isinstance(rig.get_split_freq(), float)
-        rig.reset(Hamlib.RIG_RESET_NONE)
+        assert isinstance(rig.get_split_freq(Hamlib.RIG_VFO_CURR), float)
-        rig.rig
+        assert isinstance(rig.get_split_mode(), list)
-        rig.scan(0, 0, 0)
+        assert isinstance(rig.get_split_mode(Hamlib.RIG_VFO_CURR), list)
-        rig.send_dtmf(0, "")
+        # assert rig.get_split_vfo() is None  # FIXME
-        rig.send_morse(0, "")
+        # assert rig.get_split_vfo(Hamlib.RIG_VFO_CURR) is None  # FIXME
+        assert isinstance(rig.get_trn(), int)  # deprecated
+        assert isinstance(rig.get_ts(), int)
+        assert isinstance(rig.get_ts(Hamlib.RIG_VFO_CURR), int)
+        assert isinstance(rig.get_vfo(), int)
+        # assert rig.get_vfo_info(Hamlib.RIG_VFO_CURR) is None  # FIXME
+        # assert rig.get_vfo_info(Hamlib.RIG_VFO_CURR, 2) is None  # FIXME
+        # assert rig.get_vfo_info(Hamlib.RIG_VFO_CURR, 2, 3) is None  # FIXME
+        assert isinstance(rig.get_xit(), int)
+        assert isinstance(rig.get_xit(Hamlib.RIG_VFO_CURR), int)
+        # assert rig_has_get_func(0)  FIXME not defined
+        assert rig.has_get_level(0) is None  # FIXME should return setting_t
+        # assert rig_has_get_parm(0)  FIXME not defined
+        assert rig.has_scan(0) is None  # FIXME should return scan_t
+        assert rig.has_set_func(0) is None  # FIXME should return setting_t
+        # assert rig_has_set_level(0)  FIXME not defined
+        assert rig.has_set_parm(0) is None  # FIXME should return setting_t
+        assert rig.has_vfo_op(0) is None  # FIXME should return vfo_op_t
+        assert rig.lookup_mem_caps() is None
+        assert rig.lookup_mem_caps(0) is None
+        assert isinstance(rig.mem_count(), int)
+        assert rig.open() is None
+        assert rig.passband_narrow(0) is None
+        assert rig.passband_normal(0) is None
+        assert rig.passband_wide(0) is None
+        assert isinstance(rig.recv_dtmf(), str)
+        assert isinstance(rig.recv_dtmf(0), str)
+        assert rig.reset(Hamlib.RIG_RESET_NONE) is None
+        assert rig.scan(0, 0) is None
+        assert rig.scan(0, 0, 0) is None
+        assert rig.send_dtmf(0, "") is None
+        assert rig.send_morse(0, "") is None
         option = Hamlib.value_t()
-        option.i = 0  # FIXME use constants RIG_ANT_* when available
+        option.i = 0  # FIXME should use a RIG_ANT_* constant but it isn't available in the bindings
-        rig.set_ant(Hamlib.RIG_VFO_CURR, option)
+        assert rig.set_ant(Hamlib.RIG_VFO_CURR, option) is None
-        rig.set_bank(0, 0)
+        assert rig.set_ant(Hamlib.RIG_VFO_CURR, option, 0) is None
+        assert rig.set_bank(0, 0) is None
         channel = Hamlib.channel()
-        rig.set_channel(channel)
+        channel = Hamlib.channel(0)
-        rig.set_conf("", "")
+        channel = Hamlib.channel(0, 0)
-        rig.set_ctcss_sql(0, 0)
+        assert rig.set_channel(channel) is None
-        rig.set_ctcss_tone(0, 0)
+        assert rig.set_conf("", "") is None
-        rig.set_dcs_code(0, 0)
+        assert rig.set_ctcss_sql(0, 0) is None
-        rig.set_dcs_sql(0, 0)
+        assert rig.set_ctcss_tone(0, 0) is None
-        rig.set_ext_func(0, 0)
+        assert rig.set_dcs_code(0, 0) is None
-        # FIXME rig.set_ext_level()
+        assert rig.set_dcs_sql(0) is None
-        # FIXME rig.set_ext_parm()
+        assert rig.set_dcs_sql(0, 0) is None
-        rig.set_freq(0, 0)
+        assert rig.set_ext_func(0, 0) is None
-        rig.set_func(0, 0, 0)
+        assert rig.set_ext_func(0, 0, 0) is None
-        rig.set_level(0, 0, 0)
+        level = 0
-        rig.set_mem(0, 0)
+        value = Hamlib.value_t()
-        rig.set_mode(0, 0, 0)
+        assert rig.set_ext_level(level, value) is None
-        rig.set_parm(0, 0)
+        assert rig.set_ext_level(level, value, Hamlib.RIG_VFO_CURR) is None
-        rig.set_powerstat(0)
+        value = Hamlib.value_t()
-        rig.set_ptt(0, 0)
+        assert rig.set_ext_parm(0, value) is None
-        rig.set_rit(0, 0)
+        assert rig.set_freq(0, 0) is None
-        rig.set_rptr_offs(0, 0)
+        assert rig.set_func(0, 0, 0) is None
-        rig.set_rptr_shift(0, 0)
+        assert rig.set_level(0, 0, 0) is None
-        rig.set_split_freq(0, 0)
+        assert rig.set_mem(0, 0) is None
-        rig.set_split_freq_mode(0, 0)
+        assert rig.set_mode(0) is None
-        rig.set_split_mode(0, 0)
+        assert rig.set_mode(0, 0) is None
-        rig.set_split_vfo(0, 0)
+        assert rig.set_mode(0, 0, 0) is None
-        rig.set_trn(0)
+        assert rig.set_parm(0, 0) is None
-        rig.set_ts(0, 0)
+        assert rig.set_powerstat(0) is None
-        rig.set_vfo(0)
+        assert rig.set_ptt(0, 0) is None
-        rig.set_vfo_opt(0)
+        assert rig.set_rit(0, 0) is None
-        rig.set_xit(0, 0)
+        assert rig.set_rptr_offs(0, 0) is None
-        rig.state
+        assert rig.set_rptr_shift(0, 0) is None
-        rig.token_lookup("")
+        assert rig.set_split_freq(0, 0) is None
-        rig.vfo_op(0, 0)
+        assert rig.set_split_freq_mode(0, 0) is None
+        assert rig.set_split_freq_mode(0, 0, 0) is None
+        assert rig.set_split_freq_mode(0, 0, 0, 0) is None
+        assert rig.set_split_mode(0) is None
+        assert rig.set_split_mode(0, 0) is None
+        assert rig.set_split_mode(0, 0, 0) is None
+        assert rig.set_split_vfo(0, 0) is None
+        assert rig.set_split_vfo(0, 0, 0) is None
+        assert rig.set_trn(0) is None  # deprecated
+        assert rig.set_ts(0, 0) is None
+        assert rig.set_vfo(0) is None
+        assert rig.set_vfo_opt(0) is None
+        assert rig.set_xit(0, 0) is None
+        assert rig.token_lookup("") is None
+        assert rig.vfo_op(0, 0) is None
+
+
+    def test_object_creation(self):
+        """Create all objects available"""
+        rig = Hamlib.Rig(RIG_MODEL)
+        assert rig is not None
+
+        assert isinstance(rig.caps, Hamlib.rig_caps)
+        assert isinstance(rig.rig, Hamlib.s_rig)
+        assert isinstance(rig.state, Hamlib.rig_state)