ntv-numpy.ntv_numpy.numpy_ntv_connector

  1# -*- coding: utf-8 -*-
  2"""
  3@author: Philippe@loco-labs.io
  4
  5The `numpy_ntv_connector` module is part of the `ntv-numpy.ntv_numpy` package
  6([specification document](
  7https://loco-philippe.github.io/ES/JSON%20semantic%20format%20(JSON-NTV).htm)).
  8
  9A NtvConnector is defined by:
 10- clas_obj: str - define the class name of the object to convert
 11- clas_typ: str - define the NTVtype of the converted object
 12- to_obj_ntv: method - converter from JsonNTV to the object
 13- to_json_ntv: method - converter from the object to JsonNTV
 14
 15It contains the child classes of `NTV.json_ntv.ntv.NtvConnector` abstract class:
 16    - `NarrayConnec`: 'narray' connector for np.ndarray data
 17    - `NdarrayConnec`: 'ndarray'   connector for Ndarray data
 18    - `XndarrayConnec`: 'xndarray' connector for Xndarray data
 19    - `XdatasetConnec`: 'xdataset' connector for Xdataset data
 20"""
 21from json_ntv import NtvConnector
 22
 23from ntv_numpy.ndarray import Ndarray
 24from ntv_numpy.xndarray import Xndarray
 25from ntv_numpy.xdataset import Xdataset
 26
 27
 28class NarrayConnec(NtvConnector):
 29
 30    '''NTV connector for Numpy ndarray.'''
 31
 32    clas_obj = 'ndarray'
 33    clas_typ = 'narray'
 34
 35    @staticmethod
 36    def to_obj_ntv(ntv_value, **kwargs):
 37        ''' convert json ntv_value into a np.ndarray.
 38
 39        *Parameters*
 40
 41        - **convert** : boolean (default True) - If True, convert json data with
 42        non Numpy ntv_type into data with python type'''
 43        return Ndarray.read_json(ntv_value, **kwargs).darray
 44
 45    @staticmethod
 46    def to_json_ntv(value, name=None, typ=None, **kwargs):
 47        ''' convert a np.ndarray (value, name, type) into NTV json (json-value, name, ntv_type).
 48
 49        *Parameters*
 50
 51        - **typ** : string (default None) - ntv_type of the np.ndarray object,
 52        - **name** : string (default None) - name of the ndarray object
 53        - **value** : np.ndarray value
 54        - **noshape** : Boolean (default True) - if True, without shape if dim < 1
 55        - **notype** : Boolean (default False) - including data type if False
 56        - **novalue** : Boolean (default False) - including value if False
 57        - **format** : string (default 'full') - representation format of the ndarray,
 58        - **encoded** : Boolean (default False) - json-value if False else json-text
 59        - **header** : Boolean (default True) - including ndarray type
 60        '''
 61        option = {'format': 'full', 'header': True, 'encoded': False,
 62                  'notype': False, 'noshape': True, 'novalue': False} | kwargs
 63        if not option['format'] in ['full', 'complete']:
 64            option['noshape'] = False
 65        option['header'] = False
 66        return (Ndarray(value).to_json(**option), name, 'narray')
 67
 68
 69class NdarrayConnec(NtvConnector):
 70
 71    '''NTV connector for Ndarray.'''
 72
 73    clas_obj = 'Ndarray'
 74    clas_typ = 'ndarray'
 75
 76    @staticmethod
 77    def to_obj_ntv(ntv_value, **kwargs):
 78        ''' convert json ntv_value into a Ndarray.
 79
 80        *Parameters*
 81
 82        - **convert** : boolean (default True) - If True, convert json data with
 83        non-Numpy ntv_type into data with python type'''
 84        return Ndarray.read_json(ntv_value, **kwargs)
 85
 86    @staticmethod
 87    def to_json_ntv(value, name=None, typ=None, **kwargs):
 88        ''' convert a Ndarray (value, name, type) into NTV json (json-value, name, ntv_type).
 89
 90        *Parameters*
 91
 92        - **typ** : string (default None) - ntv_type of the ndarray object,
 93        - **name** : string (default None) - name of the ndarray object
 94        - **value** : Ndarray value (or np.ndarray value)
 95        - **noshape** : Boolean (default True) - if True, without shape if dim < 1
 96        - **notype** : Boolean (default False) - including data type if False
 97        - **novalue** : Boolean (default False) - including value if False
 98        - **format** : string (default 'full') - representation format of the ndarray,
 99        - **encoded** : Boolean (default False) - json-value if False else json-text
100        - **header** : Boolean (default True) - including ndarray type
101        '''
102        option = {'format': 'full', 'header': True, 'encoded': False,
103                  'notype': False, 'noshape': True, 'novalue': False} | kwargs
104        if not option['format'] in ['full', 'complete']:
105            option['noshape'] = False
106        return (Ndarray(value).to_json(**option), name, 'ndarray')
107
108
109class XndarrayConnec(NtvConnector):
110
111    '''NTV connector for Xndarray.'''
112
113    clas_obj = 'Xndarray'
114    clas_typ = 'xndarray'
115
116    @staticmethod
117    def to_obj_ntv(ntv_value, **kwargs):
118        ''' convert json ntv_value into a Xndarray.
119
120        *Parameters*
121
122        - **convert** : boolean (default True) - If True, convert json data with
123        non-umpy ntv_type into Xndarray with python type
124        '''
125        print(ntv_value)
126        return Xndarray.read_json(ntv_value, **kwargs)
127
128    @staticmethod
129    def to_json_ntv(value, name=None, typ=None, **kwargs):
130        ''' convert a Xndarray (value) into NTV json (json-value, name, ntv_type).
131
132        *Parameters*
133
134        - **typ** : string (default None) - not used,
135        - **name** : string (default None) - not used
136        - **value** : Xndarray values
137        - **encoded** : Boolean (default False) - json-value if False else json-text
138        - **header** : Boolean (default True) - including xndarray type
139        - **notype** : Boolean (default False) - including data type if False
140        - **novalue** : Boolean (default False) - including value if False
141        - **noshape** : Boolean (default True) - if True, without shape if dim < 1
142        - **format** : string (default 'full') - representation format of the ndarray,
143        - **extension** : string (default None) - type extension
144        '''
145        option = {'notype': False, 'extension': None, 'format': 'full',
146                  'noshape': True, 'header': True, 'encoded': False,
147                  'novalue': False, 'noname': False} | kwargs
148        if not option['format'] in ['full', 'complete']:
149            option['noshape'] = False
150        return (value.to_json(**option), name, 'xndarray')
151
152
153class XdatasetConnec(NtvConnector):
154
155    '''NTV connector for Xdataset.'''
156
157    clas_obj = 'Xdataset'
158    clas_typ = 'xdataset'
159
160    @staticmethod
161    def to_obj_ntv(ntv_value, **kwargs):  # reindex=True, decode_str=False):
162        ''' convert json ntv_value into a Xdataset.
163
164        *Parameters*
165
166        - **convert** : boolean (default True) - If True, convert json data with
167        non-Numpy ntv_type into Xdataset with python type
168        '''
169        return Xdataset.read_json(ntv_value, **kwargs)
170
171    @staticmethod
172    def to_json_ntv(value, name=None, typ=None, **kwargs):
173        ''' convert a Xdataset (value) into NTV json (json-value, name, ntv_type).
174
175        *Parameters*
176
177        - **typ** : string (default None) - not used,
178        - **name** : string (default None) - not used
179        - **value** : Xdataset entity
180        - **encoded** : Boolean (default False) - json value if False else json text
181        - **header** : Boolean (default True) - including 'xdataset' type
182        - **notype** : list of Boolean (default list of None) - including data type if False
183        - **novalue** : Boolean (default False) - including value if False
184        - **noshape** : Boolean (default False) - if True, without shape if dim < 1
185        - **format** : list of string (default list of 'full') - representation format
186        of the np.ndarray,
187        '''
188        option = {'notype': False, 'extension': None, 'format': 'full',
189                  'noshape': True, 'header': True, 'encoded': False,
190                  'novalue': False, 'noname': False} | kwargs
191        if not option['format'] in ['full', 'complete']:
192            option['noshape'] = False
193        option['noname'] = True
194        return (value.to_json(**option), name, 'xdataset')