Выступление на PYCON RUSSIA 2015

1. Архитектура RESTful API на Pyramid
приёмы проектирования

2. Типичный проект
API
Mobile AppsAdmin Panel
Web Site
Background
Workers
Data Sources

3. Типичный проект
API
Mobile AppsAdmin Panel
Web Site
Background
Workers
Data Sources

4. Слои
Данные
Бизнес логика
Представление

5. Слои
Данные
Бизнес логика
Представление
Model
Controller
View

6. Слои
Данные
Бизнес логика
Представление
Model
Controller
View
Store
Resource
View

7. Resource

8. Resource
―Унифицированный интерфейс к данным

9. Resource
―Унифицированный интерфейс к данным
―Унифицированные исключения

10. Resource
―Унифицированный интерфейс к данным
―Унифицированные исключения
―Независимость от представления

11. Traversal

12. Traversal
child = parent['child']
assert child.__name__ == 'child'
assert child.__parent__ is parent

13. Traversal
child = parent['child']
assert child.__name__ == 'child'
assert child.__parent__ is parent
GET /users/1/
root['users']['1']

14. Traversal
child = parent['child']
assert child.__name__ == 'child'
assert child.__parent__ is parent
GET /users/1/ -> 404 Not Found
root['users']['1'] -> KeyError

15. Traversal
class Root(object):
""" API root resource """
def __getitem__(self, name):
if name == 'users':
return Users(name, self)
raise KeyError(name)
class Users(object):
""" Collection of users """
def __init__(self, name, parent):
self.__name__ = name
self.__parent__ = parent

16. TraversalKit
from traversalkit import Resource, DEC_ID
class Root(Resource): # /
""" API root resource """
@Root.mount('users') # /users/
class Users(Resource):
""" Collection of users """
@Users.mount_set(DEC_ID) # /users/{^[0-9]+$}/
class User(Resource):
""" Particular user """

17. Коллекции
class Articles(Resource):
def get_list(self, offset=0, limit=10):
pass
def get_map(self, ids):
pass
def create(self, title, body):
pass

18. Элементы
@Articles.mount_set(DEC_ID)
class Article(Resource):
def update(self, title, body):
pass
def delete(self):
pass

19. Загрузка элемента
from ..store import db
@Articles.mount_set(DEC_ID)
class Article(Resource):
__not_exist__ = db.NoResultFound
def on_init(self, data=None):
if data is None:
# Created via __getitem__
session = db.Session()
data = session
.query(db.Article)
.filter(db.Article.id == int(self.__name__))
.one()
self.data = data

20. Загрузка списка
from ..store import db
class Articles(Resource):
def get_list(self, offset=0, limit=50):
session = db.Session()
query = session
.query(db.Article)
.limit(limit)
.offset(offset)
.order_by(db.Article.created_at)
return [
self.get(str(item.id), item)
for item in query.all()
]

21. Иерархия
@Root.mount('articles') # All articles
class Articles(Resource):
""" Collection of articles """
@Article.mount('comments') # Article's comments
class Comments(Resource):
""" Collection of comments """

22. Иерархия
@Root.mount('articles') # All articles
@User.mount('articles') # User's articles
class Articles(Resource):
""" Collection of articles """
@Article.mount('comments') # Article's comments
@User.mount('comments') # User's comments
class Comments(Resource):
""" Collection of comments """

23. ACL
from pyramid.security import Allow, Everyone, Authenticated
class Articles(Resource):
__acl__ = [
(Allow, Everyone, 'read'),
(Allow, Authenticated, 'create'),
(Allow, 'group:moderators', ('update', 'delete')),
]
@Articles.mount_set(DEC_ID)
class Article(Resource):
def __acl__(self):
user_id = str(self.data.user_id)
return [(Allow, user_id, ('update', 'delete'))]

24. ACL
from pyramid.security import
Allow, Everyone, Authenticated, DENY_ALL
@Article.mount('comments')
class Comments(Resource):
__acl__ = [
(Allow, Everyone, 'read'),
(Allow, Authenticated, 'create'),
(Allow, 'group:moderators', ('update', 'delete')),
DENY_ALL, # Stop inheritance
]

25. Валидация
from .. import validation
class Articles(Resource, validation.Mixin):
@validation.set_schema(validation.schema.Article)
def create(self, title, body):
pass
def create_article(context, request):
article = context.validated.create(request.json)

26. Views
from pyramid.view import view_config
from ..resources import Articles
@view_config(context=Articles, request_method='GET',
permission='read')
def list_articles(context, request):
articles = context.validated.get_list(request.GET)
return {
'articles': articles,
}

27. Views
from pyramid.view import view_config
from ..resources import Articles
@view_config(context=Articles, request_method='GET',
permission='read')
def list_articles(context, request):
articles = context.validated.get_list(request.GET)
users = request.root['users'].get_map(
set(a.data.user_id for a in articles)
)
return {
'articles': articles,
'users': users,
}

28. Сериализация
class Article(Resource):
def __json__(self, *_):
return {
'id': self.data.id,
'title': self.data.title,
'body': self.data.body,
}

29. Обработка ошибок
from pyramid.view import view_config
from pyramid.security import NO_PERMISSION_REQUIRED
from ..resources import ResourceException
from ..validation import Invalid
@view_config(context=ResourceException,
permission=NO_PERMISSION_REQUIRED)
def resource_exception(context, request):
request.response.status_int = 400
return {'error': context}
@view_config(context=Invalid,
permission=NO_PERMISSION_REQUIRED)
def validation_exception(context, request):
request.response.status_int = 422
return {'error': context}

30. Обработка ошибок
400
422
Ошибка бизнес логики
Невалидные данные

31. Обработка ошибок
400
422
403
404
Ошибка бизнес логики
Невалидные данные
Нет прав доступа
Ресурса не существует

32. Обработка ошибок
400
422
403
404
405
Ошибка бизнес логики
Невалидные данные
Нет прав доступа
Ресурса не существует
Ошибка контекста

33. Обработка ошибок
400
422
403
404
405
500
Ошибка бизнес логики
Невалидные данные
Нет прав доступа
Ресурса не существует
Ошибка контекста
Всё сломалось

34. Тесты
Resource
View
WSGI

35. Тесты
Resource
View
WSGI
Бизнес логика, иерархия

36. Тесты
Resource
View
WSGI
Бизнес логика, иерархия
Валидация, связанные данные, сессия

37. Тесты
Resource
View
WSGI
Бизнес логика, иерархия
Валидация, связанные данные, сессия
Интеграция, ACL

38. Вопросы?