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.

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

Improve error message in the QB #3682

Merged
merged 3 commits into from
Dec 18, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
6 changes: 3 additions & 3 deletions aiida/orm/implementation/django/querybuilder.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,11 @@ def get_filter_expr(self, operator, value, attr_key, is_attribute, alias=None, c
''.format(operator, value)
)
elif operator == 'in':
if not value:
Copy link
Contributor

Choose a reason for hiding this comment

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

what if value is not even an interable? This will raise a TypeError, so maybe it is better to first check that a list/tuple is passed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Change implemented. In the end I ended up using a try/except statement instead of checking for explicit types (value could also be a set maybe?) because apparently "checking for iterables" is kind of controversial and this is a more "pythonic" approach (sauce). Let me know if you still prefer explicit type checking.

Copy link
Contributor

Choose a reason for hiding this comment

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

Normally that depends on your interface whether it declares a specific type, but in this case I don't think we do so I like your solution 👍

raise InputValidationError('Value for operator \'in\' is an empty list')
Copy link
Contributor

Choose a reason for hiding this comment

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

We indeed prefer single quotes for string literals but not when that requires escaping internal quotes. In this case favor

'Value for operator `in` is an empty list'

or double quotes

'Value for operator "in" is an empty list'

or if you really want single quotes

"Value for operator 'in' is an empty list"

value_type_set = set(type(i) for i in value)
if len(value_type_set) > 1:
raise InputValidationError('{} contains more than one type'.format(value))
elif not value_type_set:
raise InputValidationError('{} contains is an empty list'.format(value))
raise InputValidationError('Value for operator \'in\' contains more than one type: {}'.format(value))
elif operator in ('and', 'or'):
expressions_for_this_path = []
for filter_operation_dict in value:
Expand Down
6 changes: 3 additions & 3 deletions aiida/orm/implementation/sqlalchemy/querybuilder.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,11 @@ def get_filter_expr(self, operator, value, attr_key, is_attribute, alias=None, c
)

elif operator == 'in':
if not value:
raise InputValidationError('Value for operator \'in\' is an empty list')
value_type_set = set(type(i) for i in value)
if len(value_type_set) > 1:
raise InputValidationError('{} contains more than one type'.format(value))
elif not value_type_set:
raise InputValidationError('{} contains is an empty list'.format(value))
raise InputValidationError('Value for operator \'in\' contains more than one type: {}'.format(value))
elif operator in ('and', 'or'):
expressions_for_this_path = []
for filter_operation_dict in value:
Expand Down