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