def route()

in src/lambdas/modular_api_handler/processors/abstract_processor.py [0:0]

• 23 lines of code
• 3 McCabe index (conditional complexity)

    def route(cls, path: Endpoint, method: tuple[HTTPMethod, ...] | HTTPMethod,
              action: str, permission: Permission | None,
              summary: str | None = None,
              description: str | None = None,
              response: list[Resp] | Resp = (HTTPStatus.OK, None, None),
              require_auth: bool = True
              ) -> Route:
        """
        Just auxiliary method
        :param path:
        :param method:
        :param action: name of method to be executed for this route
        :param permission: target permission for this route, should be 
        explicitly set to None in case we want this endpoint to be 
        require no permissions
        :param summary:
        :param description:
        :param response: list of tuples with three elements: code, optional
        model and optional response description
        :param require_auth:
        :return:
        """
        if isinstance(method, HTTPMethod):
            method = (method,)
        if isinstance(response, tuple):
            response = [response]
        return Route(
            name=None,
            routepath=path.value,
            controller=cls.controller_name(),
            action=action,
            conditions={'method': method},
            # custom kwargs
            _summary=summary,
            _description=description,
            _responses=response,
            _require_auth=require_auth,
            _permission=permission
        )