session.pyi

"""Type stubs for nox_poetry.session."""
from pathlib import Path
from typing import Any
from typing import Callable
from typing import Dict
from typing import Iterable
from typing import List
from typing import Mapping
from typing import NoReturn
from typing import Optional
from typing import overload
from typing import Sequence
from typing import TypeVar
from typing import Union

import nox.sessions
import nox.virtualenv

from nox_poetry.poetry import DistributionFormat

class Session:
    _session: nox.Session
    def __init__(self, session: nox.Session) -> None: ...
    def install(self, *args: str, **kwargs: Any) -> None: ...
    def installroot(
        self, *, distribution_format: DistributionFormat, extras: Iterable[str] = ...
    ) -> None: ...
    def export_requirements(self) -> Path: ...
    def build_package(self, *, distribution_format: DistributionFormat) -> str: ...
    # delegated interface
    @property
    def env(self) -> Dict[str, str]: ...
    @property
    def posargs(self) -> List[str]: ...
    @property
    def virtualenv(self) -> nox.virtualenv.ProcessEnv: ...
    @property
    def python(self) -> Optional[Union[str, Sequence[str], bool]]: ...
    @property
    def bin_paths(self) -> Optional[List[str]]: ...
    @property
    def bin(self) -> Optional[str]: ...
    def create_tmp(self) -> str: ...
    @property
    def interactive(self) -> bool: ...
    def chdir(self, dir: str) -> None: ...
    def cd(self, dir: str) -> None: ...
    def run(
        self, *args: str, env: Optional[Mapping[str, str]] = ..., **kwargs: Any
    ) -> Optional[Any]: ...
    def run_always(
        self, *args: str, env: Optional[Mapping[str, str]] = ..., **kwargs: Any
    ) -> Optional[Any]: ...
    def conda_install(
        self, *args: str, auto_offline: bool = True, **kwargs: Any
    ) -> None: ...
    def notify(self, target: Union[str, nox.sessions.SessionRunner]) -> None: ...
    def log(self, *args: Any, **kwargs: Any) -> None: ...
    def error(self, *args: Any) -> NoReturn: ...
    def skip(self, *args: Any) -> NoReturn: ...

Python = Optional[Union[str, Sequence[str], bool]]
SessionFunction = Callable[[Session], None]
NoxSessionFunction = Callable[[nox.Session], None]
SessionDecorator = Callable[[SessionFunction], NoxSessionFunction]
@overload
def session(__func: SessionFunction) -> NoxSessionFunction: ...
@overload
def session(
    __func: None = ...,
    python: Python = ...,
    py: Python = ...,
    reuse_venv: Optional[bool] = ...,
    name: Optional[str] = ...,
    venv_backend: Any = ...,
    venv_params: Any = ...,
) -> SessionDecorator: ...