Source code for argschema.fields.numpyarrays

'''marshmallow fields related to reading in numpy arrays'''
import numpy as np
import marshmallow as mm

[docs]class NumpyArray(mm.fields.List): """NumpyArray is a :class:`marshmallow.fields.List` subclass which will convert any numpy compatible set of lists into a numpy array after deserialization and convert it back to a list when serializing, Parameters ---------- dtype : numpy.Dtype dtype specifying the desired data type. if dtype is given the array will be converted to the type, otherwise numpy will decide what type it should be. (Default=None) """ def __init__(self, dtype=None, *args, **kwargs): self.dtype = dtype if "cli_as_single_argument" not in kwargs: kwargs["cli_as_single_argument"] = True super(NumpyArray, self).__init__(mm.fields.Field, *args, **kwargs) def _deserialize(self, value, attr, obj): try: return np.array(value, dtype=self.dtype) except ValueError as e: raise mm.ValidationError( 'Cannot create numpy array with type {} from data.'.format( self.dtype)) def _serialize(self, value, attr, obj): if value is None: return None return mm.fields.List._serialize(self, value.tolist(), attr, obj)