update todos

README.md

@@ -4,3 +4,7 @@ Input/Output/Error management for your python controllers with Swagger doc gener
 ## Presentation
 
 Hapic is in unstable and development mode. More information soon.
+
+## TODO references
+
+TODO can make reference to #X, this is github issues references.

hapic/context.py

@@ -29,7 +29,7 @@ class ContextInterface(object):
         raise NotImplementedError()
 
 
-# TODO: In extension
+# TODO: In extension, see #3
 class BottleContext(ContextInterface):
     def get_request_parameters(self, *args, **kwargs) -> RequestParameters:
         return RequestParameters(
@@ -58,7 +58,7 @@ class BottleContext(ContextInterface):
         error: ProcessValidationError,
         http_code: HTTPStatus=HTTPStatus.BAD_REQUEST,
     ) -> typing.Any:
-        # TODO
+        # TODO BS 20171010: Manage error schemas, see #4
         from hapic.hapic import _default_global_error_schema
         unmarshall = _default_global_error_schema.dump(error)
         if unmarshall.errors:
@@ -75,7 +75,3 @@ class BottleContext(ContextInterface):
             ],
             status=int(http_code),
         )
-
-    # FIXME: Pas generique, marche pas en plus :'(
-    def get_app(self):
-        return bottle.default_app()

hapic/decorator.py

@@ -3,7 +3,7 @@ import functools
 import typing
 from http import HTTPStatus
 
-# TODO BS 20171010: bottle specific !
+# TODO BS 20171010: bottle specific !  # see #5
 from bottle import HTTPResponse
 
 from hapic.data import HapicData
@@ -14,7 +14,7 @@ from hapic.processor import ProcessorInterface
 from hapic.processor import RequestParameters
 
 # TODO: Ensure usage of DECORATION_ATTRIBUTE_NAME is documented and
-# var names correctly choose.
+# var names correctly choose.  see #6
 DECORATION_ATTRIBUTE_NAME = '_hapic_decoration_token'
 
 
@@ -127,7 +127,7 @@ class InputControllerWrapper(InputOutputControllerWrapper):
         cls,
         func_kwargs: typing.Dict[str, typing.Any],
     ) -> HapicData:
-        # TODO: Permit other name than "hapic_data" ?
+        # TODO: Permit other name than "hapic_data" ? see #7
         try:
             return func_kwargs['hapic_data']
         except KeyError:
@@ -211,7 +211,7 @@ class OutputControllerWrapper(InputOutputControllerWrapper):
             return prepared_response
         except ProcessException:
             # TODO: ici ou ailleurs: il faut pas forcement donner le detail
-            # de l'erreur (mode debug par exemple)
+            # de l'erreur (mode debug par exemple)  see #8
             error_response = self.get_error_response(response)
             return error_response
 
@@ -245,7 +245,6 @@ class OutputBodyControllerWrapper(OutputControllerWrapper):
 
 
 class OutputHeadersControllerWrapper(OutputControllerWrapper):
-    # TODO: write me
     pass
 
 
@@ -364,8 +363,8 @@ class ExceptionHandlerControllerWrapper(ControllerWrapper):
                 func_kwargs,
             )
         except self.handled_exception_class as exc:
-            # TODO: error_dict configurable name
-            # TODO: Who assume error structure ? We have to rethink it
+            # TODO: error_dict configurable name, see #4
+            # TODO: Who assume error structure ? We have to rethink it, see #4
             error_dict = {
                 'error_message': str(exc),
             }

hapic/doc.py

@@ -21,7 +21,7 @@ def find_bottle_route(
     app: bottle.Bottle,
 ):
     if not app.routes:
-        # TODO BS 20171010: specialize exception
+        # TODO BS 20171010: specialize exception, see #9
         raise Exception('There is no routes in yout bottle app')
 
     reference = decorated_controller.reference
@@ -38,8 +38,8 @@ def find_bottle_route(
 
         if match_with_wrapper or match_with_wrapped or match_with_token:
             return route
-    # TODO BS 20171010: specialize exception
-    # TODO BS 20171010: Raise exception or print error ?
+    # TODO BS 20171010: specialize exception, see #9
+    # TODO BS 20171010: Raise exception or print error ? see #10
     raise Exception(
         'Decorated route "{}" was not found in bottle routes'.format(
             decorated_controller.name,
@@ -119,8 +119,8 @@ class DocGenerator(object):
         controllers: typing.List[DecoratedController],
         app,
     ) -> dict:
-        # TODO: Découper
-        # TODO: bottle specific code !
+        # TODO: Découper, see #11
+        # TODO: bottle specific code !, see #11
         if not app:
             app = bottle.default_app()
         else:

hapic/hapic.py

@@ -31,20 +31,15 @@ from hapic.processor import ProcessorInterface
 from hapic.processor import MarshmallowInputProcessor
 from hapic.processor import MarshmallowOutputProcessor
 
-# TODO: Gérer les erreurs avec schema
-# TODO: Gérer les erreurs avec schema: pouvoir le spécialiser
-# TODO: Gérer les cas ou c'est une liste la réponse (items, item_nb)
-# TODO: Confusion nommage body/json/forms
+# TODO: Gérer les cas ou c'est une liste la réponse (items, item_nb), see #12
+# TODO: Confusion nommage body/json/forms, see #13
 
 # _waiting = {}
 # _endpoints = {}
-# FIXME: Voir
 class ErrorResponseSchema(marshmallow.Schema):
     error_message = marshmallow.fields.String(required=True)
-
-
     error_details = marshmallow.fields.Dict(required=True)
-# FIXME: C'est un gros gros fake !
+
 _default_global_error_schema = ErrorResponseSchema()
 
 
@@ -62,7 +57,7 @@ class Hapic(object):
 
         self._context_getter = context_getter
 
-        # TODO: Permettre la surcharge des classes utilisés ci-dessous
+        # TODO: Permettre la surcharge des classes utilisés ci-dessous, see #14
 
     @property
     def controllers(self) -> typing.List[DecoratedController]:
@@ -74,8 +69,6 @@ class Hapic(object):
 
     def with_api_doc(self):
         def decorator(func):
-
-            # FIXME: casse ou casse pas le bis ?
             @functools.wraps(func)
             def wrapper(*args, **kwargs):
                 return func(*args, **kwargs)
@@ -292,8 +285,9 @@ class Hapic(object):
             return decoration.get_wrapper(func)
         return decorator
 
-    def generate_doc(self, app):  # FIXME: j'ai du tricher avec app
-        # FIXME @Damien bottle specific code !
+    def generate_doc(self, app):
+        # FIXME: j'ai du tricher avec app, see #11
+        # FIXME @Damien bottle specific code ! see #11
         # rendre ca generique
         app = app or self._context.get_app()
         doc_generator = DocGenerator()

setup.py

@@ -7,8 +7,8 @@ from os import path
 here = path.abspath(path.dirname(__file__))
 
 install_requires = [
-    # TODO: Bottle will be an extension in future
-    # TODO: marshmallow an extension too ?
+    # TODO: Bottle will be an extension in future, see #1
+    # TODO: marshmallow an extension too ? see #2
     'bottle',
     'marshmallow',
     'apispec',