Skip to content

fix #203 : raise error in array creation functions #220

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
gdementen merged 1 commit into from
Apr 24, 2017
Merged

fix #203 : raise error in array creation functions #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions doc/source/changes/version_0_22.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,6 @@ Fixes
* fixed group sum over boolean arrays (closes :issue:`194`).

* fixed set_labels when inplace=True

* fixed array creation functions not raising an exception when called with wrong syntax func(axis1, axis2, ...)
instead of func([axis1, axis2, ...]). (closes :issue:`203`)
31 changes: 26 additions & 5 deletions larray/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@
import re
import sys
import warnings
import functools

try:
import builtins
Expand Down Expand Up @@ -10130,12 +10131,23 @@ def read_sas(filepath, nb_index=None, index_col=None, na=np.nan, sort_rows=False
return df_aslarray(df, sort_rows=sort_rows, sort_columns=sort_columns, fill_value=na)


def _check_axes_argument(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
if len(args) > 1 and isinstance(args[1], (int, Axis)):
raise ValueError("If you want to pass several axes or dimension lengths to {}, "
"you must pass them as a list (using []) or tuple (using()).".format(func.__name__))
return func(*args, **kwargs)

@gdementen gdementen Apr 18, 2017 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

when wrapping a function, you need to copy its __name__ and __doc__ and possibly other stuff, or preferably, use functools.wraps on the wrapper.

return wrapper


@_check_axes_argument
def zeros(axes, title='', dtype=float, order='C'):
"""Returns an array with the specified axes and filled with zeros.

Parameters
----------
axes : int, tuple of int or tuple/list/AxisCollection of Axis
axes : int, tuple of int, Axis or tuple/list/AxisCollection of Axis
Collection of axes or a shape.
title : str, optional
Title.
Expand Down Expand Up @@ -10206,12 +10218,13 @@ def zeros_like(array, title='', dtype=None, order='K'):
return LArray(np.zeros_like(array, dtype, order), array.axes, title)


@_check_axes_argument
def ones(axes, title='', dtype=float, order='C'):
"""Returns an array with the specified axes and filled with ones.

Parameters
----------
axes : int, tuple of int or tuple/list/AxisCollection of Axis
axes : int, tuple of int, Axis or tuple/list/AxisCollection of Axis
Collection of axes or a shape.
title : str, optional
Title.
Expand Down Expand Up @@ -10274,12 +10287,13 @@ def ones_like(array, title='', dtype=None, order='K'):
return LArray(np.ones_like(array, dtype, order), axes, title)


@_check_axes_argument
def empty(axes, title='', dtype=float, order='C'):
"""Returns an array with the specified axes and uninitialized (arbitrary) data.

Parameters
----------
axes : int, tuple of int or tuple/list/AxisCollection of Axis
axes : int, tuple of int, Axis or tuple/list/AxisCollection of Axis
Collection of axes or a shape.
title : str, optional
Title.
Expand Down Expand Up @@ -10343,12 +10357,13 @@ def empty_like(array, title='', dtype=None, order='K'):
return LArray(np.empty_like(array.data, dtype, order), array.axes, title)


# We cannot use @_check_axes_argument here because an integer fill_value would be considered as an error
def full(axes, fill_value, title='', dtype=None, order='C'):
"""Returns an array with the specified axes and filled with fill_value.

Parameters
----------
axes : int, tuple of int or tuple/list/AxisCollection of Axis
axes : int, tuple of int, Axis or tuple/list/AxisCollection of Axis
Collection of axes or a shape.
fill_value : scalar or LArray
Value to fill the array
Expand Down Expand Up @@ -10381,6 +10396,9 @@ def full(axes, fill_value, title='', dtype=None, order='C'):
BE | 0 | 1
FO | 0 | 1
"""
if isinstance(fill_value, Axis):
raise ValueError("If you want to pass several axes or dimension lengths to full, "
"you must pass them as a list (using []) or tuple (using()).")
if dtype is None:
dtype = np.asarray(fill_value).dtype
res = empty(axes, title, dtype, order)
Expand Down Expand Up @@ -10638,6 +10656,7 @@ def array_or_full(a, axis, initial):
return res


@_check_axes_argument
def ndrange(axes, start=0, title='', dtype=int):
"""Returns an array with the specified axes and filled with increasing int.

Expand Down Expand Up @@ -10710,6 +10729,7 @@ def ndrange(axes, start=0, title='', dtype=int):
return LArray(data.reshape(axes.shape), axes, title)


@_check_axes_argument
def ndtest(shape, start=0, label_start=0, title='', dtype=int):
"""Returns test array with given shape.

Expand All @@ -10719,7 +10739,7 @@ def ndtest(shape, start=0, label_start=0, title='', dtype=int):

Parameters
----------
shape : int, tuple or list
shape : int, tuple/list of int
Shape of the array to create. An int can be used directly for one
dimensional arrays.
start : int or float, optional
Expand Down Expand Up @@ -10856,6 +10876,7 @@ def diag(a, k=0, axes=(0, 1), ndim=2, split=True):
return a.points[indexer]


@_check_axes_argument
def labels_array(axes, title=''):
"""Returns an array with specified axes and the combination of
corresponding labels as values.
Expand Down