Source code for lair.config

"""
Config module for lair package
"""

import os
from pathlib import Path

import pandas as pd


###############
# Directories #
###############

# lair has no built-in data locations. Readers of a data archive take an
# explicit directory argument and otherwise fall back to a LAIR_* environment
# variable (see `get_data_dir`), e.g. LAIR_INVENTORY_DIR, LAIR_SOUNDING_DIR,
# LAIR_CARBONTRACKER_DIR, LAIR_GML_DIR.




def get_data_dir(env_var: str, path: str | os.PathLike | None = None) -> Path:
    """
    Resolve a data directory.

    Parameters
    ----------
    env_var : str
        Environment variable to fall back to, e.g. ``'LAIR_INVENTORY_DIR'``.
    path : str | os.PathLike, optional
        Explicit directory. Takes precedence over the environment variable.

    Returns
    -------
    Path
        The data directory.

    Raises
    ------
    ValueError
        If neither ``path`` nor the environment variable is set.
    """
    if path is None:
        path = os.environ.get(env_var)
    if not path:
        raise ValueError(
            f"No data directory given: pass it explicitly or set "
            f"the {env_var} environment variable."
        )
    return Path(path)



# LAIR
LAIR_DIR = os.path.dirname(__file__)

#: User Cache Directory
CACHE_DIR = os.getenv(
    "LAIR_CACHE_DIR", os.path.join(os.path.expanduser("~"), ".cache", "lair")
)
if not os.path.exists(CACHE_DIR):
    os.makedirs(CACHE_DIR)

##########
# PANDAS #
##########

#: Pandas copy-on-write
pandas_CoW = True
if int(pd.__version__.split(".")[0]) < 3:
    # Always on (and no longer settable) from pandas 3.0
    pd.options.mode.copy_on_write = pandas_CoW


###################
# Verbose Printer #
###################

#: Print progress messages (set ``lair.config.verbose = False`` to silence)
verbose = True  # FIXME


class _Printer:
    @staticmethod
    def vprint(*args, **kwargs):
        if verbose:
            print(*args, **kwargs, flush=True)


vprint = _Printer().vprint