xonsh/xontrib/autovox.py

"""
A framework for automatic vox.

This coordinates multiple automatic vox policies and deals with some of the
mechanics of venv searching and chdir handling.

This provides no interface for end users.

Developers should look at events.autovox_policy
"""
import itertools
from pathlib import Path
import xontrib.voxapi as voxapi
import warnings

__all__ = ()


_policies = []

events.doc(
    "autovox_policy",
    """
autovox_policy(path: pathlib.Path) -> Union[str, pathlib.Path, None]

Register a policy with autovox.

A policy is a function that takes a Path and returns the venv associated with it,
if any.

NOTE: The policy should only return a venv for this path exactly, not for
parent paths. Parent walking is handled by autovox so that all policies can
be queried at each level.
""",
)


class MultipleVenvsWarning(RuntimeWarning):
    pass


def get_venv(vox, dirpath):
    # Search up the directory tree until a venv is found, or none
    for path in itertools.chain((dirpath,), dirpath.parents):
        venvs = [
            vox[p]
            for p in events.autovox_policy.fire(path=path)
            if p is not None and p in vox  # Filter out venvs that don't exist
        ]
        if len(venvs) == 0:
            continue
        else:
            if len(venvs) > 1:
                warnings.warn(
                    MultipleVenvsWarning(
                        f"Found {len(venvs)} venvs for {path}; using the first"
                    )
                )
            return venvs[0]


def check_for_new_venv(curdir):
    vox = voxapi.Vox()
    try:
        oldve = vox[...]
    except KeyError:
        oldve = None
    newve = get_venv(vox, curdir)

    if oldve != newve:
        if newve is None:
            vox.deactivate()
        else:
            vox.activate(newve)


# Core mechanism: Check for venv when the current directory changes
@events.on_chdir
def cd_handler(newdir, **_):
    check_for_new_venv(Path(newdir))


# Recalculate when venvs are created or destroyed


@events.vox_on_create
def create_handler(**_):
    check_for_new_venv(Path.cwd())


@events.vox_on_destroy
def destroy_handler(**_):
    check_for_new_venv(Path.cwd())


# Initial activation before first prompt


@events.on_post_init
def load_handler(**_):
    check_for_new_venv(Path.cwd())