Update _decorators.py

Add stacklevel parameter for warnings.warn
pandas-dev · Jul 28, 2019 · e4ce188 · e4ce188
1 parent d8845df
commit e4ce188
Showing 1 changed file with 11 additions and 8 deletions.
diff --git a/pandas/util/_decorators.py b/pandas/util/_decorators.py
@@ -215,7 +215,8 @@ def wrapper(*args, **kwargs):
 def deprecate_nonkeyword_args(version: str,
                               pos_args: list = None,
                               *,
-                              n_args: int = None):
+                              n_args: int = None,
+                              stacklevel: int = 2):
     """
     Deprecate the function call with too much positional arguments.
 
@@ -232,6 +233,8 @@ def deprecate_nonkeyword_args(version: str,
     pos_args : list
         List of names of the arguments OK to be given as positional.
 
+    stacklevel : int, default 2
+        Stack level for `warnings.warn`
     Returns
     -------
     _deprecate_nonkeyword_args : callable
@@ -256,14 +259,14 @@ def _deprecate_nonkeyword_args(func):
         def wrapper(*args, **kwargs):
             if len(args) > n_args:
                 if pos_args is None:
-                    msg = "%s will only accept %i positional arguments in version %s" % (func.__name__,
-                                                                                         n_args,
-                                                                                         version)
+                    msg = (
+                        "%s will only accept %i positional arguments in version %s"
+                    ) % (func.__name__, n_args,version)
                 else:
-                    msg = "%s will only accept positional arguments (%s) in version %s" % (func.__name__,
-                                                                                           ", ".join(pos_args),
-                                                                                           version)
-                warnings.warn(msg, FutureWarning)
+                    msg = (
+                        "%s will only accept positional arguments (%s) in version %s"
+                    ) % (func.__name__, ", ".join(pos_args), version)
+                warnings.warn(msg, FutureWarning, stacklevel=stacklevel)
             return func(*args, **kwargs)
         return wrapper