Skip to content

Added a decorator function to validate parameters #22193

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

Closed
shantanuo wants to merge 3 commits into from
Closed

Added a decorator function to validate parameters #22193

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e6513e
added a function
shantanuo Aug 3, 2018
ad26c3c
Added a decorator to validate parameters
shantanuo Aug 3, 2018
0a1f005
changed list to set
shantanuo Aug 4, 2018
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
4 changes: 2 additions & 2 deletions pandas/io/excel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import numpy as np

import pandas._libs.json as json
from pandas.util._decorators import Appender, deprecate_kwarg
from pandas.util._decorators import Appender, deprecate_kwarg, validate_kwarg
from pandas.errors import EmptyDataError

import pandas.compat as compat
Expand Down Expand Up @@ -279,7 +279,7 @@ def get_writer(engine_name):
raise ValueError("No Excel writer '{engine}'"
.format(engine=engine_name))


@validate_kwarg()
@Appender(_read_excel_doc)
@deprecate_kwarg("parse_cols", "usecols")
@deprecate_kwarg("skip_footer", "skipfooter")
Expand Down
15 changes: 15 additions & 0 deletions pandas/util/_decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
from textwrap import dedent, wrap
from functools import wraps, update_wrapper, WRAPPER_ASSIGNMENTS

def validate_kwarg():
def _validate_kwarg(func):
@wraps(func)
def wrapper(*args, **kwargs):
expected_keys=['io', 'sheet_name','header', 'names', 'index_col', 'usecols', 'squeeze', 'dtype', 'engine',
Copy link
Member

@WillAyd WillAyd Aug 4, 2018

Choose a reason for hiding this comment

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

Just instantiate this as a set

'converters', 'true_values', 'false_values', 'skiprows', 'nrows', 'na_values', 'verbose', 'parse_dates',
'date_parser', 'thousands', 'comment', 'skipfooter', 'convert_float']

if set(kwargs.keys()).difference(set(expected_keys)):
raise ValueError('invalid parameter found')
Copy link
Member

@WillAyd WillAyd Aug 4, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Would be nice to be explicit about which parameter isn't working. Also need a test


return func(*args, **kwargs)
return wrapper
return _validate_kwarg


def deprecate(name, alternative, version, alt_name=None,
klass=None, stacklevel=2, msg=None):
Expand Down