Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow for roundtrips of cloudpaths through pickle serialization #454

Merged
merged 1 commit into from
Aug 15, 2024
Merged

allow for roundtrips of cloudpaths through pickle serialization #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## UNRELEASED

- Allow `CloudPath` objects to be loaded/dumped through pickle format repeatedly. (Issue [#450](https://github.com/drivendataorg/cloudpathlib/issues/450))
- Fixes typo in `FileCacheMode` where values were being filled by envvar `CLOUPATHLIB_FILE_CACHE_MODE` instead of `CLOUDPATHLIB_FILE_CACHE_MODE`. (PR [#424](https://github.com/drivendataorg/cloudpathlib/pull/424)
- Fix `CloudPath` cleanup via `CloudPath.__del__` when `Client` encounters an exception during initialization and does not create a `file_cache_mode` attribute. (Issue [#372](https://github.com/drivendataorg/cloudpathlib/issues/372), thanks to [@bryanwweber](https://github.com/bryanwweber))
- Drop support for Python 3.7; pin minimal `boto3` version to Python 3.8+ versions. (PR [#407](https://github.com/drivendataorg/cloudpathlib/pull/407))
Expand Down
3 changes: 2 additions & 1 deletion cloudpathlib/cloudpath.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,8 @@ def __getstate__(self) -> Dict[str, Any]:
state = self.__dict__.copy()

# don't pickle client
del state["_client"]
if "_client" in state:
del state["_client"]

return state

Expand Down
14 changes: 14 additions & 0 deletions tests/test_cloudpath_serialize.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import pickle

from cloudpathlib import CloudPath


def test_pickle_roundtrip():
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there is an existing file this would be better suited to put it within let me know and happy to move it!

I verified that this does repro the issue without the above change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separate file for serializing is fine. Can you also move this test over to the new file so they are together?

cloudpathlib/tests/test_cloudpath_file_io.py

Lines 457 to 472 in 08b018b

def test_pickle(rig, tmpdir):
p = rig.create_cloud_path("dir_0/file0_0.txt")
with (tmpdir / "test.pkl").open("wb") as f:
pickle.dump(p, f)
with (tmpdir / "test.pkl").open("rb") as f:
pickled = pickle.load(f)
# test a call to the network
assert pickled.exists()
# check we unpickled, and that client is the default client
assert str(pickled) == str(p)
assert pickled.client == p.client
assert rig.client_class._default_client == pickled.client

path1 = CloudPath("s3://bucket/key")
pkl1 = pickle.dumps(path1)

path2 = pickle.loads(pkl1)
pkl2 = pickle.dumps(path2)

assert path1 == path2
assert pkl1 == pkl2
Loading