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

ReadOnlyDict/List pickle compatibility and serialization tests #737

Merged
merged 13 commits into from
Oct 16, 2020
Merged

ReadOnlyDict/List pickle compatibility and serialization tests #737

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
449e1da
Convert ReadOnly{Dict,List} to proxy, supporting pickle
AdamGleave Jul 11, 2019
3c5fc9f
Fix linting
AdamGleave Jul 11, 2019
2b94948
Merge branch 'master' into readonly-picklable
shwang May 29, 2020
2609960
custom_containers: JSON and Pickle compatibility
shwang May 29, 2020
7a0f72a
We actually only need __reduce__ for pickle
shwang May 30, 2020
90f9e62
Rename params
shwang May 30, 2020
914c578
Remove dangling comment
shwang May 30, 2020
f32fb05
Make CI happy (lint, f-string, black)
shwang May 30, 2020
188d7ca
Merge branch 'master' into shwang/readonly-picklable
shwang May 31, 2020
69a6ace
Address review comments
shwang Oct 15, 2020
e25b5f9
Merge branch 'master' into shwang/readonly-picklable
shwang Oct 15, 2020
fe6c466
ReadOnlyContainer: Remove self.message attribute
shwang Oct 15, 2020
1d3e6c9
Address comments
shwang Oct 15, 2020
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
Next Next commit
Convert ReadOnly{Dict,List} to proxy, supporting pickle
  • Loading branch information
@AdamGleave
AdamGleave committed Jul 11, 2019
commit 449e1da8855d5245b570361311cd21e9f0df9876
76 changes: 58 additions & 18 deletions sacred/config/custom_containers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#!/usr/bin/env python
# coding=utf-8
import collections
import copy
import sys

import sacred.optional as opt
from sacred.utils import join_paths, SacredError
Expand Down Expand Up @@ -226,6 +228,12 @@ def revelation(self):
return set()


def _passthrough(fn):
def f(self, *args, **kwargs):
return fn(self.container, *args, **kwargs)
return f


class ReadOnlyContainer:
def __init__(self, *args, message=None, **kwargs):
super().__init__(*args, **kwargs)
Expand All @@ -237,37 +245,66 @@ def _readonly(self, *args, **kwargs):
filter_traceback='always'
)


class ReadOnlyDict(ReadOnlyContainer, dict):
class ReadOnlyDict(collections.Mapping, ReadOnlyContainer):
"""
A read-only variant of a `dict`
"""
# Overwrite all methods that can modify a dict
# Read-only
__contains__ = _passthrough(dict.__contains__)
__eq__ = _passthrough(dict.__eq__)
__getitem__ = _passthrough(dict.__getitem__)
__iter__ = _passthrough(dict.__iter__)
__len__ = _passthrough(dict.__len__)
get = _passthrough(dict.get)
keys = _passthrough(dict.keys)
values = _passthrough(dict.values)

if sys.version_info[0] >= 3:
items = _passthrough(dict.items)
else:
iterkeys = _passthrough(dict.iterkeys)
itervalues = _passthrough(dict.itervalues)
iteritems = _passthrough(dict.iteritems)

# Mutable
__delitem__ = ReadOnlyContainer._readonly
__setitem__ = ReadOnlyContainer._readonly
clear = ReadOnlyContainer._readonly
pop = ReadOnlyContainer._readonly
popitem = ReadOnlyContainer._readonly
setdefault = ReadOnlyContainer._readonly
update = ReadOnlyContainer._readonly
__setitem__ = ReadOnlyContainer._readonly
__delitem__ = ReadOnlyContainer._readonly

def __init__(self, *args, message=None, **kwargs):
if message is None:
message = 'This ReadOnlyDict is read-only!'
super().__init__(*args, message=message, **kwargs)
def __init__(self, *args, **kwargs):
# Python 2.7 compatibility
self.message = kwargs.pop('message', None) or \
'This ReadOnlyDict is read-only!'

# Call dict init
self.container = dict(*args, **kwargs)

def __copy__(self):
return {**self}
return {**self.container}

def __deepcopy__(self, memo):
d = dict(self)
d = dict(self.container)
return copy.deepcopy(d, memo=memo)


class ReadOnlyList(ReadOnlyContainer, list):
class ReadOnlyList(collections.Sequence, ReadOnlyContainer):
"""
A read-only variant of a `list`
"""
# Read-only
__eq__ = _passthrough(list.__eq__)
__contains__ = _passthrough(list.__contains__)
__getitem__ = _passthrough(list.__getitem__)
__iter__ = _passthrough(list.__iter__)
__reversed__ = _passthrough(list.__reversed__)
__len__ = _passthrough(list.__len__)
index = _passthrough(list.index)
count = _passthrough(list.count)

append = ReadOnlyContainer._readonly
clear = ReadOnlyContainer._readonly
extend = ReadOnlyContainer._readonly
Expand All @@ -279,16 +316,19 @@ class ReadOnlyList(ReadOnlyContainer, list):
__setitem__ = ReadOnlyContainer._readonly
__delitem__ = ReadOnlyContainer._readonly

def __init__(self, *iterable, message=None, **kwargs):
if message is None:
message = 'This ReadOnlyList is read-only!'
super().__init__(*iterable, message=message, **kwargs)
def __init__(self, *iterable, **kwargs):
# Python 2.7 compatibility
self.message = kwargs.pop('message', None) or \
'This ReadOnlyList is read-only!'

# Call list init
self.container = list(*iterable)

def __copy__(self):
return [*self]
return [*self.container]

def __deepcopy__(self, memo):
lst = list(self)
lst = list(self.container)
return copy.deepcopy(lst, memo=memo)


Expand Down