Share
Embed
Python Decorators: How Do You Even
All the hip frameworks have them, you see them scattered around your codebase, but what IS a decorator? In this talk, Bill Israel will cover the features of Python that make decorators possible, how they work under the hood, what they're good for, and how you can start writing your own.
Bill Israel
February 07, 2015
Transcript
93 slides
-
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) def create_user(): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201 -
@login_required def get_user_profile(): user = users.get(session.get('user_id') return jsonify(user=user.to_json())
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201 -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) def create_user(): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201 -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) -
def example(): print("I'm a function!") >>> f = example >>>
f() I'm a function! -
def example(): print("I'm a function!") >>> first_class(example) I'm a function!
def first_class(func): func() -
def example(): print("I'm a function!") >>> f = first_class2() >>>
f() I'm a function! def first_class2(): return example -
def first_class3(): msg = "I'm a function!" def example():
print(msg) example() -
def first_class3(): msg = "I'm a function!" def example():
print(msg) example() >>> first_class3() I'm a function! -
Nest functions inside of functions Save functions into variables Pass
functions as arguments Return functions from functions -
Return functions from functions Pass functions as arguments Nest functions
inside of functions Save functions into variables -
Return functions from functions Pass functions as arguments Nest functions
inside of functions Save functions into variables Decorators -
def decorator(func): def wrapper(): print("I'm a wrapper.") func() return
wrapper def example(): print("I'm a function!") -
def decorator(func): def wrapper(): print("I'm a wrapper.") func() return
wrapper def example(): print("I'm a function!") -
>>> wrapped = decorator(example) >>> wrapped() I'm a wrapper. I'm
a function! def decorator(func): def wrapper(): print("I'm a wrapper.") func() return wrapper def example(): print("I'm a function!") -
>>> wrapped = decorator(example) >>> wrapped() I'm a wrapper. I'm
a function! >>> wrapped = decorator(example) >>> wrapped() I'm a wrapper. I'm a function! -
>>> example = decorator(example) >>> example() I'm a wrapper. I'm
a function! >>> wrapped = decorator(example) >>> wrapped() I'm a wrapper. I'm a function! -
def decorator(f): def wrapper(): print("I'm a wrapper.") f() return
wrapper def example(): print("I'm a function!") example = decorator(example) -
def decorator(f): def wrapper(): print("I'm a wrapper.") f() return
wrapper def example(): print("I'm a function!") example = decorator(example) -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) -
def decorator(func): def wrapper(): user_id = session.get('user_id') if user_id is
None: return redirect('/login', code=302) func() return wrapper -
def login_required(func): def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id
is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
@login_required def get_user_profile(): user = users.get(session.get('user_id')) return jsonify(user=user.to_json()) def login_required(func):
def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
@login_required def get_user_profile(): user = users.get(session.get('user_id')) return jsonify(user=user.to_json()) def login_required(func):
def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
def create_new_user(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() newbie = users.create(**data) return jsonify(user=newbie.to_json()), 201 -
def create_new_user(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() newbie = users.create(**data) return jsonify(user=newbie.to_json()), 201 -
@login_required def create_new_user(): user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403)
data = request.get_json() newbie = users.create(**data) return jsonify(user=newbie.to_json()), 201 -
@login_required def create_new_user(): user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403)
data = request.get_json() newbie = users.create(**data) return jsonify(user=newbie.to_json()), 201 -
create_user = role_required('admin')(create_user) @role_required('admin') def create_user(): # ... OR decorator
= role_required('admin') create_user = decorator(create_user) ...is the same as... -
def admin_required(func): def wrapper(*args, **kwargs): user = users.get(session.get('user_id')) if
not user.has_role('admin'): abort(403) return func(*args, **kwargs) return wrapper -
def admin_required(): def decorator(func): def wrapper(*args, **kwargs): user =
users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) return func(*args, **kwargs) return wrapper return decorator -
def role_required(role): def decorator(func): def wrapper(*args, **kwargs): user =
users.get(session.get('user_id')) if not user.has_role(role): abort(403) return func(*args, **kwargs) return wrapper return decorator -
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data)
return jsonify(user=new_user.to_json()), 201 def role_required(role): def decorator(func): def wrapper(*args, **kwargs): user = users.get(session.get('user_id')) if not user.has_role(role): abort(403) return func(*args, **kwargs) return wrapper return decorator -
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data)
return jsonify(user=new_user.to_json()), 201 def role_required(role): def decorator(func): def wrapper(*args, **kwargs): user = users.get(session.get('user_id')) if not user.has_role(role): abort(403) return func(*args, **kwargs) return wrapper return decorator -
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data)
return jsonify(user=new_user.to_json()), 201 -
@login_required @role_required('admin') def create_user(): # ... ...is the same as...
create_user = login_required( role_required('admin')(create_user) ) -
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data)
return jsonify(user=new_user.to_json()), 201 -
@login_required def get_user_profile(): # ... def login_required(func): def wrapper(*args, **kwargs):
user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
@login_required def get_user_profile(): # ... >>> get_user_profile.__name__ def login_required(func): def
wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
@login_required def get_user_profile(): # ... >>> get_user_profile.__name__ 'wrapper' def login_required(func):
def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
def login_required(func): def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id
is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
from functools import wraps def login_required(func): @wraps(func) def wrapper(*args,
**kwargs): user_id = session.get(user_id) if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper -
from functools import wraps def login_required(func): @wraps(func) def wrapper(*args,
**kwargs): user_id = session.get(user_id) if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper @login_required def get_user_profile(): # ... -
from functools import wraps def login_required(func): @wraps(func) def wrapper(*args,
**kwargs): user_id = session.get(user_id) if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper @login_required def get_user_profile(): # ... >>> get_user_profile.__name__ -
from functools import wraps def login_required(func): @wraps(func) def wrapper(*args,
**kwargs): user_id = session.get(user_id) if user_id is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper @login_required def get_user_profile(): # ... >>> get_user_profile.__name__ ‘get_user_profile’ -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) def create_user(): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) user = users.get(session.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201 -
def get_user_profile(): user_id = session.get('user_id') if user_id is None: return
redirect('/login', code=302) user = users.get(user_id) return jsonify(user=user.to_json()) def create_user(): user_id = session.get('user_id') if user_id is None: return redirect('/login', code=302) user = users.get(g.get('user_id')) if not user.has_role('admin'): abort(403) data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201 -
def login_required(func): def wrapper(*args, **kwargs): user_id = session.get('user_id') if user_id
is None: return redirect('/login', code=302) return func(*args, **kwargs) return wrapper def role_required(role): def decorator(func): def wrapper(*args, **kwargs): user = users.get(session.get('user_id')) if not user.has_role(role): abort(403) return func(*args, **kwargs) return wrapper return decorator -
@login_required def get_user_profile(): user = users.get(session.get(‘user_id')) return jsonify(user=user.to_json())
@login_required @role_required('admin') def create_user(): data = request.get_json() new_user = users.create(**data) return jsonify(user=new_user.to_json()), 201