From 2f53a71c7bd55e43ab219918f3a2d2cb8981445a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torsten=20W=C3=B6rtwein?= Date: Wed, 22 Jul 2020 14:23:03 -0400 Subject: [PATCH 1/6] Alias cloudpickle.CloudPickler as cloudpickle.Pickler --- cloudpickle/__init__.py | 2 ++ tests/cloudpickle_test.py | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/cloudpickle/__init__.py b/cloudpickle/__init__.py index 16d82e347..b2d82ecc0 100644 --- a/cloudpickle/__init__.py +++ b/cloudpickle/__init__.py @@ -4,4 +4,6 @@ from cloudpickle.cloudpickle import * # noqa from cloudpickle.cloudpickle_fast import CloudPickler, dumps, dump # noqa +Pickler = CloudPickler + __version__ = '1.5.1dev0' diff --git a/tests/cloudpickle_test.py b/tests/cloudpickle_test.py index 634d70a5a..d570daf31 100644 --- a/tests/cloudpickle_test.py +++ b/tests/cloudpickle_test.py @@ -2342,5 +2342,11 @@ class C(typing.Generic[T]): return types_to_test +def test_module_level_pickler(): + # GH 366 + assert hasattr(cloudpickle, "Pickler") + assert cloudpickle.Pickler is cloudpickle.CloudPickler + + if __name__ == '__main__': unittest.main() From 482e282c5e4a868029b20d610bbb9b7051fb9030 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torsten=20W=C3=B6rtwein?= Date: Wed, 12 Aug 2020 14:59:25 -0400 Subject: [PATCH 2/6] Update tests/cloudpickle_test.py Co-authored-by: Pierre Glaser --- tests/cloudpickle_test.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/cloudpickle_test.py b/tests/cloudpickle_test.py index d570daf31..a456b6372 100644 --- a/tests/cloudpickle_test.py +++ b/tests/cloudpickle_test.py @@ -2343,7 +2343,8 @@ class C(typing.Generic[T]): def test_module_level_pickler(): - # GH 366 + # #366: cloudpickle should expose its pickle.Pickler subclass as + # cloudpickle.Pickler assert hasattr(cloudpickle, "Pickler") assert cloudpickle.Pickler is cloudpickle.CloudPickler From 3a1f2af1024448beefcc6db5998be148b378e96a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torsten=20W=C3=B6rtwein?= Date: Wed, 12 Aug 2020 15:03:59 -0400 Subject: [PATCH 3/6] changelog --- CHANGES.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index 790424cf4..2ac25f635 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,9 @@ 1.5.1 (in development) ====================== +- Provide `cloudpickle.CloudPickler` as `cloudpickle.Pickler`. + ([issue #366](https://github.com/cloudpipe/cloudpickle/issues/366)) + 1.5.0 ===== From bfd56b107e0d9965412745d251af1b03a692f830 Mon Sep 17 00:00:00 2001 From: Pierre Glaser Date: Thu, 13 Aug 2020 22:27:41 +0100 Subject: [PATCH 4/6] Update CHANGES.md --- CHANGES.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index 2ac25f635..4010f74c2 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,7 +1,11 @@ 1.5.1 (in development) ====================== -- Provide `cloudpickle.CloudPickler` as `cloudpickle.Pickler`. +- `cloudpickle`'s pickle.Pickler subclass (currently defined as + `cloudpickle.cloudpickle_fast.CloudPickler`) can and should now be accessed + as `cloudpickle.Pickler`. This is the only officially supported way of + accessing it. + ([issue #366](https://github.com/cloudpipe/cloudpickle/issues/366)) ([issue #366](https://github.com/cloudpipe/cloudpickle/issues/366)) From ffa0c40ba52ee01836cfdf8e72581c74336272df Mon Sep 17 00:00:00 2001 From: Pierre Glaser Date: Thu, 13 Aug 2020 22:30:13 +0100 Subject: [PATCH 5/6] Update CHANGES.md --- CHANGES.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index 4010f74c2..d6a0aa988 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,7 +6,6 @@ as `cloudpickle.Pickler`. This is the only officially supported way of accessing it. ([issue #366](https://github.com/cloudpipe/cloudpickle/issues/366)) - ([issue #366](https://github.com/cloudpipe/cloudpickle/issues/366)) 1.5.0 From dde84cf426754a32b000d00e13a56df9dd0576a4 Mon Sep 17 00:00:00 2001 From: Pierre Glaser Date: Thu, 13 Aug 2020 22:36:54 +0100 Subject: [PATCH 6/6] Update cloudpickle/__init__.py --- cloudpickle/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cloudpickle/__init__.py b/cloudpickle/__init__.py index b2d82ecc0..9fe132460 100644 --- a/cloudpickle/__init__.py +++ b/cloudpickle/__init__.py @@ -4,6 +4,8 @@ from cloudpickle.cloudpickle import * # noqa from cloudpickle.cloudpickle_fast import CloudPickler, dumps, dump # noqa +# Conform to the convention used by python serialization libraries, which +# expose their Pickler subclass at top-level under the "Pickler" name. Pickler = CloudPickler __version__ = '1.5.1dev0'