sambacc: rename rados object class to RADOSObjectRef

Previously, the class name was "private" and only expected to be used
indirectly through the opener infrastructure. Future changes will make
it possible to write "open" objects, lock them, etc. Prepare for that
by making the class "public" and cleaning up the basic interface a bit.

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

Author: phlogistonjohn

sambacc/rados_opener.py

@@ -25,7 +25,7 @@
 import urllib.request
 
 from . import url_opener
-from .typelets import ExcType, ExcValue, ExcTraceback
+from .typelets import ExcType, ExcValue, ExcTraceback, Self
 
 _RADOSModule = typing.Any
 _RADOSObject = typing.Any
@@ -80,16 +80,23 @@ def rados_open(self, req: urllib.request.Request) -> typing.IO:
 # it's quite annoying to have a read-only typing.IO we're forced to
 # have so many stub methods. Go's much more granular io interfaces for
 # readers/writers is much nicer for this.
-class _RADOSResponse(typing.IO):
+class RADOSObjectRef(typing.IO):
     def __init__(
-        self, interface: _RADOSInterface, pool: str, ns: str, key: str
+        self,
+        interface: _RADOSInterface,
+        pool: str,
+        ns: str,
+        key: str,
+        *,
+        must_exist: bool = True,
     ) -> None:
         self._pool = pool
         self._ns = ns
         self._key = key
 
         self._open(interface)
-        self._test()
+        if must_exist:
+            self._test()
 
     def _open(self, interface: _RADOSInterface) -> None:
         # TODO: connection caching
@@ -142,15 +149,15 @@ def mode(self) -> str:
     def name(self) -> str:
         return self._key
 
-    def __enter__(self) -> _RADOSResponse:
+    def __enter__(self) -> Self:
         return self
 
     def __exit__(
         self, exc_type: ExcType, exc_val: ExcValue, exc_tb: ExcTraceback
     ) -> None:
         self.close()
 
-    def __iter__(self) -> _RADOSResponse:
+    def __iter__(self) -> Self:
         return self
 
     def __next__(self) -> bytes:

tests/test_rados_opener.py

@@ -133,7 +133,7 @@ def _read(_, size, off):
     mock = unittest.mock.MagicMock()
     mock.Rados.return_value.open_ioctx.return_value.read.side_effect = _read
 
-    rr = sambacc.rados_opener._RADOSResponse(mock, "foo", "bar", "baz")
+    rr = sambacc.rados_opener.RADOSObjectRef(mock, "foo", "bar", "baz")
     assert rr.readable()
     assert not rr.seekable()
     assert not rr.writable()
@@ -160,7 +160,7 @@ def _read(_, size, off):
     mock = unittest.mock.MagicMock()
     mock.Rados.return_value.open_ioctx.return_value.read.side_effect = _read
 
-    rr = sambacc.rados_opener._RADOSResponse(mock, "foo", "bar", "baz")
+    rr = sambacc.rados_opener.RADOSObjectRef(mock, "foo", "bar", "baz")
     assert rr.readable()
     assert rr.read(8) == b"a bad ca"
     assert rr.read(8) == b"t lives "
@@ -178,7 +178,7 @@ def _read(_, size, off):
     mock = unittest.mock.MagicMock()
     mock.Rados.return_value.open_ioctx.return_value.read.side_effect = _read
 
-    rr = sambacc.rados_opener._RADOSResponse(mock, "foo", "bar", "baz")
+    rr = sambacc.rados_opener.RADOSObjectRef(mock, "foo", "bar", "baz")
     with rr:
         result = [value for value in rr]
     assert result == [sval]
@@ -189,7 +189,7 @@ def _read(_, size, off):
 def test_rados_response_not_implemented():
     mock = unittest.mock.MagicMock()
 
-    rr = sambacc.rados_opener._RADOSResponse(mock, "foo", "bar", "baz")
+    rr = sambacc.rados_opener.RADOSObjectRef(mock, "foo", "bar", "baz")
     with pytest.raises(NotImplementedError):
         rr.seek(10)
     with pytest.raises(NotImplementedError):