Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions fsspec/mapping.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from fsspec.core import url_to_fs

logger = logging.getLogger("fsspec.mapping")
_MISSING = object()


class FSMap(MutableMapping):
Expand Down Expand Up @@ -161,9 +162,14 @@ def __getitem__(self, key, default=None):
raise KeyError(key) from exc
return result

def pop(self, key, default=None):
def pop(self, key, default=_MISSING):
"""Pop data"""
result = self.__getitem__(key, default)
try:
result = self[key]
except KeyError:
if default is _MISSING:
raise
return default
try:
del self[key]
except KeyError:
Expand Down
31 changes: 31 additions & 0 deletions fsspec/tests/test_mapping.py
Original file line number Diff line number Diff line change
Expand Up @@ -239,3 +239,34 @@ def test_fsmap_dirfs():
fs = m.dirfs
assert isinstance(fs, fsspec.implementations.dirfs.DirFileSystem)
assert fs.path == m.root


@pytest.mark.parametrize("protocol", ["memory", "file"])
@pytest.mark.parametrize("default", [None, False, 0, b"", []])
def test_pop_missing_key_returns_explicit_default(tmp_path, protocol, default):
mapper = fsspec.get_mapper(
f"{protocol}://{tmp_path.as_posix()}/mapping", create=True
)

assert mapper.pop("missing", default) is default


@pytest.mark.parametrize("protocol", ["memory", "file"])
def test_pop_without_default_raises_for_missing_key(tmp_path, protocol):
mapper = fsspec.get_mapper(
f"{protocol}://{tmp_path.as_posix()}/mapping", create=True
)

with pytest.raises(KeyError, match="missing"):
mapper.pop("missing")


@pytest.mark.parametrize("protocol", ["memory", "file"])
def test_pop_existing_key_returns_and_removes_value(tmp_path, protocol):
mapper = fsspec.get_mapper(
f"{protocol}://{tmp_path.as_posix()}/mapping", create=True
)
mapper["key"] = b"value"

assert mapper.pop("key", None) == b"value"
assert "key" not in mapper
Loading