Context Managers

CONTEXT MANAGERS MEMPHIS PYTHON

with CONTEXT MANAGERS

with CONTEXT MANAGERS When you need to do something before
and after your code runs.

try: … except: … finally: … CONTEXT MANAGERS Roughly replaces
the try… except…finally pattern.

# Opening a file # (handles opening and closing cleanly)
with open('example.txt') as f: print(f.read()) SOME EXAMPLES…

# Ensuring DB queries are atomic # (e.g. with Django's
ORM) from django.db import transaction with transaction.atomic(): user = User.objects.create(...) user.profile.update(...) user.profile.save() SOME EXAMPLES…

# When mocking (in tests): with patch('my.module.Class') as mock_class: instance
= mock_class() SOME EXAMPLES…

# In fabric tasks (see: fabfile.org) def list_dir(): with cd("/home/brad"):
run("ls -l") SOME EXAMPLES…

class Timed(): def __enter__(self): self.start = time() def __exit__(self, type,
value, traceback): self.end = time() with Timed(): print("sleeping for 2...") sleep(2) BUILD YOUR OWN!

from contextlib import contextmanager @contextmanager def timed(): start = time()
yield end = time() with timed(): print("sleeping for 2...") sleep(2) BUILD YOUR OWN!

from contextlib import contextmanager @contextmanager def timed(): start = time()
yield end = time() with timed(): print("sleeping for 2...") sleep(2) assert(False) # fails... WHOOPS, EXCEPTIONS

from contextlib import contextmanager @contextmanager def robust_timed(): start = time()
try: yield finally: end = time() with robust_timed(): print("sleeping for 2...") sleep(2) assert(False) # the timer finishes WHOOPS, EXCEPTIONS

def __exit__(self, type, value, traceback): # This code is guaranteed
to run print("type: {}".format(type)) print("value: {}".format(value)) print("traceback: {}".format(traceback)) self.end = time() total = self.end - self.start print(“End: {} (total: {})”.format( self.end, total)) with Timed(): print("sleeping for 2...") sleep(2) assert(False) # Timed will finish WHOOPS, EXCEPTIONS

with Timed() as timer: print("sleeping for 2...") sleep(2) t =
time() + timer.start() print("started {}s ago".format(t) sleep(2) SUPPORT FOR as

with Timed() as timer: print("sleeping for 2...") sleep(2) t =
time() - timer.start print("started {}s ago".format(t)) sleep(2) # within the Timed class def __enter__(self): self.start = time() return self SUPPORT FOR as

contextlib. ContextDecorator CONTEXT MANAGERS

from contextlib import ContextDecorator # Using the ContextDecorator allows us
to use # this as a decorator, too! class bettertimed(ContextDecorator): def __enter__(self): self.start = time() return self def __exit__(self, type, value, traceback): self.end = time() total = self.end - self.start THE CONTEXT DECORATOR CLASS

with bettertimed(): sleep(1) print("ok... ") sleep(1) @bettertimed() def slow_print(text): sleep(1)
print(text) sleep(1) slow_print('oh bother') THE CONTEXT DECORATOR CLASS

RESOURCES • http://preshing.com/20110920/the-python-with- statement-by-example/ • https://docs.python.org/3/library/ contextlib.html • Code: https://gist.github.com/bradmontgomery/
4f4934893388f971c6c5

Context Managers

Context Managers

Brad Montgomery

Transcript