1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# Copyright 2017 Alethea Katherine Flowers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import collections
import copy
import functools
from collections.abc import Sequence
from typing import Any, Callable, TypeVar, overload
from ._decorators import Func
from ._typing import Python
F = TypeVar("F", bound=Callable[..., Any])
_REGISTRY: collections.OrderedDict[str, Func] = collections.OrderedDict()
@overload
def session_decorator(__func: F) -> F:
...
@overload
def session_decorator(
__func: None = ...,
python: Python | None = ...,
py: Python | None = ...,
reuse_venv: bool | None = ...,
name: str | None = ...,
venv_backend: Any | None = ...,
venv_params: Any | None = ...,
tags: Sequence[str] | None = ...,
*,
default: bool = ...,
) -> Callable[[F], F]:
...
def session_decorator(
func: F | None = None,
python: Python | None = None,
py: Python | None = None,
reuse_venv: bool | None = None,
name: str | None = None,
venv_backend: Any | None = None,
venv_params: Any | None = None,
tags: Sequence[str] | None = None,
*,
default: bool = True,
) -> F | Callable[[F], F]:
"""Designate the decorated function as a session."""
# If `func` is provided, then this is the decorator call with the function
# being sent as part of the Python syntax (`@nox.session`).
# If `func` is None, however, then this is a plain function call, and it
# must return the decorator that ultimately is applied
# (`@nox.session(...)`).
#
# This is what makes the syntax with and without parentheses both work.
if func is None:
return functools.partial(
session_decorator,
python=python,
py=py,
reuse_venv=reuse_venv,
name=name,
venv_backend=venv_backend,
venv_params=venv_params,
tags=tags,
default=default,
)
if py is not None and python is not None:
raise ValueError(
"The py argument to nox.session is an alias for the python "
"argument, please only specify one."
)
if python is None:
python = py
final_name = name or func.__name__
fn = Func(
func,
python,
reuse_venv,
final_name,
venv_backend,
venv_params,
tags=tags,
default=default,
)
_REGISTRY[final_name] = fn
return fn
def get() -> collections.OrderedDict[str, Func]:
"""Return a shallow copy of the registry.
This ensures that the registry is not accidentally modified by
calling code that retrieves a registry and mutates it.
"""
return copy.copy(_REGISTRY)
|
