python bindings: redesign Phase 2 — API surface polish

- Convert connected() and is_registration_supported() to read-only
  Python properties (connected, registration_supported)
- Delete set_symname(); host.hostsymname is already writable via the
  generated SWIG field descriptor
- Rename registration_ctrl() to registration_control() to reflect that
  the method is a multi-action control interface (register, deregister,
  update via NVMF_DIM_TAS_*), not a single register operation
- Update test-objects.py to match the new API

Signed-off-by: Martin Belanger <[email protected]>
Assisted-by: Claude Sonnet <[email protected]>

Author: Martin Belanger

libnvme/libnvme/nvme.i

@@ -887,12 +887,6 @@ struct libnvme_ns * libnvme_ctrl_next_ns(struct libnvme_ctrl * c, struct libnvme
 }
 
 
-%define SET_SYMNAME_DOCSTRING
-"Set or clear the host's symbolic name.
-
-Args:
-    hostsymname: Symbolic name string, or None to clear it."
-%enddef
 
 %pythonappend libnvme_host::libnvme_host(struct libnvme_global_ctx *ctx,
 				   const char *hostnqn,
@@ -938,11 +932,6 @@ Args:
 	struct libnvme_host* __exit__(PyObject *type, PyObject *value, PyObject *traceback) {
 		return $self;
 	}
-	%feature("autodoc", SET_SYMNAME_DOCSTRING) set_symname;
-	void set_symname(const char *hostsymname) {
-		libnvme_host_set_hostsymname($self, hostsymname);
-	}
-
 	PyObject* __str__() {
 		return PyUnicode_FromFormat("nvme.Host(%s,%s)", STR_OR_NONE($self->hostnqn), STR_OR_NONE($self->hostid));
 	}
@@ -1161,10 +1150,6 @@ Args:
 			return;
 		}
 	}
-	%feature("autodoc", "Return True if this controller is currently connected.") connected;
-	bool connected() {
-		return libnvme_ctrl_get_name($self) != NULL;
-	}
 	%feature("autodoc", "Rescan this controller and refresh its namespace list.") rescan;
 	void rescan() {
 		libnvme_rescan_ctrl($self);
@@ -1190,16 +1175,28 @@ Args:
 			connect_err = 2;
 	}
 
-	%feature("autodoc", "Return True if this controller supports explicit host registration.") is_registration_supported;
-	bool is_registration_supported() {
+	bool _registration_supported() {
 		return libnvmf_is_registration_supported($self);
 	}
+	bool _connected() {
+		return libnvme_ctrl_get_name($self) != NULL;
+	}
+	%pythoncode %{
+	@property
+	def connected(self):
+		"""True if this controller is currently connected."""
+		return self._connected()
+	@property
+	def registration_supported(self):
+		"""True if this controller supports explicit host registration."""
+		return self._registration_supported()
+	%}
 
 	%feature("autodoc", "Register this controller with the NVMe-oF DIM service.\n"
 		"\n"
 		"Returns:\n"
-		"    None on success, or an error string describing the failure.") registration_ctrl;
-	PyObject *registration_ctrl(enum nvmf_dim_tas tas) {
+		"    None on success, or an error string describing the failure.") registration_control;
+	PyObject *registration_control(enum nvmf_dim_tas tas) {
 		__u32 result;
 		int   status;
 

libnvme/libnvme/tests/test-objects.py

@@ -34,6 +34,11 @@ def test_context_manager(self):
         with nvme.GlobalCtx() as ctx:
             self.assertIsNotNone(ctx)
 
+    def test_context_manager_methods_accessible(self):
+        with nvme.GlobalCtx() as ctx:
+            hosts = list(ctx.hosts())
+            self.assertIsInstance(hosts, list)
+
     def test_hosts_iterator_returns_list(self):
         ctx = nvme.GlobalCtx()
         hosts = list(ctx.hosts())
@@ -82,10 +87,10 @@ def test_creation_with_hostsymname(self):
         host = nvme.Host(self.ctx, hostnqn=hostnqn, hostsymname=symname)
         self.assertEqual(host.hostsymname, symname)
 
-    def test_set_symname(self):
+    def test_set_hostsymname(self):
         hostnqn = 'nqn.2014-08.com.example:test-host-set-symname'
         host = nvme.Host(self.ctx, hostnqn=hostnqn)
-        host.set_symname('updated-symname')
+        host.hostsymname = 'updated-symname'
         self.assertEqual(host.hostsymname, 'updated-symname')
 
     def test_dhchap_host_key_is_none_by_default(self):
@@ -106,6 +111,12 @@ def test_context_manager(self):
         with nvme.Host(self.ctx) as h:
             self.assertIsNotNone(h)
 
+    def test_context_manager_properties_accessible(self):
+        hostnqn = 'nqn.2014-08.com.example:test-host-ctx-mgr'
+        with nvme.Host(self.ctx, hostnqn=hostnqn) as h:
+            self.assertEqual(h.hostnqn, hostnqn)
+            self.assertIsNone(h.dhchap_host_key)
+
 
 class TestCtrl(unittest.TestCase):
 
@@ -163,7 +174,7 @@ def test_trsvcid_property(self):
 
     def test_connected_returns_false_before_connect(self):
         ctrl = self._make_loop_ctrl()
-        self.assertFalse(ctrl.connected())
+        self.assertFalse(ctrl.connected)
 
     def test_name_is_none_before_connect(self):
         ctrl = self._make_loop_ctrl()
@@ -181,6 +192,15 @@ def test_context_manager(self):
         }) as c:
             self.assertIsNotNone(c)
 
+    def test_context_manager_properties_accessible(self):
+        with nvme.Ctrl(self.ctx, {
+            'subsysnqn': self.subsysnqn,
+            'transport': 'loop',
+        }) as c:
+            self.assertEqual(c.transport, 'loop')
+            self.assertEqual(c.subsysnqn, self.subsysnqn)
+            self.assertFalse(c.connected)
+
     def test_namespaces_iterator_returns_list(self):
         ctrl = self._make_loop_ctrl()
         nss = list(ctrl.namespaces())
@@ -216,7 +236,7 @@ def test_multiple_ctrls_same_ctx(self):
         ctrls = [self._make_loop_ctrl() for _ in range(5)]
         self.assertEqual(len(ctrls), 5)
         for c in ctrls:
-            self.assertFalse(c.connected())
+            self.assertFalse(c.connected)
 
 
 class TestCtrlErrorHandling(unittest.TestCase):