summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorStefan van der Walt <stefanv@berkeley.edu>2019-03-13 23:22:49 -0700
committerStefan van der Walt <stefanv@berkeley.edu>2019-03-13 23:23:02 -0700
commitf45466d7604b645d68fd6224cba8b40dac661dd7 (patch)
tree6fc26c44b0f5cad4fb0f3b07b2ac7cf761dde2b8 /numpy
parenteea136ffadf75b92d8125678ce196367b1e3836c (diff)
downloadnumpy-f45466d7604b645d68fd6224cba8b40dac661dd7.tar.gz
ENH: Make `mode` parameter default to `constant` (padding by zero)
Diffstat (limited to 'numpy')
-rw-r--r--numpy/lib/arraypad.py6
-rw-r--r--numpy/lib/tests/test_arraypad.py7
2 files changed, 6 insertions, 7 deletions
diff --git a/numpy/lib/arraypad.py b/numpy/lib/arraypad.py
index b236cc449..ffb7064f2 100644
--- a/numpy/lib/arraypad.py
+++ b/numpy/lib/arraypad.py
@@ -962,7 +962,7 @@ def _pad_dispatcher(array, pad_width, mode, **kwargs):
@array_function_dispatch(_pad_dispatcher, module='numpy')
-def pad(array, pad_width, mode, **kwargs):
+def pad(array, pad_width, mode='constant', **kwargs):
"""
Pads an array.
@@ -977,10 +977,10 @@ def pad(array, pad_width, mode, **kwargs):
((before, after),) yields same before and after pad for each axis.
(pad,) or int is a shortcut for before = after = pad width for all
axes.
- mode : str or function
+ mode : str or function, optional
One of the following string values or a user supplied function.
- 'constant'
+ 'constant' (default)
Pads with a constant value.
'edge'
Pads with the edge values of array.
diff --git a/numpy/lib/tests/test_arraypad.py b/numpy/lib/tests/test_arraypad.py
index a9030e737..51633bb70 100644
--- a/numpy/lib/tests/test_arraypad.py
+++ b/numpy/lib/tests/test_arraypad.py
@@ -1249,10 +1249,9 @@ def test_kwargs(mode):
np.pad([1, 2, 3], 1, mode, **{key: value})
-def test_missing_mode():
- match = "missing 1 required positional argument: 'mode'"
- with pytest.raises(TypeError, match=match):
- np.pad(np.ones((5, 6)), 4)
+def test_constant_zero_default():
+ arr = np.array([1, 1])
+ assert_array_equal(pad(arr, 2), [0, 0, 1, 1, 0, 0])
@pytest.mark.parametrize("mode", _all_modes.keys())