ntv-pandas.ntv_pandas.accessors

  1# -*- coding: utf-8 -*-
  2"""
  3Created on Sun Oct 8 2023
  4
  5@author: philippe@loco-labs.io
  6
  7
  8Accessor methods bound to pd.Series.npd, pd.DataFrame.npd
  9"""
 10import pandas as pd
 11from tab_analysis import AnaDataset
 12from ntv_numpy import Xdataset
 13from ntv_pandas.pandas_ntv_connector import to_json, as_def_type, equals
 14from ntv_pandas.pandas_ntv_connector import to_analysis, check_relation
 15
 16try:
 17    # delete the accessor to avoid warning
 18    del pd.DataFrame.npd
 19except AttributeError:
 20    pass
 21
 22
 23@pd.api.extensions.register_dataframe_accessor("npd")
 24class NpdDataFrameAccessor:
 25    """Accessor class for methods invoked as `pd.DataFrame.npd.*`"""
 26
 27    def __init__(self, pandas_obj):
 28        self._obj = pandas_obj
 29
 30    def analysis(self, distr=False):
 31        """Accessor for method `tab_analysis.AnaDataset` applied with
 32        `pandas_ntv_connector.to_analysis` invoked as `pd.DataFrame.npd.analysis`"""
 33        return AnaDataset(to_analysis(self._obj, distr))
 34
 35    def check_relation(self, parent, child, typecoupl, value=True):
 36        ''' Accessor for method `pandas_ntv_connector.check_relation` invoket as
 37        `pd.DataFrame.npd.check_relation`'''
 38        return check_relation(self._obj, parent, child, typecoupl, value)
 39
 40    def to_json(self, **kwargs):
 41        """Accessor for method `pandas_ntv_connector.to_json` invoked as
 42        `pd.DataFrame.npd.to_json`
 43
 44        *parameters*
 45
 46        - **pd_array** : Series or Dataframe to convert
 47        - **encoded** : boolean (default: False) - if True return a JSON text else a JSON value
 48        - **header** : boolean (default: True) - if True the JSON data is included as
 49        value in a {key:value} object where key is ':field' for Series or ':tab' for DataFrame
 50        - **table** : boolean (default False) - if True return TableSchema format
 51        - **index** : boolean (default True) - if True the index Series is included"""
 52        return to_json(self._obj, **kwargs)
 53
 54    def as_def_type(self):
 55        """Accessor for method `pandas_ntv_connector.as_def_type` invoked as
 56        `pd.DataFrame.npd.as_def_type`"""
 57        return as_def_type(self._obj)
 58
 59    def equals(self, other):
 60        """Accessor for method `pandas_ntv_connector.equals` invoked as
 61        `pd.DataFrame.npd.equals`"""
 62        return equals(self._obj, other)
 63
 64    def to_xarray(self, **kwargs):
 65        """Accessor for method `Xdataset.from_dataframe.to_xarray` invoked as
 66        `pd.DataFrame.npd.to_xarray`.
 67
 68        *Parameters*
 69
 70        - **dims**: list of string (default None) - order of dimensions to apply
 71        - **dataset**: Boolean (default True) - if False and a single data_var,
 72        return a sc.DataArray
 73        - **datagroup**: Boolean (default True) - if True, return a sc.DataGroup
 74        which contains the sc.DataArray/sc.Dataset and the other data else only
 75        sc.DataArray/sc.Dataset"""
 76        return Xdataset.from_dataframe(self._obj, **kwargs).to_xarray(**kwargs)
 77
 78    def to_scipp(self, **kwargs):
 79        """Accessor for method `Xdataset.from_dataframe.to_scipp` invoked as
 80        `pd.DataFrame.npd.to_scipp`.
 81
 82        *Parameters*
 83
 84        - **dims**: list of string (default None) - order of dimensions to apply
 85        - **dataset**: Boolean (default True) - if False and a single data_var,
 86        return a DataArray
 87        - **datagroup**: Boolean (default True) - if True return a DataGroup with
 88        metadata and data_arrays
 89        - **ntv_type**: Boolean (default True) - if True add ntv-type to the name"""
 90        return Xdataset.from_dataframe(self._obj, **kwargs).to_scipp(**kwargs)
 91
 92
 93try:
 94    # delete the accessor to avoid warning
 95    del pd.Series.npd
 96except AttributeError:
 97    pass
 98
 99
100@pd.api.extensions.register_series_accessor("npd")
101class NpdSeriesAccessor:
102    """Accessor class for methods invoked as `pd.Series.npd.*`"""
103
104    def __init__(self, pandas_obj):
105        self._obj = pandas_obj
106
107    def to_json(self, **kwargs):
108        """Accessor for method `pandas_ntv_connector.to_json` invoked as
109        `pd.Series.npd.to_json`"""
110        return to_json(self._obj, **kwargs)
111
112    def as_def_type(self):
113        """Accessor for method `pandas_ntv_connector.as_def_type` invoked as
114        `pd.Series.npd.as_def_type`"""
115        return as_def_type(self._obj)
116
117    def equals(self, other):
118        """Accessor for method `pandas_ntv_connector.equals` invoked as
119        `pd.DataFrame.npd.equals`"""
120        return equals(self._obj, other)