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

feat: add allowed_keys to dict validator #894

Merged
merged 3 commits into from
Dec 4, 2017
Merged

feat: add allowed_keys to dict validator #894

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04b4301
feat: add allowed_keys to dict validator
nulinspiratie Dec 2, 2017
c17c568
fix: remove f-strings and replace d by value
nulinspiratie Dec 2, 2017
80a31b0
Merge branch 'master' into feature/dict_vals_allowed_keys
WilliamHPNielsen Dec 4, 2017
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
23 changes: 19 additions & 4 deletions qcodes/utils/validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,14 +545,29 @@ class Dict(Validator):
"""
Validator for dictionaries
"""
def __init__(self):
# exists only to overwrite parent class
pass
def __init__(self, allowed_keys=None):
"""
Validator for dictionary keys
Args:
allowed_keys (List): if set, all keys must be in allowed_keys
"""
self.allowed_keys = allowed_keys

def validate(self, value, context=''):
if not isinstance(value, dict):
raise TypeError(
'{} is not a dictionary; {}'.format(repr(value), context))

if self.allowed_keys is not None:
forbidden_keys = [key for key in value if key not in self.allowed_keys]
if forbidden_keys:
raise SyntaxError('Dictionary keys {} are not in allowed keys '
'{}'.format(forbidden_keys,
self.allowed_keys))


def __repr__(self):
return '<Dict>'
if self.allowed_keys is None:
return '<Dict>'
else:
return '<Dict {}>'.format(self.allowed_keys)