sambacc: rename function to enable_rados

Rename the `enable_rados_url_opener` to the more general `enable_rados`
to reflect that calling this function enables rados support in sambacc
not just sambacc's urlopener hooks.

Signed-off-by: John Mulligan <[email protected]>

Author: phlogistonjohn

sambacc/commands/main.py

@@ -302,9 +302,9 @@ def pre_action(cli: typing.Any) -> None:
     if cli.samba_command_prefix:
         samba_cmds.set_global_prefix([cli.samba_command_prefix])
 
-    # should there be an option to force {en,dis}able openers?
+    # should there be an option to force {en,dis}able rados?
     # Right now we just always try to enable rados when possible.
-    rados_opener.enable_rados_url_opener(
+    rados_opener.enable_rados(
         url_opener.URLOpener,
         client_name=cli.ceph_id.get("client_name", ""),
         full_name=cli.ceph_id.get("full_name", False),

sambacc/rados_opener.py

@@ -388,15 +388,17 @@ def is_rados_uri(uri: str) -> bool:
     return uri.startswith("rados:")
 
 
-def enable_rados_url_opener(
+def enable_rados(
     cls: typing.Type[url_opener.URLOpener],
     *,
     client_name: str = "",
     full_name: bool = False,
 ) -> None:
-    """Extend the URLOpener type to support pseudo-URLs for rados
-    object storage. If rados libraries are not found the function
-    does nothing.
+    """Enable Ceph RADOS support in sambacc.
+    As as side-effect it will extend the URLOpener type to support pseudo-URLs
+    for rados object storage. It will also enable the
+    ClusterMetaRADOSObject.create_from_uri constructor. If rados libraries are
+    not found the function does nothing.
 
     If rados libraries are found than URLOpener can be used like:
     >>> uo = url_opener.URLOpener()

tests/test_rados_opener.py

@@ -35,13 +35,13 @@ def test_enable_rados_url_opener(monkeypatch):
     monkeypatch.setitem(sys.modules, "rados", mock)
 
     cls_mock = unittest.mock.MagicMock()
-    sambacc.rados_opener.enable_rados_url_opener(cls_mock)
+    sambacc.rados_opener.enable_rados(cls_mock)
     assert cls_mock._handlers.append.called
 
 
 def test_enable_rados_url_opener_fail(monkeypatch):
     cls_mock = unittest.mock.MagicMock()
-    sambacc.rados_opener.enable_rados_url_opener(cls_mock)
+    sambacc.rados_opener.enable_rados(cls_mock)
     assert not cls_mock._handlers.append.called
 
 
@@ -51,7 +51,7 @@ def test_enable_rados_url_opener_with_args(monkeypatch):
 
     cls_mock = unittest.mock.MagicMock()
     cls_mock._handlers = []
-    sambacc.rados_opener.enable_rados_url_opener(cls_mock, client_name="user1")
+    sambacc.rados_opener.enable_rados(cls_mock, client_name="user1")
     assert len(cls_mock._handlers) == 1
     assert isinstance(
         cls_mock._handlers[0]._interface, sambacc.rados_opener._RADOSInterface
@@ -74,7 +74,7 @@ def test_enable_rados_url_opener_with_args2(monkeypatch):
 
     cls_mock = unittest.mock.MagicMock()
     cls_mock._handlers = []
-    sambacc.rados_opener.enable_rados_url_opener(
+    sambacc.rados_opener.enable_rados(
         cls_mock, client_name="client.user1", full_name=True
     )
     assert len(cls_mock._handlers) == 1