Skip to content

reword dictionary check #602

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

Merged
solegalli merged 2 commits into from
Jan 28, 2023
Merged

reword dictionary check #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5535b70
reword dictionary check
solegalli Jan 28, 2023
b7bf17b
reword test name
solegalli Jan 28, 2023
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
12 changes: 6 additions & 6 deletions feature_engine/_check_input_parameters/check_input_dictionary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@

def _check_numerical_dict(dict_: Optional[dict]) -> Optional[dict]:
"""
Checks if all values in dictionary are integers and floats. Can take None as
argument.
Checks that all values in the dictionary are integers and floats. It can take also
take None as value.

Parameters
----------
the_dict : dict
The dictionary that will be checked
dict_ : dict
The dictionary that will be checked.

Raises
------
ValueError
If any of the values in the dictionary are not int or float
If any of the values in the dictionary are not int or float.
TypeError
When argument type is not a dictionary.
When input type is not a dictionary.
"""

if isinstance(dict_, dict):
Expand Down
4 changes: 2 additions & 2 deletions tests/test_check_input_parameters/test_check_input_dictionary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@


@pytest.mark.parametrize("input_dict", [{"a": 1, "b": "c"}, {1: 1, 2: "c"}])
def test_not_numerical_dict(input_dict):
def test_raises_error_when_item_in_dict_not_numerical(input_dict):
with pytest.raises(ValueError):
_check_numerical_dict(input_dict)


@pytest.mark.parametrize("input_dict", [[1, 2, 3], (1, 2, 3), "hola", 5])
def test_input_type(input_dict):
def test_raises_error_when_input_not_dictionary_or_none(input_dict):
with pytest.raises(TypeError):
_check_numerical_dict(input_dict)