ntv-numpy.ntv_numpy.ndtype

 1# -*- coding: utf-8 -*-
 2"""
 3@author: Philippe@loco-labs.io
 4
 5The `ndtype` module is part of the `ntv-numpy.ntv_numpy` package ([specification document](
 6https://loco-philippe.github.io/ES/JSON%20semantic%20format%20(JSON-NTV).htm)).
 7
 8It contains the class `Ndtype` for NTVtype with extension.
 9
10For more information, see the
11[user guide](https://loco-philippe.github.io/ntv-numpy/docs/user_guide.html)
12 or the [github repository](https://github.com/loco-philippe/ntv-numpy).
13"""
14import configparser
15from pathlib import Path
16import json
17from json_ntv import Datatype
18import ntv_numpy
19
20
21class Ndtype(Datatype):
22    ''' The Ndtype is a child class of Datatype with additional attributes.
23
24    *Additional attributes :*
25    - add_type: additional data added to the JSON ndarray
26    - dtype: data type of the np.ndarray
27
28    *Inherited attributes :*
29    - **name** : String - name of the Datatype
30    - **nspace** : Namespace - namespace associated
31    - **custom** : boolean - True if not referenced
32    - **validate** : function (default None) - validate function
33    - **typebase** : TypeBase - TypeBas of the Datatype
34    - **extension** : String (default None) - extension of the TypeBase
35
36    The methods defined in this class are :
37    - `read_ini` (static method)
38    '''
39    @staticmethod
40    def read_ini():
41        '''return a dict with config data read in ntv_numpy.ini'''
42        config = configparser.ConfigParser()
43        p_file = Path('ntv_numpy.ini')
44        config.read(Path(ntv_numpy.__file__).parent / p_file)
45        types = json.loads(config['data']['types'])
46        return {ntv_type: {'add_type': add_type, 'dtype': dtype}
47                for [ntv_type, add_type, dtype] in types}
48
49    def __init__(self, full_name, module=False, force=False, validate=None):
50        '''NdType constructor.
51
52        *Parameters*
53
54        - **full_name** : String - absolut name of the Datatype
55        - **module** : boolean (default False) - if True search data in the
56        local .ini file, else in the distant repository
57        - **force** : boolean (default False) - if True, no Namespace control
58        - **validate** : function (default None) - validate function to include'''
59        super().__init__(full_name, module=module, force=force, validate=validate)
60        np_type = NP_TYPES.get(self.base_name)
61        self.dtype = np_type['dtype'] if np_type else None
62        self.add_type = np_type['add_type'] if np_type else None
63
64
65NP_TYPES = Ndtype.read_ini()
66NP_NTYPE = {val['dtype']: key for key, val in NP_TYPES.items()}