module documentation

Undocumented

Function get_current_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.
Function pop_context Removes the top level from the stack.
Function push_context Pushes a new context to the current stack.
Function resolve_color_default 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.
Variable _local Undocumented
def get_current_context(silent=False): (source)

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`.

Parameters
silent:boolUndocumented
Returns
t.Optional[Context]Undocumented
def pop_context(): (source)

Removes the top level from the stack.

def push_context(ctx): (source)

Pushes a new context to the current stack.

Parameters
ctx:ContextUndocumented
def resolve_color_default(color=None): (source)

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.

Parameters
color:t.Optional[bool]Undocumented
Returns
t.Optional[bool]Undocumented
_local = (source)

Undocumented