naming and comments

hapic/context.py

@@ -153,13 +153,22 @@ class BaseContext(ContextInterface):
         self,
         func: typing.Callable[..., typing.Any],
     ) -> typing.Callable[..., typing.Any]:
+        """
+        Return a decorator who catch exceptions raised during given function
+        execution and return a response built by the default error builder.
+
+        :param func: decorated function
+        :return: the decorator
+        """
         def decorator(*args, **kwargs):
             try:
                 return func(*args, **kwargs)
             except Exception as exc:
                 # Reverse list to read first user given exception before
                 # the hapic default Exception catch
-                handled = reversed(self._get_handled_exception_classes())
+                handled = reversed(
+                    self._get_handled_exception_class_and_http_codes(),
+                )
                 for handled_exception_class, http_code in handled:
                     # TODO BS 2018-05-04: How to be attentive to hierarchy ?
                     if isinstance(exc, handled_exception_class):
@@ -173,9 +182,14 @@ class BaseContext(ContextInterface):
 
         return decorator
 
-    def _get_handled_exception_classes(
+    def _get_handled_exception_class_and_http_codes(
         self,
     ) -> typing.List[typing.Tuple[typing.Type[Exception], int]]:
+        """
+        :return: A list of tuple where: thirst item of tuple is a exception
+        class and second tuple item is a http code. This list will be used by
+        `handle_exceptions_decorator_builder` decorator to catch exceptions.
+        """
         raise NotImplementedError()
 
     def _add_exception_class_to_catch(
@@ -183,4 +197,11 @@ class BaseContext(ContextInterface):
         exception_class: typing.Type[Exception],
         http_code: int,
     ) -> None:
+        """
+        Add an exception class to catch and matching http code. Will be used by
+        `handle_exceptions_decorator_builder` decorator to catch exceptions.
+        :param exception_class: exception class to catch
+        :param http_code: http code to use if this exception catched
+        :return:
+        """
         raise NotImplementedError()

hapic/ext/bottle/context.py

@@ -33,7 +33,7 @@ class BottleContext(BaseContext):
         app: bottle.Bottle,
         default_error_builder: ErrorBuilderInterface=None,
     ):
-        self._handled_exceptions = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
+        self._handled_exception_and_http_codes = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
         self.app = app
         self.default_error_builder = \
             default_error_builder or DefaultErrorBuilder()  # FDV
@@ -141,7 +141,9 @@ class BottleContext(BaseContext):
         exception_class: typing.Type[Exception],
         http_code: int,
     ) -> None:
-        self._handled_exceptions.append((exception_class, http_code))
+        self._handled_exception_and_http_codes.append(
+            (exception_class, http_code),
+        )
 
     def _install_exceptions_handler(self) -> None:
         self.app.install(self.handle_exceptions_decorator_builder)

hapic/ext/flask/context.py

@@ -33,7 +33,7 @@ class FlaskContext(BaseContext):
         app: Flask,
         default_error_builder: ErrorBuilderInterface=None,
     ):
-        self._handled_exceptions = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
+        self._handled_exception_and_http_codes = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
         self.app = app
         self.default_error_builder = \
             default_error_builder or DefaultErrorBuilder()  # FDV
@@ -164,5 +164,7 @@ class FlaskContext(BaseContext):
         exception_class: typing.Type[Exception],
         http_code: int,
     ) -> None:
-        self._handled_exceptions.append((exception_class, http_code))
+        self._handled_exception_and_http_codes.append(
+            (exception_class, http_code),
+        )
 

hapic/ext/pyramid/context.py

@@ -32,7 +32,7 @@ class PyramidContext(BaseContext):
         configurator: 'Configurator',
         default_error_builder: ErrorBuilderInterface = None,
     ):
-        self._handled_exceptions = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
+        self._handled_exception_and_http_codes = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
         self.configurator = configurator
         self.default_error_builder = \
             default_error_builder or DefaultErrorBuilder()  # FDV
@@ -188,4 +188,6 @@ class PyramidContext(BaseContext):
         exception_class: typing.Type[Exception],
         http_code: int,
     ) -> None:
-        self._handled_exceptions.append((exception_class, http_code))
+        self._handled_exception_and_http_codes.append(
+            (exception_class, http_code),
+        )

tests/base.py

@@ -31,7 +31,7 @@ class MyContext(BottleContext):
         fake_files_parameters=None,
     ) -> None:
         super().__init__(app=app)
-        self._handled_exceptions = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
+        self._handled_exception_and_http_codes = []  # type: typing.List[typing.Tuple[typing.Type[Exception], int]]  # nopep8
         self._exceptions_handler_installed = False
         self.fake_path_parameters = fake_path_parameters or {}
         self.fake_query_parameters = fake_query_parameters or MultiDict()
@@ -73,9 +73,11 @@ class MyContext(BottleContext):
     ) -> None:
         if not self._exceptions_handler_installed:
             self._install_exceptions_handler()
-        self._handled_exceptions.append((exception_class, http_code))
+        self._handled_exception_and_http_codes.append(
+            (exception_class, http_code),
+        )
 
-    def _get_handled_exception_classes(
+    def _get_handled_exception_class_and_http_codes(
         self,
     ) -> typing.List[typing.Tuple[typing.Type[Exception], int]]:
-        return self._handled_exceptions
+        return self._handled_exception_and_http_codes