GitLocker: The Coding Marketplace

Description:

morecontext 0.6.0

GitHub
| PyPI
| Issues
| Changelog
morecontext provides context managers for some common minor operations:
specifically, changing the current working directory, an object’s attribute, a
dict field, or an environment variable and then setting it back afterwards.
Sure, it’s easy enough to implement these on your own, but why bother doing
that over & over again when you can let this package do it for you once?
Type annotated! Fully tested!

Installation
morecontext requires Python 3.6 or higher. Just use pip for Python 3 (You have pip, right?) to install
morecontext:
python3 -m pip install morecontext

Examples
>>> import os
>>> import morecontext
>>> os.getcwd()
'/some/dir'
>>> with morecontext.dirchanged('/some/other/dir'):
... # Now we're in /some/other/dir
... os.getcwd()
...
'/some/other/dir'
>>> # Out of the `with`, back to /some/dir
>>> os.getcwd()
'/some/dir'

>>> d = {"foo": 42}
>>> with morecontext.itemset(d, "foo", "bar"):
... # d["foo"] == "bar" in here
... d["foo"]
... # If we change d["foo"] in here, it'll still be set back to 42 on exit
... d["foo"] = 3.14
...
'bar'
>>> # Out of the `with`, it's back to 42
>>> d["foo"]
42

API

Functions
All of the following context manager functions are defined with
contextlib.contextmanager, so they can be used as function decorators as
well. They also all return None on entry, so there’s no point in writing
“with dirchanged(path) as foo:”; just do “with dirchanged(path):”.
These functions are not thread-safe.
dirchanged(dirpath: Union[str, bytes, os.PathLike]) -> ContextManager[None]
Temporarily change the current working directory.
dirchanged(dirpath) returns a context manager. On entry, it stores the
current working directory path and then changes the current directory to
dirpath. On exit, it changes the current directory back to the stored
path.
dirrollback() -> ContextManager[None]
Save & restore the current working directory.
dirrollback() returns a context manager that stores the current working
directory on entry and changes back to that directory on exit.
attrset(obj: Any, name: str, value: Any) -> ContextManager[None]
Temporarily change the value of an object’s attribute.
attrset(obj, name, value) returns a context manager. On entry, it stores
the current value of the attribute of obj with name name, and then it
sets that attribute to value. On exit, it sets the attribute back to the
stored value.
If the given attribute is unset on entry, the context manager will unset it on
exit.
attrdel(obj: Any, name: str) -> ContextManager[None]
Temporarily unset an object’s attribute.
attrdel(obj, name) returns a context manager. On entry, it stores the
current value of the attribute of obj with name name, and then it
unsets that attribute. On exit, it sets the attribute back to the stored
value.
If the given attribute is unset on entry, the context manager will unset it on
exit.
attrrollback(obj: Any, name: str, copy: bool = False, deepcopy: bool = False) -> ContextManager[None]
Save & restore the value of an object’s attribute.
attrrollback(obj, name) returns a context manager that stores the value of
the attribute of obj with name name on entry and sets the attribute
back to that value on exit. If the given attribute is unset on entry, the
context manager will unset it on exit.
If copy is true, a shallow copy of the attribute will be saved & restored.
If deepcopy is true, a deep copy of the attribute will be saved & restored.
If both options are true, deepcopy takes precedence.
itemset(d: MutableMapping[K,V], key: K, value: V) -> ContextManager[None]
Temporarily change the value of a mapping’s entry.
itemset(d, key, value) returns a context manager. On entry, it stores the
current value of d[key], and then it sets that field to value. On
exit, it sets the field back to the stored value.
If the given field is unset on entry, the context manager will unset it on
exit.
itemdel(d: MutableMapping[K, Any], key: K) -> ContextManager[None]
Temporarily unset a mapping’s entry.
itemdel(d, key) returns a context manager. On entry, it stores the current
value of d[key], and then it unsets that field. On exit, it sets the field
back to the stored value.
If the given field is unset on entry, the context manager will unset it on
exit.
itemrollback(d: MutableMapping[K, Any], key: K, copy: bool = False, deepcopy: bool = False) -> ContextManager[None]
Save & restore the value of a mapping’s entry.
itemrollback(d, key) returns a context manager that stores the value of
d[key] on entry and sets the field back to that value on exit. If the
given field is unset on entry, the context manager will unset it on exit.
If copy is true, a shallow copy of the field will be saved & restored. If
deepcopy is true, a deep copy of the field will be saved & restored. If
both options are true, deepcopy takes precedence.
envset(name: str, value: str) -> ContextManager[None]
Temporarily set an environment variable.
envset(name, value) returns a context manager. On entry, it stores the
current value of the environment variable name, and then it sets that
environment variable to value. On exit, it sets the environment variable
back to the stored value.
If the given environment variable is unset on entry, the context manager will
unset it on exit.
envdel(name: str) -> ContextManager[None]
Temporarily unset an environment variable.
envdel(name) returns a context manager. On entry, it stores the current
value of the environment variable name, and then it unsets that environment
variable. On exit, it sets the environment variable back to the stored value.
If the given environment variable is unset on entry, the context manager will
unset it on exit.
envrollback(name: str) -> ContextManager[None]
Save & restore the value of an environment variable.
envrollback(name) returns a context manager that stores the value of the
environment variable name on entry and sets the environment variable back
to that value on exit. If the given environment variable is unset on entry,
the context manager will unset it on exit.
additem(lst: MutableSequence[T], value: T, prepend: bool = False) -> ContextManager[None]
Temporarily add a value to a sequence.
additem(lst, value) returns a context manager that appends value to the
sequence lst on entry and removes the last item (if any) in lst that
equals value on exit.
If prepend is true, value is instead prepended to lst on entry, and
the first item in lst that equals value is removed on exit.

Classes
class OpenClosable:
def open(self) -> None:
...

def close(self) -> None:
...
A base class for creating simple reentrant context managers. OpenClosable
defines __enter__ and __exit__ methods that keep track of the number of
nested with statements in effect and call the instance’s open() and
close() methods when entering & exiting the outermost with.
Subclasses should override open() and/or close() with the desired
code to run on entering & exiting the outermost with; the default
open() and close() methods defined by OpenClosable do nothing.