Welcome to jaraco.context documentation!¶
- class jaraco.context.ExceptionTrap(exceptions=(<class 'Exception'>, ))¶
Bases:
object
A context manager that will catch certain exceptions and provide an indication they occurred.
>>> with ExceptionTrap() as trap: ... raise Exception() >>> bool(trap) True
>>> with ExceptionTrap() as trap: ... pass >>> bool(trap) False
>>> with ExceptionTrap(ValueError) as trap: ... raise ValueError("1 + 1 is not 3") >>> bool(trap) True
>>> with ExceptionTrap(ValueError) as trap: ... raise Exception() Traceback (most recent call last): ... Exception
>>> bool(trap) False
- exc_info = (None, None, None)¶
- passes(func)¶
Wrap func and replace the result with the truth value of the trap (True if no exception).
First, give the decorator an alias to support Python 3.8 Syntax.
>>> passes = ExceptionTrap(ValueError).passes
Now decorate a function that always fails.
>>> @passes ... def fail(): ... raise ValueError('failed')
>>> fail() False
- raises(func, *, _test=<class 'bool'>)¶
Wrap func and replace the result with the truth value of the trap (True if an exception occurred).
First, give the decorator an alias to support Python 3.8 Syntax.
>>> raises = ExceptionTrap(ValueError).raises
Now decorate a function that always fails.
>>> @raises ... def fail(): ... raise ValueError('failed') >>> fail() True
- property tb¶
- property type¶
- property value¶
- jaraco.context.infer_compression(url)¶
Given a URL or filename, infer the compression code for tar.
- jaraco.context.null()¶
- jaraco.context.pushd(dir)¶
- jaraco.context.repo_context(url, branch=None, quiet=True, dest_ctx=<function temp_dir>)¶
Check out the repo indicated by url.
If dest_ctx is supplied, it should be a context manager to yield the target directory for the check out.
- class jaraco.context.suppress(*exceptions)¶
Bases:
contextlib.suppress
,contextlib.ContextDecorator
A version of contextlib.suppress with decorator support.
>>> @suppress(KeyError) ... def key_error(): ... {}[''] >>> key_error()
- jaraco.context.tarball_context(url, target_dir=None, runner=None, pushd=<function pushd>)¶
Get a tarball, extract it, change to that directory, yield, then clean up. runner is the function to invoke commands. pushd is a context manager for changing the directory.
- jaraco.context.temp_dir(remover=<function rmtree>)¶
Create a temporary directory context. Pass a custom remover to override the removal behavior.