19def get_pipes(
 20    connector_keys: Union[str, List[str], None] = None,
 21    metric_keys: Union[str, List[str], None] = None,
 22    location_keys: Union[str, List[str], None] = None,
 23    tags: Optional[List[str]] = None,
 24    params: Optional[Dict[str, Any]] = None,
 25    mrsm_instance: Union[str, InstanceConnector, None] = None,
 26    instance: Union[str, InstanceConnector, None] = None,
 27    as_list: bool = False,
 28    method: str = 'registered',
 29    debug: bool = False,
 30    **kw: Any
 31) -> Union[PipesDict, List[mrsm.Pipe]]:
 32    """
 33    Return a dictionary or list of `meerschaum.Pipe` objects.
 34
 35    Parameters
 36    ----------
 37    connector_keys: Union[str, List[str], None], default None
 38        String or list of connector keys.
 39        If omitted or is `'*'`, fetch all possible keys.
 40        If a string begins with `'_'`, select keys that do NOT match the string.
 41
 42    metric_keys: Union[str, List[str], None], default None
 43        String or list of metric keys. See `connector_keys` for formatting.
 44
 45    location_keys: Union[str, List[str], None], default None
 46        String or list of location keys. See `connector_keys` for formatting.
 47
 48    tags: Optional[List[str]], default None
 49         If provided, only include pipes with these tags.
 50
 51    params: Optional[Dict[str, Any]], default None
 52        Dictionary of additional parameters to search by.
 53        Params are parsed into a SQL WHERE clause.
 54        E.g. `{'a': 1, 'b': 2}` equates to `'WHERE a = 1 AND b = 2'`
 55
 56    mrsm_instance: Union[str, InstanceConnector, None], default None
 57        Connector keys for the Meerschaum instance of the pipes.
 58        Must be a `meerschaum.connectors.sql.SQLConnector.SQLConnector` or
 59        `meerschaum.connectors.api.APIConnector.APIConnector`.
 60        
 61    as_list: bool, default False
 62        If `True`, return pipes in a list instead of a hierarchical dictionary.
 63        `False` : `{connector_keys: {metric_key: {location_key: Pipe}}}`
 64        `True`  : `[Pipe]`
 65
 66    method: str, default 'registered'
 67        Available options: `['registered', 'explicit', 'all']`
 68        If `'registered'` (default), create pipes based on registered keys in the connector's pipes table
 69        (API or SQL connector, depends on mrsm_instance).
 70        If `'explicit'`, create pipes from provided connector_keys, metric_keys, and location_keys
 71        instead of consulting the pipes table. Useful for creating non-existent pipes.
 72        If `'all'`, create pipes from predefined metrics and locations. Required `connector_keys`.
 73        **NOTE:** Method `'all'` is not implemented!
 74
 75    **kw: Any:
 76        Keyword arguments to pass to the `meerschaum.Pipe` constructor.
 77        
 78
 79    Returns
 80    -------
 81    A dictionary of dictionaries and `meerschaum.Pipe` objects
 82    in the connector, metric, location hierarchy.
 83    If `as_list` is `True`, return a list of `meerschaum.Pipe` objects.
 84
 85    Examples
 86    --------
 87    ```
 88    >>> ### Manual definition:
 89    >>> pipes = {
 90    ...     <connector_keys>: {
 91    ...         <metric_key>: {
 92    ...             <location_key>: Pipe(
 93    ...                 <connector_keys>,
 94    ...                 <metric_key>,
 95    ...                 <location_key>,
 96    ...             ),
 97    ...         },
 98    ...     },
 99    ... },
100    >>> ### Accessing a single pipe:
101    >>> pipes['sql:main']['weather'][None]
102    >>> ### Return a list instead:
103    >>> get_pipes(as_list=True)
104    [sql_main_weather]
105    >>> 
106    ```
107    """
108
109    from meerschaum.config import get_config
110    from meerschaum.utils.warnings import error
111    from meerschaum.utils.misc import filter_keywords
112
113    if connector_keys is None:
114        connector_keys = []
115    if metric_keys is None:
116        metric_keys = []
117    if location_keys is None:
118        location_keys = []
119    if params is None:
120        params = {}
121    if tags is None:
122        tags = []
123
124    if isinstance(connector_keys, str):
125        connector_keys = [connector_keys]
126    if isinstance(metric_keys, str):
127        metric_keys = [metric_keys]
128    if isinstance(location_keys, str):
129        location_keys = [location_keys]
130
131    ### Get SQL or API connector (keys come from `connector.fetch_pipes_keys()`).
132    if mrsm_instance is None:
133        mrsm_instance = instance
134    if mrsm_instance is None:
135        mrsm_instance = get_config('meerschaum', 'instance', patch=True)
136    if isinstance(mrsm_instance, str):
137        from meerschaum.connectors.parse import parse_instance_keys
138        connector = parse_instance_keys(keys=mrsm_instance, debug=debug)
139    else:
140        from meerschaum.connectors import instance_types
141        valid_connector = False
142        if hasattr(mrsm_instance, 'type'):
143            if mrsm_instance.type in instance_types:
144                valid_connector = True
145        if not valid_connector:
146            error(f"Invalid instance connector: {mrsm_instance}")
147        connector = mrsm_instance
148    if debug:
149        from meerschaum.utils.debug import dprint
150        dprint(f"Using instance connector: {connector}")
151    if not connector:
152        error(f"Could not create connector from keys: '{mrsm_instance}'")
153
154    ### Get a list of tuples for the keys needed to build pipes.
155    result = fetch_pipes_keys(
156        method,
157        connector,
158        connector_keys = connector_keys,
159        metric_keys = metric_keys,
160        location_keys = location_keys,
161        tags = tags,
162        params = params,
163        debug = debug
164    )
165    if result is None:
166        error(f"Unable to build pipes!")
167
168    ### Populate the `pipes` dictionary with Pipes based on the keys
169    ### obtained from the chosen `method`.
170    from meerschaum import Pipe
171    pipes = {}
172    for ck, mk, lk in result:
173        if ck not in pipes:
174            pipes[ck] = {}
175
176        if mk not in pipes[ck]:
177            pipes[ck][mk] = {}
178
179        pipes[ck][mk][lk] = Pipe(
180            ck, mk, lk,
181            mrsm_instance = connector,
182            debug = debug,
183            **filter_keywords(Pipe, **kw)
184        )
185
186    if not as_list:
187        return pipes
188    from meerschaum.utils.misc import flatten_pipes_dict
189    return flatten_pipes_dict(pipes)

 80def get_connector(
 81    type: str = None,
 82    label: str = None,
 83    refresh: bool = False,
 84    debug: bool = False,
 85    **kw: Any
 86) -> Connector:
 87    """
 88    Return existing connector or create new connection and store for reuse.
 89    
 90    You can create new connectors if enough parameters are provided for the given type and flavor.
 91    
 92
 93    Parameters
 94    ----------
 95    type: Optional[str], default None
 96        Connector type (sql, api, etc.).
 97        Defaults to the type of the configured `instance_connector`.
 98
 99    label: Optional[str], default None
100        Connector label (e.g. main). Defaults to `'main'`.
101
102    refresh: bool, default False
103        Refresh the Connector instance / construct new object. Defaults to `False`.
104
105    kw: Any
106        Other arguments to pass to the Connector constructor.
107        If the Connector has already been constructed and new arguments are provided,
108        `refresh` is set to `True` and the old Connector is replaced.
109
110    Returns
111    -------
112    A new Meerschaum connector (e.g. `meerschaum.connectors.api.APIConnector`,
113    `meerschaum.connectors.sql.SQLConnector`).
114    
115    Examples
116    --------
117    The following parameters would create a new
118    `meerschaum.connectors.sql.SQLConnector` that isn't in the configuration file.
119
120    ```
121    >>> conn = get_connector(
122    ...     type = 'sql',
123    ...     label = 'newlabel',
124    ...     flavor = 'sqlite',
125    ...     database = '/file/path/to/database.db'
126    ... )
127    >>>
128    ```
129
130    """
131    from meerschaum.connectors.parse import parse_instance_keys
132    from meerschaum.config import get_config
133    from meerschaum.config.static import STATIC_CONFIG
134    from meerschaum.utils.warnings import warn
135    global _loaded_plugin_connectors
136    if isinstance(type, str) and not label and ':' in type:
137        type, label = type.split(':', maxsplit=1)
138
139    with _locks['_loaded_plugin_connectors']:
140        if not _loaded_plugin_connectors:
141            load_plugin_connectors()
142            _load_builtin_custom_connectors()
143            _loaded_plugin_connectors = True
144
145    if type is None and label is None:
146        default_instance_keys = get_config('meerschaum', 'instance', patch=True)
147        ### recursive call to get_connector
148        return parse_instance_keys(default_instance_keys)
149
150    ### NOTE: the default instance connector may not be main.
151    ### Only fall back to 'main' if the type is provided by the label is omitted.
152    label = label if label is not None else STATIC_CONFIG['connectors']['default_label']
153
154    ### type might actually be a label. Check if so and raise a warning.
155    if type not in connectors:
156        possibilities, poss_msg = [], ""
157        for _type in get_config('meerschaum', 'connectors'):
158            if type in get_config('meerschaum', 'connectors', _type):
159                possibilities.append(f"{_type}:{type}")
160        if len(possibilities) > 0:
161            poss_msg = " Did you mean"
162            for poss in possibilities[:-1]:
163                poss_msg += f" '{poss}',"
164            if poss_msg.endswith(','):
165                poss_msg = poss_msg[:-1]
166            if len(possibilities) > 1:
167                poss_msg += " or"
168            poss_msg += f" '{possibilities[-1]}'?"
169
170        warn(f"Cannot create Connector of type '{type}'." + poss_msg, stack=False)
171        return None
172
173    if 'sql' not in types:
174        from meerschaum.connectors.plugin import PluginConnector
175        from meerschaum.connectors.valkey import ValkeyConnector
176        with _locks['types']:
177            types.update({
178                'api': APIConnector,
179                'sql': SQLConnector,
180                'plugin': PluginConnector,
181                'valkey': ValkeyConnector,
182            })
183
184    ### determine if we need to call the constructor
185    if not refresh:
186        ### see if any user-supplied arguments differ from the existing instance
187        if label in connectors[type]:
188            warning_message = None
189            for attribute, value in kw.items():
190                if attribute not in connectors[type][label].meta:
191                    import inspect
192                    cls = connectors[type][label].__class__
193                    cls_init_signature = inspect.signature(cls)
194                    cls_init_params = cls_init_signature.parameters
195                    if attribute not in cls_init_params:
196                        warning_message = (
197                            f"Received new attribute '{attribute}' not present in connector " +
198                            f"{connectors[type][label]}.\n"
199                        )
200                elif connectors[type][label].__dict__[attribute] != value:
201                    warning_message = (
202                        f"Mismatched values for attribute '{attribute}' in connector "
203                        + f"'{connectors[type][label]}'.\n" +
204                        f"  - Keyword value: '{value}'\n" +
205                        f"  - Existing value: '{connectors[type][label].__dict__[attribute]}'\n"
206                    )
207            if warning_message is not None:
208                warning_message += (
209                    "\nSetting `refresh` to True and recreating connector with type:"
210                    + f" '{type}' and label '{label}'."
211                )
212                refresh = True
213                warn(warning_message)
214        else: ### connector doesn't yet exist
215            refresh = True
216
217    ### only create an object if refresh is True
218    ### (can be manually specified, otherwise determined above)
219    if refresh:
220        with _locks['connectors']:
221            try:
222                ### will raise an error if configuration is incorrect / missing
223                conn = types[type](label=label, **kw)
224                connectors[type][label] = conn
225            except InvalidAttributesError as ie:
226                warn(
227                    f"Incorrect attributes for connector '{type}:{label}'.\n"
228                    + str(ie),
229                    stack = False,
230                )
231                conn = None
232            except Exception as e:
233                from meerschaum.utils.formatting import get_console
234                console = get_console()
235                if console:
236                    console.print_exception()
237                warn(
238                    f"Exception when creating connector '{type}:{label}'.\n" + str(e),
239                    stack = False,
240                )
241                conn = None
242        if conn is None:
243            return None
244
245    return connectors[type][label]

 82def get_config(
 83        *keys: str,
 84        patch: bool = True,
 85        substitute: bool = True,
 86        sync_files: bool = True,
 87        write_missing: bool = True,
 88        as_tuple: bool = False,
 89        warn: bool = True,
 90        debug: bool = False
 91    ) -> Any:
 92    """
 93    Return the Meerschaum configuration dictionary.
 94    If positional arguments are provided, index by the keys.
 95    Raises a warning if invalid keys are provided.
 96
 97    Parameters
 98    ----------
 99    keys: str:
100        List of strings to index.
101
102    patch: bool, default True
103        If `True`, patch missing default keys into the config directory.
104        Defaults to `True`.
105
106    sync_files: bool, default True
107        If `True`, sync files if needed.
108        Defaults to `True`.
109
110    write_missing: bool, default True
111        If `True`, write default values when the main config files are missing.
112        Defaults to `True`.
113
114    substitute: bool, default True
115        If `True`, subsitute 'MRSM{}' values.
116        Defaults to `True`.
117
118    as_tuple: bool, default False
119        If `True`, return a tuple of type (success, value).
120        Defaults to `False`.
121        
122    Returns
123    -------
124    The value in the configuration directory, indexed by the provided keys.
125
126    Examples
127    --------
128    >>> get_config('meerschaum', 'instance')
129    'sql:main'
130    >>> get_config('does', 'not', 'exist')
131    UserWarning: Invalid keys in config: ('does', 'not', 'exist')
132    """
133    import json
134
135    symlinks_key = STATIC_CONFIG['config']['symlinks_key']
136    if debug:
137        from meerschaum.utils.debug import dprint
138        dprint(f"Indexing keys: {keys}", color=False)
139
140    if len(keys) == 0:
141        _rc = _config(substitute=substitute, sync_files=sync_files, write_missing=write_missing)
142        if as_tuple:
143            return True, _rc 
144        return _rc
145    
146    ### Weird threading issues, only import if substitute is True.
147    if substitute:
148        from meerschaum.config._read_config import search_and_substitute_config
149    ### Invalidate the cache if it was read before with substitute=False
150    ### but there still exist substitutions.
151    if (
152        config is not None and substitute and keys[0] != symlinks_key
153        and 'MRSM{' in json.dumps(config.get(keys[0]))
154    ):
155        try:
156            _subbed = search_and_substitute_config({keys[0]: config[keys[0]]})
157        except Exception as e:
158            import traceback
159            traceback.print_exc()
160        config[keys[0]] = _subbed[keys[0]]
161        if symlinks_key in _subbed:
162            if symlinks_key not in config:
163                config[symlinks_key] = {}
164            if keys[0] not in config[symlinks_key]:
165                config[symlinks_key][keys[0]] = {}
166            config[symlinks_key][keys[0]] = apply_patch_to_config(
167                _subbed,
168                config[symlinks_key][keys[0]]
169            )
170
171    from meerschaum.config._sync import sync_files as _sync_files
172    if config is None:
173        _config(*keys, sync_files=sync_files)
174
175    invalid_keys = False
176    if keys[0] not in config and keys[0] != symlinks_key:
177        single_key_config = read_config(
178            keys=[keys[0]], substitute=substitute, write_missing=write_missing
179        )
180        if keys[0] not in single_key_config:
181            invalid_keys = True
182        else:
183            config[keys[0]] = single_key_config.get(keys[0], None)
184            if symlinks_key in single_key_config and keys[0] in single_key_config[symlinks_key]:
185                if symlinks_key not in config:
186                    config[symlinks_key] = {}
187                config[symlinks_key][keys[0]] = single_key_config[symlinks_key][keys[0]]
188
189            if sync_files:
190                _sync_files(keys=[keys[0]])
191
192    c = config
193    if len(keys) > 0:
194        for k in keys:
195            try:
196                c = c[k]
197            except Exception as e:
198                invalid_keys = True
199                break
200        if invalid_keys:
201            ### Check if the keys are in the default configuration.
202            from meerschaum.config._default import default_config
203            in_default = True
204            patched_default_config = (
205                search_and_substitute_config(default_config)
206                if substitute else copy.deepcopy(default_config)
207            )
208            _c = patched_default_config
209            for k in keys:
210                try:
211                    _c = _c[k]
212                except Exception as e:
213                    in_default = False
214            if in_default:
215                c = _c
216                invalid_keys = False
217            warning_msg = f"Invalid keys in config: {keys}"
218            if not in_default:
219                try:
220                    if warn:
221                        from meerschaum.utils.warnings import warn as _warn
222                        _warn(warning_msg, stacklevel=3, color=False)
223                except Exception as e:
224                    if warn:
225                        print(warning_msg)
226                if as_tuple:
227                    return False, None
228                return None
229
230            ### Don't write keys that we haven't yet loaded into memory.
231            not_loaded_keys = [k for k in patched_default_config if k not in config]
232            for k in not_loaded_keys:
233                patched_default_config.pop(k, None)
234
235            set_config(
236                apply_patch_to_config(
237                    patched_default_config,
238                    config,
239                )
240            )
241            if patch and keys[0] != symlinks_key:
242                if write_missing:
243                    write_config(config, debug=debug)
244
245    if as_tuple:
246        return (not invalid_keys), c
247    return c

 60class Pipe:
 61    """
 62    Access Meerschaum pipes via Pipe objects.
 63    
 64    Pipes are identified by the following:
 65
 66    1. Connector keys (e.g. `'sql:main'`)
 67    2. Metric key (e.g. `'weather'`)
 68    3. Location (optional; e.g. `None`)
 69    
 70    A pipe's connector keys correspond to a data source, and when the pipe is synced,
 71    its `fetch` definition is evaluated and executed to produce new data.
 72    
 73    Alternatively, new data may be directly synced via `pipe.sync()`:
 74    
 75    ```
 76    >>> from meerschaum import Pipe
 77    >>> pipe = Pipe('csv', 'weather')
 78    >>>
 79    >>> import pandas as pd
 80    >>> df = pd.read_csv('weather.csv')
 81    >>> pipe.sync(df)
 82    ```
 83    """
 84
 85    from ._fetch import (
 86        fetch,
 87        get_backtrack_interval,
 88    )
 89    from ._data import (
 90        get_data,
 91        get_backtrack_data,
 92        get_rowcount,
 93        _get_data_as_iterator,
 94        get_chunk_interval,
 95        get_chunk_bounds,
 96    )
 97    from ._register import register
 98    from ._attributes import (
 99        attributes,
100        parameters,
101        columns,
102        dtypes,
103        get_columns,
104        get_columns_types,
105        get_indices,
106        tags,
107        get_id,
108        id,
109        get_val_column,
110        parents,
111        children,
112        target,
113        _target_legacy,
114        guess_datetime,
115    )
116    from ._show import show
117    from ._edit import edit, edit_definition, update
118    from ._sync import (
119        sync,
120        get_sync_time,
121        exists,
122        filter_existing,
123        _get_chunk_label,
124        get_num_workers,
125        _persist_new_json_columns,
126        _persist_new_numeric_columns,
127    )
128    from ._verify import (
129        verify,
130        get_bound_interval,
131        get_bound_time,
132    )
133    from ._delete import delete
134    from ._drop import drop
135    from ._clear import clear
136    from ._deduplicate import deduplicate
137    from ._bootstrap import bootstrap
138    from ._dtypes import enforce_dtypes, infer_dtypes
139    from ._copy import copy_to
140
141    def __init__(
142        self,
143        connector: str = '',
144        metric: str = '',
145        location: Optional[str] = None,
146        parameters: Optional[Dict[str, Any]] = None,
147        columns: Union[Dict[str, str], List[str], None] = None,
148        tags: Optional[List[str]] = None,
149        target: Optional[str] = None,
150        dtypes: Optional[Dict[str, str]] = None,
151        instance: Optional[Union[str, InstanceConnector]] = None,
152        temporary: bool = False,
153        mrsm_instance: Optional[Union[str, InstanceConnector]] = None,
154        cache: bool = False,
155        debug: bool = False,
156        connector_keys: Optional[str] = None,
157        metric_key: Optional[str] = None,
158        location_key: Optional[str] = None,
159    ):
160        """
161        Parameters
162        ----------
163        connector: str
164            Keys for the pipe's source connector, e.g. `'sql:main'`.
165
166        metric: str
167            Label for the pipe's contents, e.g. `'weather'`.
168
169        location: str, default None
170            Label for the pipe's location. Defaults to `None`.
171
172        parameters: Optional[Dict[str, Any]], default None
173            Optionally set a pipe's parameters from the constructor,
174            e.g. columns and other attributes.
175            You can edit these parameters with `edit pipes`.
176
177        columns: Optional[Dict[str, str]], default None
178            Set the `columns` dictionary of `parameters`.
179            If `parameters` is also provided, this dictionary is added under the `'columns'` key.
180
181        tags: Optional[List[str]], default None
182            A list of strings to be added under the `'tags'` key of `parameters`.
183            You can select pipes with certain tags using `--tags`.
184
185        dtypes: Optional[Dict[str, str]], default None
186            Set the `dtypes` dictionary of `parameters`.
187            If `parameters` is also provided, this dictionary is added under the `'dtypes'` key.
188
189        mrsm_instance: Optional[Union[str, InstanceConnector]], default None
190            Connector for the Meerschaum instance where the pipe resides.
191            Defaults to the preconfigured default instance (`'sql:main'`).
192
193        instance: Optional[Union[str, InstanceConnector]], default None
194            Alias for `mrsm_instance`. If `mrsm_instance` is supplied, this value is ignored.
195
196        temporary: bool, default False
197            If `True`, prevent instance tables (pipes, users, plugins) from being created.
198
199        cache: bool, default False
200            If `True`, cache fetched data into a local database file.
201            Defaults to `False`.
202        """
203        from meerschaum.utils.warnings import error, warn
204        if (not connector and not connector_keys) or (not metric and not metric_key):
205            error(
206                "Please provide strings for the connector and metric\n    "
207                + "(first two positional arguments)."
208            )
209
210        ### Fall back to legacy `location_key` just in case.
211        if not location:
212            location = location_key
213
214        if not connector:
215            connector = connector_keys
216
217        if not metric:
218            metric = metric_key
219
220        if location in ('[None]', 'None'):
221            location = None
222
223        from meerschaum.config.static import STATIC_CONFIG
224        negation_prefix = STATIC_CONFIG['system']['fetch_pipes_keys']['negation_prefix']
225        for k in (connector, metric, location, *(tags or [])):
226            if str(k).startswith(negation_prefix):
227                error(f"A pipe's keys and tags cannot start with the prefix '{negation_prefix}'.")
228
229        self.connector_keys = str(connector)
230        self.connector_key = self.connector_keys ### Alias
231        self.metric_key = metric
232        self.location_key = location
233        self.temporary = temporary
234
235        self._attributes = {
236            'connector_keys': self.connector_keys,
237            'metric_key': self.metric_key,
238            'location_key': self.location_key,
239            'parameters': {},
240        }
241
242        ### only set parameters if values are provided
243        if isinstance(parameters, dict):
244            self._attributes['parameters'] = parameters
245        else:
246            if parameters is not None:
247                warn(f"The provided parameters are of invalid type '{type(parameters)}'.")
248            self._attributes['parameters'] = {}
249
250        columns = columns or self._attributes.get('parameters', {}).get('columns', {})
251        if isinstance(columns, list):
252            columns = {str(col): str(col) for col in columns}
253        if isinstance(columns, dict):
254            self._attributes['parameters']['columns'] = columns
255        elif columns is not None:
256            warn(f"The provided columns are of invalid type '{type(columns)}'.")
257
258        if isinstance(tags, (list, tuple)):
259            self._attributes['parameters']['tags'] = tags
260        elif tags is not None:
261            warn(f"The provided tags are of invalid type '{type(tags)}'.")
262
263        if isinstance(target, str):
264            self._attributes['parameters']['target'] = target
265        elif target is not None:
266            warn(f"The provided target is of invalid type '{type(target)}'.")
267
268        if isinstance(dtypes, dict):
269            self._attributes['parameters']['dtypes'] = dtypes
270        elif dtypes is not None:
271            warn(f"The provided dtypes are of invalid type '{type(dtypes)}'.")
272
273        ### NOTE: The parameters dictionary is {} by default.
274        ###       A Pipe may be registered without parameters, then edited,
275        ###       or a Pipe may be registered with parameters set in-memory first.
276        #  from meerschaum.config import get_config
277        _mrsm_instance = mrsm_instance if mrsm_instance is not None else instance
278        if _mrsm_instance is None:
279            _mrsm_instance = get_config('meerschaum', 'instance', patch=True)
280
281        if not isinstance(_mrsm_instance, str):
282            self._instance_connector = _mrsm_instance
283            self.instance_keys = str(_mrsm_instance)
284        else: ### NOTE: must be SQL or API Connector for this work
285            self.instance_keys = _mrsm_instance
286
287        self._cache = cache and get_config('system', 'experimental', 'cache')
288
289
290    @property
291    def meta(self):
292        """
293        Return the four keys needed to reconstruct this pipe.
294        """
295        return {
296            'connector': self.connector_keys,
297            'metric': self.metric_key,
298            'location': self.location_key,
299            'instance': self.instance_keys,
300        }
301
302
303    def keys(self) -> List[str]:
304        """
305        Return the ordered keys for this pipe.
306        """
307        return {
308            key: val
309            for key, val in self.meta.items()
310            if key != 'instance'
311        }
312
313
314    @property
315    def instance_connector(self) -> Union[InstanceConnector, None]:
316        """
317        The connector to where this pipe resides.
318        May either be of type `meerschaum.connectors.sql.SQLConnector` or
319        `meerschaum.connectors.api.APIConnector`.
320        """
321        if '_instance_connector' not in self.__dict__:
322            from meerschaum.connectors.parse import parse_instance_keys
323            conn = parse_instance_keys(self.instance_keys)
324            if conn:
325                self._instance_connector = conn
326            else:
327                return None
328        return self._instance_connector
329
330    @property
331    def connector(self) -> Union[meerschaum.connectors.Connector, None]:
332        """
333        The connector to the data source.
334        """
335        if '_connector' not in self.__dict__:
336            from meerschaum.connectors.parse import parse_instance_keys
337            import warnings
338            with warnings.catch_warnings():
339                warnings.simplefilter('ignore')
340                try:
341                    conn = parse_instance_keys(self.connector_keys)
342                except Exception as e:
343                    conn = None
344            if conn:
345                self._connector = conn
346            else:
347                return None
348        return self._connector
349
350
351    @property
352    def cache_connector(self) -> Union[meerschaum.connectors.sql.SQLConnector, None]:
353        """
354        If the pipe was created with `cache=True`, return the connector to the pipe's
355        SQLite database for caching.
356        """
357        if not self._cache:
358            return None
359
360        if '_cache_connector' not in self.__dict__:
361            from meerschaum.connectors import get_connector
362            from meerschaum.config._paths import DUCKDB_RESOURCES_PATH, SQLITE_RESOURCES_PATH
363            _resources_path = SQLITE_RESOURCES_PATH
364            self._cache_connector = get_connector(
365                'sql', '_cache_' + str(self),
366                flavor='sqlite',
367                database=str(_resources_path / ('_cache_' + str(self) + '.db')),
368            )
369
370        return self._cache_connector
371
372
373    @property
374    def cache_pipe(self) -> Union['meerschaum.Pipe', None]:
375        """
376        If the pipe was created with `cache=True`, return another `meerschaum.Pipe` used to
377        manage the local data.
378        """
379        if self.cache_connector is None:
380            return None
381        if '_cache_pipe' not in self.__dict__:
382            from meerschaum.config._patch import apply_patch_to_config
383            from meerschaum.utils.sql import sql_item_name
384            _parameters = copy.deepcopy(self.parameters)
385            _fetch_patch = {
386                'fetch': ({
387                    'definition': (
388                        f"SELECT * FROM "
389                        + sql_item_name(
390                            str(self.target),
391                            self.instance_connector.flavor,
392                            self.instance_connector.get_pipe_schema(self),
393                        )
394                    ),
395                }) if self.instance_connector.type == 'sql' else ({
396                    'connector_keys': self.connector_keys,
397                    'metric_key': self.metric_key,
398                    'location_key': self.location_key,
399                })
400            }
401            _parameters = apply_patch_to_config(_parameters, _fetch_patch)
402            self._cache_pipe = Pipe(
403                self.instance_keys,
404                (self.connector_keys + '_' + self.metric_key + '_cache'),
405                self.location_key,
406                mrsm_instance = self.cache_connector,
407                parameters = _parameters,
408                cache = False,
409                temporary = True,
410            )
411
412        return self._cache_pipe
413
414
415    def __str__(self, ansi: bool=False):
416        return pipe_repr(self, ansi=ansi)
417
418
419    def __eq__(self, other):
420        try:
421            return (
422                isinstance(self, type(other))
423                and self.connector_keys == other.connector_keys
424                and self.metric_key == other.metric_key
425                and self.location_key == other.location_key
426                and self.instance_keys == other.instance_keys
427            )
428        except Exception as e:
429            return False
430
431    def __hash__(self):
432        ### Using an esoteric separator to avoid collisions.
433        sep = "[\"']"
434        return hash(
435            str(self.connector_keys) + sep
436            + str(self.metric_key) + sep
437            + str(self.location_key) + sep
438            + str(self.instance_keys) + sep
439        )
440
441    def __repr__(self, ansi: bool=True, **kw) -> str:
442        if not hasattr(sys, 'ps1'):
443            ansi = False
444
445        return pipe_repr(self, ansi=ansi, **kw)
446
447    def __pt_repr__(self):
448        from meerschaum.utils.packages import attempt_import
449        prompt_toolkit_formatted_text = attempt_import('prompt_toolkit.formatted_text', lazy=False)
450        return prompt_toolkit_formatted_text.ANSI(pipe_repr(self, ansi=True))
451
452    def __getstate__(self) -> Dict[str, Any]:
453        """
454        Define the state dictionary (pickling).
455        """
456        return {
457            'connector': self.connector_keys,
458            'metric': self.metric_key,
459            'location': self.location_key,
460            'parameters': self.parameters,
461            'instance': self.instance_keys,
462        }
463
464    def __setstate__(self, _state: Dict[str, Any]):
465        """
466        Read the state (unpickling).
467        """
468        self.__init__(**_state)
469
470
471    def __getitem__(self, key: str) -> Any:
472        """
473        Index the pipe's attributes.
474        If the `key` cannot be found`, return `None`.
475        """
476        if key in self.attributes:
477            return self.attributes.get(key, None)
478
479        aliases = {
480            'connector': 'connector_keys',
481            'connector_key': 'connector_keys',
482            'metric': 'metric_key',
483            'location': 'location_key',
484        }
485        aliased_key = aliases.get(key, None)
486        if aliased_key is not None:
487            return self.attributes.get(aliased_key, None)
488
489        property_aliases = {
490            'instance': 'instance_keys',
491            'instance_key': 'instance_keys',
492        }
493        aliased_key = property_aliases.get(key, None)
494        if aliased_key is not None:
495            key = aliased_key
496        return getattr(self, key, None)