123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- # -*- coding: utf-8 -*-
- import json
- import re
- import typing
-
- try: # Python 3.5+
- from http import HTTPStatus
- except ImportError:
- from http import client as HTTPStatus
-
- import bottle
- from multidict import MultiDict
-
- from hapic.context import BaseContext
- from hapic.context import HandledException
- from hapic.context import RouteRepresentation
- from hapic.decorator import DecoratedController
- from hapic.decorator import DECORATION_ATTRIBUTE_NAME
- from hapic.exception import OutputValidationException
- from hapic.exception import NoRoutesException
- from hapic.exception import RouteNotFound
- from hapic.processor import RequestParameters
- from hapic.processor import ProcessValidationError
- from hapic.error import DefaultErrorBuilder
- from hapic.error import ErrorBuilderInterface
-
- # Bottle regular expression to locate url parameters
- BOTTLE_RE_PATH_URL = re.compile(r'<([^:<>]+)(?::[^<>]+)?>')
-
-
- class BottleContext(BaseContext):
- def __init__(
- self,
- app: bottle.Bottle,
- default_error_builder: ErrorBuilderInterface=None,
- debug: bool = False,
- ):
- self._handled_exceptions = [] # type: typing.List[HandledException] # nopep8
- self._exceptions_handler_installed = False
- self.app = app
- self.default_error_builder = \
- default_error_builder or DefaultErrorBuilder() # FDV
- self.debug = debug
-
- def get_request_parameters(self, *args, **kwargs) -> RequestParameters:
- path_parameters = dict(bottle.request.url_args)
- query_parameters = MultiDict(bottle.request.query.allitems())
- body_parameters = dict(bottle.request.json or {})
- form_parameters = MultiDict(bottle.request.forms.allitems())
- header_parameters = dict(bottle.request.headers)
- files_parameters = dict(bottle.request.files)
-
- return RequestParameters(
- path_parameters=path_parameters,
- query_parameters=query_parameters,
- body_parameters=body_parameters,
- form_parameters=form_parameters,
- header_parameters=header_parameters,
- files_parameters=files_parameters,
- )
-
- def get_response(
- self,
- response: str,
- http_code: int,
- mimetype: str='application/json',
- ) -> bottle.HTTPResponse:
- return bottle.HTTPResponse(
- body=response,
- headers=[
- ('Content-Type', mimetype),
- ],
- status=http_code,
- )
-
- def get_validation_error_response(
- self,
- error: ProcessValidationError,
- http_code: HTTPStatus=HTTPStatus.BAD_REQUEST,
- ) -> typing.Any:
- error_content = self.default_error_builder.build_from_validation_error(
- error,
- )
-
- # Check error
- dumped = self.default_error_builder.dump(error).data
- unmarshall = self.default_error_builder.load(dumped)
- if unmarshall.errors:
- raise OutputValidationException(
- 'Validation error during dump of error response: {}'.format(
- str(unmarshall.errors)
- )
- )
-
- return bottle.HTTPResponse(
- body=json.dumps(error_content),
- headers=[
- ('Content-Type', 'application/json'),
- ],
- status=int(http_code),
- )
-
- def find_route(
- self,
- decorated_controller: DecoratedController,
- ) -> RouteRepresentation:
- if not self.app.routes:
- raise NoRoutesException('There is no routes in your bottle app')
-
- reference = decorated_controller.reference
- for route in self.app.routes:
- route_token = getattr(
- route.callback,
- DECORATION_ATTRIBUTE_NAME,
- None,
- )
-
- match_with_wrapper = route.callback == reference.wrapper
- match_with_wrapped = route.callback == reference.wrapped
- match_with_token = route_token == reference.token
-
- if match_with_wrapper or match_with_wrapped or match_with_token:
- return RouteRepresentation(
- rule=self.get_swagger_path(route.rule),
- method=route.method.lower(),
- original_route_object=route,
- )
- # TODO BS 20171010: Raise exception or print error ? see #10
- raise RouteNotFound(
- 'Decorated route "{}" was not found in bottle routes'.format(
- decorated_controller.name,
- )
- )
-
- def get_swagger_path(self, contextualised_rule: str) -> str:
- return BOTTLE_RE_PATH_URL.sub(r'{\1}', contextualised_rule)
-
- def by_pass_output_wrapping(self, response: typing.Any) -> bool:
- if isinstance(response, bottle.HTTPResponse):
- return True
- return False
-
- def _add_exception_class_to_catch(
- self,
- exception_class: typing.Type[Exception],
- http_code: int,
- ) -> None:
- if not self._exceptions_handler_installed:
- self._install_exceptions_handler()
-
- self._handled_exceptions.append(
- HandledException(exception_class, http_code),
- )
-
- def _install_exceptions_handler(self) -> None:
- """
- Setup the bottle app to enable exception catching with internal
- hapic exception catcher.
- """
- self.app.install(self.handle_exceptions_decorator_builder)
-
- def _get_handled_exception_class_and_http_codes(
- self,
- ) -> typing.List[HandledException]:
- """
- See hapic.context.BaseContext#_get_handled_exception_class_and_http_codes # nopep8
- """
- return self._handled_exceptions
-
- def is_debug(self) -> bool:
- return self.debug
|