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
|
from typing import Any, Optional
from ._version import __version_info__, __version__ # noqa
from .collection import Collection # noqa
from .config import Config # noqa
from .context import Context, MockContext # noqa
from .exceptions import ( # noqa
AmbiguousEnvVar,
AuthFailure,
CollectionNotFound,
Exit,
ParseError,
PlatformError,
ResponseNotAccepted,
SubprocessPipeError,
ThreadException,
UncastableEnvVar,
UnexpectedExit,
UnknownFileType,
UnpicklableConfigMember,
WatcherError,
CommandTimedOut,
)
from .executor import Executor # noqa
from .loader import FilesystemLoader # noqa
from .parser import Argument, Parser, ParserContext, ParseResult # noqa
from .program import Program # noqa
from .runners import Runner, Local, Failure, Result, Promise # noqa
from .tasks import task, call, Call, Task # noqa
from .terminals import pty_size # noqa
from .watchers import FailingResponder, Responder, StreamWatcher # noqa
def run(command: str, **kwargs: Any) -> Optional[Result]:
"""
Run ``command`` in a subprocess and return a `.Result` object.
See `.Runner.run` for API details.
.. note::
This function is a convenience wrapper around Invoke's `.Context` and
`.Runner` APIs.
Specifically, it creates an anonymous `.Context` instance and calls its
`~.Context.run` method, which in turn defaults to using a `.Local`
runner subclass for command execution.
.. versionadded:: 1.0
"""
return Context().run(command, **kwargs)
def sudo(command: str, **kwargs: Any) -> Optional[Result]:
"""
Run ``command`` in a ``sudo`` subprocess and return a `.Result` object.
See `.Context.sudo` for API details, such as the ``password`` kwarg.
.. note::
This function is a convenience wrapper around Invoke's `.Context` and
`.Runner` APIs.
Specifically, it creates an anonymous `.Context` instance and calls its
`~.Context.sudo` method, which in turn defaults to using a `.Local`
runner subclass for command execution (plus sudo-related bits &
pieces).
.. versionadded:: 1.4
"""
return Context().sudo(command, **kwargs)
|
