import typing as t from threading import local if t.TYPE_CHECKING: import typing_extensions as te from .core import Context _local = local() @t.overload def get_current_context(silent: "te.Literal[False]" = False) -> "Context": ... @t.overload def get_current_context(silent: bool = ...) -> t.Optional["Context"]: ... def get_current_context(silent: bool = False) -> t.Optional["Context"]: """Returns the current click context. This can be used as a way to access the current context object from anywhere. This is a more implicit alternative to the :func:`pass_context` decorator. This function is primarily useful for helpers such as :func:`echo` which might be interested in changing its behavior based on the current context. To push the current context, :meth:`Context.scope` can be used. .. versionadded:: 5.0 :param silent: if set to `True` the return value is `None` if no context is available. The default behavior is to raise a :exc:`RuntimeError`. """ try: return t.cast("Context", _local.stack[-1]) except (AttributeError, IndexError) as e: if not silent: raise RuntimeError("There is no active click context.") from e return None def push_context(ctx: "Context") -> None: """Pushes a new context to the current stack.""" _local.__dict__.setdefault("stack", []).append(ctx) def pop_context() -> None: """Removes the top level from the stack.""" _local.stack.pop() def resolve_color_default(color: t.Optional[bool] = None) -> t.Optional[bool]: """Internal helper to get the default value of the color flag. If a value is passed it's returned unchanged, otherwise it's looked up from the current context. """ if color is not None: return color ctx = get_current_context(silent=True) if ctx is not None: return ctx.color return None
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 3.06 KB | 0644 |
|
_compat.py | File | 18.3 KB | 0644 |
|
_termui_impl.py | File | 23.5 KB | 0644 |
|
_textwrap.py | File | 1.32 KB | 0644 |
|
_winconsole.py | File | 7.68 KB | 0644 |
|
core.py | File | 111.41 KB | 0644 |
|
decorators.py | File | 18.28 KB | 0644 |
|
exceptions.py | File | 9.06 KB | 0644 |
|
formatting.py | File | 9.48 KB | 0644 |
|
globals.py | File | 1.92 KB | 0644 |
|
parser.py | File | 18.62 KB | 0644 |
|
py.typed | File | 0 B | 0644 |
|
shell_completion.py | File | 18.03 KB | 0644 |
|
termui.py | File | 27.66 KB | 0644 |
|
testing.py | File | 15.71 KB | 0644 |
|
types.py | File | 35.54 KB | 0644 |
|
utils.py | File | 19.82 KB | 0644 |
|