PK!flama/__init__.pyPK! S| flama/applications.pyimport typing from starlette.applications import Starlette from starlette.exceptions import ExceptionMiddleware from starlette.middleware.errors import ServerErrorMiddleware from starlette.types import ASGIApp from flama import exceptions from flama.components import Component from flama.exceptions import HTTPException from flama.http import Request, Response from flama.injection import Injector from flama.responses import APIErrorResponse from flama.routing import Router from flama.schemas import SchemaMixin if typing.TYPE_CHECKING: from flama.resources import BaseResource __all__ = ["Flama"] class Flama(Starlette, SchemaMixin): def __init__( self, components: typing.Optional[typing.List[Component]] = None, debug: bool = False, title: typing.Optional[str] = "", version: typing.Optional[str] = "", description: typing.Optional[str] = "", schema: typing.Optional[str] = "/schema/", docs: typing.Optional[str] = "/docs/", redoc: typing.Optional[str] = None, *args, **kwargs ) -> None: super().__init__(debug=debug, *args, **kwargs) if components is None: components = [] # Initialize injector self.components = components self.router = Router(components=components) self.app = self.router self.exception_middleware = ExceptionMiddleware(self.router, debug=debug) self.error_middleware = ServerErrorMiddleware(self.exception_middleware, debug=debug) # Add exception handler for API exceptions self.add_exception_handler(exceptions.HTTPException, self.api_http_exception_handler) # Add schema and docs routes self.add_schema_docs_routes( title=title, version=version, description=description, schema=schema, docs=docs, redoc=redoc ) @property def injector(self): return Injector(components=self.components) def mount(self, path: str, app: ASGIApp, name: str = None) -> None: self.components += getattr(app, "components", []) self.router.mount(path, app=app, name=name) def add_resource(self, path: str, resource: "BaseResource"): self.router.add_resource(path, resource=resource) def resource(self, path: str) -> typing.Callable: def decorator(resource: "BaseResource") -> "BaseResource": self.router.add_resource(path, resource=resource) return resource return decorator def api_http_exception_handler(self, request: Request, exc: HTTPException) -> Response: return APIErrorResponse(detail=exc.detail, status_code=exc.status_code, exception=exc) PK!y~~flama/codecs/__init__.pyfrom flama.codecs.base import * # noqa from flama.codecs.http import * # noqa from flama.codecs.websockets import * # noqa PK!~flama/codecs/base.pyimport typing from flama import http, websockets class Codec: async def decode(self, item: typing.Any, **options): raise NotImplementedError() async def encode(self, item: typing.Any, **options): raise NotImplementedError() class HTTPCodec(Codec): media_type = None async def decode(self, request: http.Request, **options): raise NotImplementedError() async def encode(self, item: typing.Any, **options): raise NotImplementedError() class WebsocketsCodec(Codec): encoding = None async def decode(self, item: websockets.Message, **options): raise NotImplementedError() async def encode(self, item: typing.Any, **options): raise NotImplementedError() PK!xXflama/codecs/http/__init__.pyfrom flama.codecs.http.jsondata import JSONDataCodec # noqa from flama.codecs.http.multipart import MultiPartCodec # noqa from flama.codecs.http.urlencoded import URLEncodedCodec # noqa PK! |Kflama/codecs/http/jsondata.pyfrom flama import exceptions, http from flama.codecs.base import HTTPCodec __all__ = ["JSONDataCodec"] class JSONDataCodec(HTTPCodec): media_type = "application/json" format = "json" async def decode(self, request: http.Request, **options): try: if await request.body() == b"": return None return await request.json() except ValueError as exc: raise exceptions.DecodeError(f"Malformed JSON. {exc}") from None PK!B  flama/codecs/http/multipart.pyfrom flama import http from flama.codecs.base import HTTPCodec __all__ = ["MultiPartCodec"] class MultiPartCodec(HTTPCodec): media_type = "multipart/form-data" async def decode(self, request: http.Request, **options): return await request.form() PK!5""flama/codecs/http/urlencoded.pyfrom flama import http from flama.codecs.base import HTTPCodec __all__ = ["URLEncodedCodec"] class URLEncodedCodec(HTTPCodec): media_type = "application/x-www-form-urlencoded" async def decode(self, request: http.Request, **options): return await request.form() or None PK!pvy#flama/codecs/websockets/__init__.pyfrom flama.codecs.websockets.bytes import BytesCodec from flama.codecs.websockets.json import JSONCodec from flama.codecs.websockets.text import TextCodec __all__ = ["BytesCodec", "TextCodec", "JSONCodec"] PK! - flama/codecs/websockets/bytes.pyfrom flama import exceptions, websockets from flama.codecs.base import WebsocketsCodec __all__ = ["BytesCodec"] class BytesCodec(WebsocketsCodec): encoding = "bytes" async def decode(self, message: websockets.Message, **options): if "bytes" not in message: raise exceptions.DecodeError("Expected bytes websocket messages") return message["bytes"] PK!:%55flama/codecs/websockets/json.pyimport json from flama import exceptions, websockets from flama.codecs.base import WebsocketsCodec __all__ = ["JSONCodec"] class JSONCodec(WebsocketsCodec): encoding = "json" async def decode(self, message: websockets.Message, **options): if message.get("text") is not None: text = message["text"] else: text = message["bytes"].decode("utf-8") try: return json.loads(text) except json.decoder.JSONDecodeError: raise exceptions.DecodeError("Malformed JSON data received") PK!H~~flama/codecs/websockets/text.pyfrom flama import exceptions, websockets from flama.codecs.base import WebsocketsCodec __all__ = ["TextCodec"] class TextCodec(WebsocketsCodec): encoding = "text" async def decode(self, message: websockets.Message, **options): if "text" not in message: raise exceptions.DecodeError("Expected text websocket messages") return message["text"] PK!44flama/components/__init__.pyfrom flama.components.base import Component # noqa PK!%]c[ flama/components/asgi.pyimport typing from inspect import Parameter from urllib.parse import parse_qsl from flama import http from flama.components import Component ASGIScope = typing.NewType("ASGIScope", dict) ASGIReceive = typing.NewType("ASGIReceive", typing.Callable) ASGISend = typing.NewType("ASGISend", typing.Callable) class MethodComponent(Component): def resolve(self, scope: ASGIScope) -> http.Method: return http.Method(scope["method"]) class URLComponent(Component): def resolve(self, scope: ASGIScope) -> http.URL: return http.URL(scope=scope) class SchemeComponent(Component): def resolve(self, scope: ASGIScope) -> http.Scheme: return http.Scheme(scope["scheme"]) class HostComponent(Component): def resolve(self, scope: ASGIScope) -> http.Host: return http.Host(scope["server"][0]) class PortComponent(Component): def resolve(self, scope: ASGIScope) -> http.Port: return http.Port(scope["server"][1]) class PathComponent(Component): def resolve(self, scope: ASGIScope) -> http.Path: return http.Path(scope.get("root_path", "") + scope["path"]) class QueryStringComponent(Component): def resolve(self, scope: ASGIScope) -> http.QueryString: return http.QueryString(scope["query_string"].decode()) class QueryParamsComponent(Component): def resolve(self, scope: ASGIScope) -> http.QueryParams: query_string = scope["query_string"].decode() return http.QueryParams(parse_qsl(query_string)) class QueryParamComponent(Component): def resolve(self, parameter: Parameter, query_params: http.QueryParams) -> http.QueryParam: name = parameter.name if name not in query_params: return None return http.QueryParam(query_params[name]) class HeadersComponent(Component): def resolve(self, scope: ASGIScope) -> http.Headers: return http.Headers(scope=scope) class HeaderComponent(Component): def resolve(self, parameter: Parameter, headers: http.Headers) -> http.Header: name = parameter.name.replace("_", "-") if name not in headers: return None return http.Header(headers[name]) class BodyComponent(Component): async def resolve(self, receive: ASGIReceive) -> http.Body: body = b"" while True: message = await receive() if not message["type"] == "http.request": raise Exception(f"Unexpected ASGI message type '{message['type']}'.") body += message.get("body", b"") if not message.get("more_body", False): break return http.Body(body) ASGI_COMPONENTS = ( MethodComponent(), URLComponent(), SchemeComponent(), HostComponent(), PortComponent(), PathComponent(), QueryStringComponent(), QueryParamsComponent(), QueryParamComponent(), HeadersComponent(), HeaderComponent(), BodyComponent(), ) PK!vS  flama/components/base.pyimport inspect from abc import ABCMeta, abstractmethod from flama import exceptions class Component(metaclass=ABCMeta): def identity(self, parameter: inspect.Parameter) -> str: """ Each component needs a unique identifier string that we use for lookups from the `state` dictionary when we run the dependency injection. :param parameter: The parameter to check if that component can handle it. :return: Unique identifier. """ parameter_name = parameter.name.lower() try: annotation_name = parameter.annotation.__name__.lower() except AttributeError: annotation_name = parameter.annotation.__args__[0].__name__.lower() # If `resolve_parameter` includes `Parameter` then we use an identifier that is additionally parameterized by # the parameter name. args = inspect.signature(self.resolve).parameters.values() if inspect.Parameter in [arg.annotation for arg in args]: return annotation_name + ":" + parameter_name # Standard case is to use the class name, lowercased. return annotation_name def can_handle_parameter(self, parameter: inspect.Parameter) -> bool: """ The default behavior is for components to handle whatever class is used as the return annotation by the `resolve` method. You can override this for more customized styles, for example if you wanted name-based parameter resolution, or if you want to provide a value for a range of different types. Eg. Include the `Request` instance for any parameter named `request`. :param parameter: The parameter to check if that component can handle it. :return: True if this component can handle the given parameter. """ return_annotation = inspect.signature(self.resolve).return_annotation if return_annotation is inspect.Signature.empty: msg = ( f'Component "{self.__class__.__name__}" must include a return annotation on the `resolve()` method, or ' f"override `can_handle_parameter`" ) raise exceptions.ConfigurationError(msg) return parameter.annotation is return_annotation @abstractmethod def resolve(self): pass PK!ptΝflama/components/validation.pyimport datetime import inspect import typing import uuid import marshmallow from starlette import status from flama import codecs, exceptions, http, websockets from flama.components import Component from flama.exceptions import WebSocketException from flama.negotiation import ContentTypeNegotiator, WebSocketEncodingNegotiator from flama.routing import Route from flama.types import OptBool, OptDate, OptDateTime, OptFloat, OptInt, OptStr, OptUUID ValidatedPathParams = typing.NewType("ValidatedPathParams", dict) ValidatedQueryParams = typing.NewType("ValidatedQueryParams", dict) ValidatedRequestData = typing.TypeVar("ValidatedRequestData") class RequestDataComponent(Component): def __init__(self): self.negotiator = ContentTypeNegotiator( [codecs.JSONDataCodec(), codecs.URLEncodedCodec(), codecs.MultiPartCodec()] ) def can_handle_parameter(self, parameter: inspect.Parameter): return parameter.annotation is http.RequestData async def resolve(self, request: http.Request): content_type = request.headers.get("Content-Type") try: codec = self.negotiator.negotiate(content_type) except exceptions.NoCodecAvailable: raise exceptions.HTTPException(415) try: return await codec.decode(request) except exceptions.DecodeError as exc: raise exceptions.HTTPException(400, detail=str(exc)) class WebSocketMessageDataComponent(Component): def __init__(self): self.negotiator = WebSocketEncodingNegotiator([codecs.BytesCodec(), codecs.TextCodec(), codecs.JSONCodec()]) def can_handle_parameter(self, parameter: inspect.Parameter): return parameter.annotation is websockets.Data async def resolve(self, message: websockets.Message, websocket_encoding: websockets.Encoding): try: codec = self.negotiator.negotiate(websocket_encoding) return await codec.decode(message) except (exceptions.NoCodecAvailable, exceptions.DecodeError): raise WebSocketException(close_code=status.WS_1003_UNSUPPORTED_DATA) class ValidatePathParamsComponent(Component): async def resolve(self, request: http.Request, route: Route, path_params: http.PathParams) -> ValidatedPathParams: validator = type( "Validator", (marshmallow.Schema,), {f.name: f.schema for f in route.path_fields[request.method].values()} ) try: path_params = validator().load(path_params) except marshmallow.ValidationError as exc: raise exceptions.InputValidationError(detail=exc.normalized_messages()) return ValidatedPathParams(path_params) class ValidateQueryParamsComponent(Component): def resolve(self, request: http.Request, route: Route, query_params: http.QueryParams) -> ValidatedQueryParams: validator = type( "Validator", (marshmallow.Schema,), {f.name: f.schema for f in route.query_fields[request.method].values()} ) try: query_params = validator().load(dict(query_params), unknown=marshmallow.EXCLUDE) except marshmallow.ValidationError as exc: raise exceptions.InputValidationError(detail=exc.normalized_messages()) return ValidatedQueryParams(query_params) class ValidateRequestDataComponent(Component): def can_handle_parameter(self, parameter: inspect.Parameter): return parameter.annotation is ValidatedRequestData def resolve(self, request: http.Request, route: Route, data: http.RequestData): if not route.body_field[request.method] or not route.body_field[request.method].schema: return data validator = route.body_field[request.method].schema try: return validator.load(data) except marshmallow.ValidationError as exc: raise exceptions.InputValidationError(detail=exc.normalized_messages()) class PrimitiveParamComponent(Component): def can_handle_parameter(self, parameter: inspect.Parameter): return parameter.annotation in ( str, int, float, bool, OptStr, OptInt, OptFloat, OptBool, parameter.empty, http.QueryParam, http.PathParam, uuid.UUID, datetime.date, datetime.datetime, ) def resolve( self, parameter: inspect.Parameter, path_params: ValidatedPathParams, query_params: ValidatedQueryParams ): params = path_params if (parameter.name in path_params) else query_params if parameter.annotation in (OptInt, OptFloat, OptBool, OptStr) or parameter.default is not parameter.empty: kwargs = {"missing": parameter.default if parameter.default is not parameter.empty else None} else: kwargs = {"required": True} param_validator = { inspect.Signature.empty: marshmallow.fields.Field, int: marshmallow.fields.Integer, float: marshmallow.fields.Number, bool: marshmallow.fields.Boolean, str: marshmallow.fields.String, uuid.UUID: marshmallow.fields.UUID, datetime.date: marshmallow.fields.Date, datetime.datetime: marshmallow.fields.DateTime, OptInt: marshmallow.fields.Integer, OptFloat: marshmallow.fields.Number, OptBool: marshmallow.fields.Boolean, OptStr: marshmallow.fields.String, http.QueryParam: marshmallow.fields.String, http.PathParam: marshmallow.fields.String, OptUUID: marshmallow.fields.UUID, OptDate: marshmallow.fields.Date, OptDateTime: marshmallow.fields.DateTime, }[parameter.annotation](**kwargs) validator = type("Validator", (marshmallow.Schema,), {parameter.name: param_validator}) try: params = validator().load(params, unknown=marshmallow.EXCLUDE) except marshmallow.ValidationError as exc: raise exceptions.InputValidationError(detail=exc.normalized_messages()) return params.get(parameter.name, parameter.default) class CompositeParamComponent(Component): def can_handle_parameter(self, parameter: inspect.Parameter): return inspect.isclass(parameter.annotation) and issubclass(parameter.annotation, marshmallow.Schema) def resolve(self, parameter: inspect.Parameter, data: ValidatedRequestData): return data VALIDATION_COMPONENTS = ( RequestDataComponent(), WebSocketMessageDataComponent(), ValidatePathParamsComponent(), ValidateQueryParamsComponent(), ValidateRequestDataComponent(), PrimitiveParamComponent(), CompositeParamComponent(), ) PK! Xflama/endpoints.pyimport asyncio import typing from starlette import status from starlette.concurrency import run_in_threadpool from starlette.endpoints import HTTPEndpoint as BaseHTTPEndpoint from starlette.endpoints import WebSocketEndpoint as BaseWebSocketEndpoint from starlette.requests import Request from starlette.responses import Response from starlette.types import Receive, Send from starlette.websockets import WebSocket, WebSocketState from flama import exceptions, websockets from flama.responses import APIResponse from flama.validation import get_output_schema __all__ = ["HTTPEndpoint", "WebSocketEndpoint"] class HTTPEndpoint(BaseHTTPEndpoint): async def __call__(self, receive: Receive, send: Send): request = Request(self.scope, receive=receive) app = self.scope["app"] kwargs = self.scope.get("kwargs", {}) route, route_scope = app.router.get_route_from_scope(self.scope) state = { "scope": self.scope, "receive": receive, "send": send, "exc": None, "app": app, "path_params": route_scope["path_params"], "route": route, "request": request, } response = await self.dispatch(request, state, **kwargs) return await response(receive, send) async def dispatch(self, request: Request, state: typing.Dict, **kwargs) -> Response: handler_name = "get" if request.method == "HEAD" else request.method.lower() handler = getattr(self, handler_name, self.method_not_allowed) app = state["app"] injected_func = await app.injector.inject(handler, state) if asyncio.iscoroutinefunction(handler): response = await injected_func() else: response = await run_in_threadpool(injected_func) # Wrap response data with a proper response class if isinstance(response, (dict, list)): response = APIResponse(content=response, schema=get_output_schema(handler)) elif isinstance(response, str): response = APIResponse(content=response) elif response is None: response = APIResponse(content="") return response class WebSocketEndpoint(BaseWebSocketEndpoint): async def __call__(self, receive: Receive, send: Send) -> None: app = self.scope["app"] websocket = WebSocket(self.scope, receive, send) route, route_scope = app.router.get_route_from_scope(self.scope) state = { "scope": self.scope, "receive": receive, "send": send, "exc": None, "app": app, "path_params": route_scope["path_params"], "route": route, "websocket": websocket, "websocket_encoding": self.encoding, "websocket_code": status.WS_1000_NORMAL_CLOSURE, "websocket_message": None, } try: on_connect = await app.injector.inject(self.on_connect, state) await on_connect() except Exception as e: raise exceptions.WebSocketConnectionException("Error connecting socket") from e try: state["websocket_message"] = await websocket.receive() while websocket.client_state == WebSocketState.CONNECTED: on_receive = await app.injector.inject(self.on_receive, state) await on_receive() state["websocket_message"] = await websocket.receive() state["websocket_code"] = int(state["websocket_message"].get("code", status.WS_1000_NORMAL_CLOSURE)) except exceptions.WebSocketException as e: state["websocket_code"] = e.close_code except Exception as e: state["websocket_code"] = status.WS_1011_INTERNAL_ERROR raise e from None finally: on_disconnect = await app.injector.inject(self.on_disconnect, state) await on_disconnect() async def on_connect(self, websocket: websockets.WebSocket) -> None: """Override to handle an incoming websocket connection""" await websocket.accept() async def on_receive(self, websocket: websockets.WebSocket, data: websockets.Data) -> None: """Override to handle an incoming websocket message""" async def on_disconnect(self, websocket: websockets.WebSocket, websocket_code: websockets.Code) -> None: """Override to handle a disconnecting websocket""" await websocket.close(websocket_code) PK!؁@KKflama/exceptions.pyimport typing import starlette.exceptions class DecodeError(Exception): """ Raised by a Codec when `decode` fails due to malformed syntax. """ def __init__(self, message, marker=None, base_format=None): Exception.__init__(self, message) self.message = message self.marker = marker self.base_format = base_format class NoReverseMatch(Exception): """ Raised by a Router when `reverse_url` is passed an invalid handler name. """ ... class NoCodecAvailable(Exception): ... class ConfigurationError(Exception): ... class ComponentNotFound(ConfigurationError): def __init__(self, parameter: str, resolver: typing.Optional[str] = None, *args, **kwargs): self.parameter = parameter self.resolver = resolver super().__init__(*args, **kwargs) def __str__(self): msg = f'No component able to handle parameter "{self.parameter}"' if self.resolver: msg += f' in function "{self.resolver}"' return msg class WebSocketException(Exception): def __init__(self, close_code: int): self.close_code = close_code class WebSocketConnectionException(Exception): ... class HTTPException(starlette.exceptions.HTTPException): ... class ValidationError(HTTPException): def __init__(self, detail: typing.Union[str, typing.Dict[str, typing.List[str]]], status_code: int = 400): super().__init__(status_code=status_code, detail=detail) class InputValidationError(ValidationError): ... class OutputValidationError(ValidationError): ... PK!>n   flama/http.pyimport typing from starlette.datastructures import URL, Headers, MutableHeaders, QueryParams from starlette.requests import Request from starlette.responses import ( FileResponse, HTMLResponse, JSONResponse, PlainTextResponse, RedirectResponse, Response, StreamingResponse, ) __all__ = [ "Method", "Scheme", "Host", "Port", "Path", "QueryString", "QueryParam", "Header", "Body", "PathParams", "PathParam", "RequestData", "URL", "QueryParams", "Headers", "MutableHeaders", "Request", "Response", "PlainTextResponse", "HTMLResponse", "JSONResponse", "FileResponse", "RedirectResponse", "StreamingResponse", "ReturnValue", ] Method = typing.NewType("Method", str) Scheme = typing.NewType("Scheme", str) Host = typing.NewType("Host", str) Port = typing.NewType("Port", int) Path = typing.NewType("Path", str) QueryString = typing.NewType("QueryString", str) QueryParam = typing.NewType("QueryParam", str) Header = typing.NewType("Header", str) Body = typing.NewType("Body", bytes) PathParams = typing.NewType("PathParams", dict) PathParam = typing.NewType("PathParam", str) RequestData = typing.TypeVar("RequestData") ReturnValue = typing.TypeVar("ReturnValue") PK!811flama/injection.pyimport asyncio import functools import inspect import typing from flama import http, websockets from flama.components.asgi import ASGI_COMPONENTS, ASGIReceive, ASGIScope, ASGISend from flama.components.validation import VALIDATION_COMPONENTS from flama.exceptions import ComponentNotFound from flama.routing import Route __all__ = ["Injector"] class Injector: def __init__(self, components): from flama.applications import Flama self.components = list(ASGI_COMPONENTS + VALIDATION_COMPONENTS) + components self.initial = { "scope": ASGIScope, "receive": ASGIReceive, "send": ASGISend, "exc": Exception, "app": Flama, "path_params": http.PathParams, "route": Route, "request": http.Request, "response": http.Response, "websocket": websockets.WebSocket, "websocket_message": websockets.Message, "websocket_encoding": websockets.Encoding, "websocket_code": websockets.Code, } self.reverse_initial = {val: key for key, val in self.initial.items()} self.resolver_cache = {} def resolve_parameter( self, parameter, kwargs: typing.Dict, consts: typing.Dict, seen_state: typing.Set, parent_parameter=None ) -> typing.List[typing.Tuple]: """ Resolve a parameter by inferring the component that suits it or by adding a value to kwargs or consts. The list of steps returned consists of a resolver function, a boolean that indicates if the function is async, function kwargs and consts and the output name. :param parameter: parameter to be resolved. :param kwargs: kwargs that defines current context. :param consts: consts that defines current context. :param seen_state: cached state. :param parent_parameter: parent parameter. :return: list of steps to resolve the component. """ if parameter.annotation is http.ReturnValue: kwargs[parameter.name] = "return_value" return [] # Check if the parameter class exists in 'initial'. if parameter.annotation in self.reverse_initial: initial_kwarg = self.reverse_initial[parameter.annotation] kwargs[parameter.name] = initial_kwarg return [] # The 'Parameter' annotation can be used to get the parameter # itself. Used for example in 'Header' components that need the # parameter name in order to lookup a particular value. if parameter.annotation is inspect.Parameter: consts[parameter.name] = parent_parameter return [] for component in self.components: if component.can_handle_parameter(parameter): identity = component.identity(parameter) kwargs[parameter.name] = identity if identity not in seen_state: seen_state.add(identity) return self.resolve_component( resolver=component.resolve, output_name=identity, seen_state=seen_state, parent_parameter=parameter, ) return [] else: raise ComponentNotFound(parameter.name) def resolve_component( self, resolver, output_name: str, seen_state: typing.Set, parent_parameter=None ) -> typing.List[typing.Tuple]: """ Resolve a component injecting all dependencies needed in its resolver function. The list of steps returned consists of a resolver function, a boolean that indicates if the function is async, function kwargs and consts and the output name. :param resolver: component resolver function. :param output_name: name used for that component in application status. :param seen_state: cached status. :param parent_parameter: parent parameter. :return: list of steps to resolve the component. """ signature = inspect.signature(resolver) steps = [] kwargs = {} consts = {} if output_name is None: if signature.return_annotation in self.reverse_initial: output_name = self.reverse_initial[signature.return_annotation] else: output_name = "return_value" for parameter in signature.parameters.values(): try: steps += self.resolve_parameter( parameter, kwargs, consts, seen_state=seen_state, parent_parameter=parent_parameter ) except ComponentNotFound: raise ComponentNotFound(parameter=parameter.name, resolver=resolver.__class__.__name__) is_async = asyncio.iscoroutinefunction(resolver) step = (resolver, is_async, kwargs, consts, output_name) steps.append(step) return steps def resolve(self, func) -> typing.Tuple[typing.Dict, typing.Dict, typing.List]: """ Inspects a function and creates a resolution list of all components needed to run it. returning :param func: function to resolve. :return: the keyword arguments, consts for that function and the steps to resolve all components. """ seen_state = set(self.initial) steps = [] kwargs = {} consts = {} signature = inspect.signature(func) for parameter in signature.parameters.values(): try: steps += self.resolve_parameter(parameter, kwargs, consts, seen_state=seen_state) except ComponentNotFound: raise ComponentNotFound(parameter=parameter.name, resolver=func.__name__) return kwargs, consts, steps async def inject(self, func, state: typing.Dict) -> typing.Callable: """ Given a function, injects all components defined in its signature and returns the partialized function. :param func: function to be partialized. :param state: mapping of current application state to infer components state. :return: partialized function. """ try: func_kwargs, func_consts, steps = self.resolver_cache[func] except KeyError: func_kwargs, func_consts, steps = self.resolve(func) self.resolver_cache[func] = (func_kwargs, func_consts, steps) for resolver, is_async, kwargs, consts, output_name in steps: kw = {key: state[val] for key, val in kwargs.items()} kw.update(consts) if is_async: state[output_name] = await resolver(**kw) else: state[output_name] = resolver(**kw) kw = {key: state[val] for key, val in func_kwargs.items()} kw.update(func_consts) return functools.partial(func, **kw) PK!9W2yyflama/negotiation.pyimport typing from flama import exceptions from flama.codecs.base import HTTPCodec, WebsocketsCodec from flama.codecs.websockets import BytesCodec __all__ = ["ContentTypeNegotiator", "WebSocketEncodingNegotiator"] class ContentTypeNegotiator: def __init__(self, codecs: typing.Optional[typing.List[HTTPCodec]] = None): self.codecs = codecs or [] def negotiate(self, content_type: str = None) -> WebsocketsCodec: """ Given the value of a 'Content-Type' header, return the appropriate codec for decoding the request content. """ if content_type is None: return self.codecs[0] content_type = content_type.split(";")[0].strip().lower() main_type = content_type.split("/")[0] + "/*" wildcard_type = "*/*" for codec in self.codecs: if codec.media_type in (content_type, main_type, wildcard_type): return codec raise exceptions.NoCodecAvailable(f"Unsupported media in Content-Type header '{content_type}'") class WebSocketEncodingNegotiator: def __init__(self, codecs: typing.Optional[typing.List[WebsocketsCodec]] = None): self.codecs = codecs or [BytesCodec()] def negotiate(self, encoding: str = None) -> WebsocketsCodec: """ Given a websocket encoding, return the appropriate codec for decoding the request content. """ if encoding is None: return self.codecs[0] for codec in self.codecs: if codec.encoding == encoding: return codec raise exceptions.NoCodecAvailable(f"Unsupported websocket encoding '{encoding}'") PK!'!kJJflama/pagination/__init__.pyfrom flama.pagination.paginator import Paginator __all__ = ["Paginator"] PK!@u^ flama/pagination/limit_offset.pyimport typing import marshmallow from flama.responses import APIResponse __all__ = ["LimitOffsetSchema", "LimitOffsetResponse"] class LimitOffsetMeta(marshmallow.Schema): limit = marshmallow.fields.Integer(title="limit", description="Number of retrieved items") offset = marshmallow.fields.Integer(title="offset", description="Collection offset") count = marshmallow.fields.Integer(title="count", description="Total number of items", allow_none=True) class LimitOffsetSchema(marshmallow.Schema): meta = marshmallow.fields.Nested(LimitOffsetMeta) data = marshmallow.fields.List(marshmallow.fields.Dict()) class LimitOffsetResponse(APIResponse): """ Response paginated based on a limit of elements and an offset. First 10 elements: /resource?offset=0&limit=10 Elements 20-30: /resource?offset=20&limit=10 """ default_limit = 10 def __init__( self, schema: marshmallow.Schema, offset: typing.Optional[typing.Union[int, str]] = None, limit: typing.Optional[typing.Union[int, str]] = None, count: typing.Optional[bool] = True, **kwargs ): self.offset = int(offset) if offset is not None else 0 self.limit = int(limit) if limit is not None else self.default_limit self.count = count super().__init__(schema=schema, **kwargs) def render(self, content: typing.Sequence): init = self.offset end = self.offset + self.limit return super().render( { "meta": {"limit": self.limit, "offset": self.offset, "count": len(content) if self.count else None}, "data": content[init:end], } ) PK!Eggflama/pagination/page_number.pyimport typing import marshmallow from flama.responses import APIResponse __all__ = ["PageNumberSchema", "PageNumberResponse"] class PageNumberMeta(marshmallow.Schema): page = marshmallow.fields.Integer(title="page", description="Current page number") page_size = marshmallow.fields.Integer(title="page_size", description="Page size") count = marshmallow.fields.Integer(title="count", description="Total number of items", allow_none=True) class PageNumberSchema(marshmallow.Schema): meta = marshmallow.fields.Nested(PageNumberMeta) data = marshmallow.fields.List(marshmallow.fields.Dict()) class PageNumberResponse(APIResponse): """ Response paginated based on a page number and a page size. First 10 elements: /resource?page=1 Third 10 elements: /resource?page=3 First 20 elements: /resource?page=1&page_size=20 """ default_page_size = 10 def __init__( self, schema: marshmallow.Schema, page: typing.Optional[typing.Union[int, str]] = None, page_size: typing.Optional[typing.Union[int, str]] = None, count: typing.Optional[bool] = True, **kwargs ): self.page_number = int(page) if page is not None else 1 self.page_size = int(page_size) if page_size is not None else self.default_page_size self.count = count super().__init__(schema=schema, **kwargs) def render(self, content: typing.Sequence): init = (self.page_number - 1) * self.page_size end = self.page_number * self.page_size return super().render( { "meta": { "page": self.page_number, "page_size": self.page_size, "count": len(content) if self.count else None, }, "data": content[init:end], } ) PK!|flama/pagination/paginator.pyimport asyncio import functools import marshmallow from flama.pagination.limit_offset import LimitOffsetResponse, LimitOffsetSchema from flama.pagination.page_number import PageNumberResponse, PageNumberSchema from flama.validation import get_output_schema try: import forge except Exception: # pragma: no cover forge = None # type: ignore __all__ = ["Paginator"] class Paginator: @classmethod def page_number(cls, func): """ Decorator for adding pagination behavior to a view. That decorator produces a view based on page numbering and it adds three query parameters to control the pagination: page, page_size and count. Page has a default value of first page, page_size default value is defined in :class:`PageNumberResponse` and count defines if the response will define the total number of elements. The output schema is also modified by :class:`PageNumberSchema`, creating a new schema based on it but using the old output schema as the content of its data field. :param func: View to be decorated. :return: Decorated view. """ assert forge is not None, "`python-forge` must be installed to use OpenAPIResponse." resource_schema = get_output_schema(func) schema = type( "PageNumberPaginated" + resource_schema.__class__.__name__, # Add a prefix to avoid collision (PageNumberSchema,), {"data": marshmallow.fields.Nested(resource_schema, many=True)}, # Replace generic with resource schema )() forge_revision_list = ( forge.copy(func), forge.insert(forge.arg("page", default=None, type=int), index=-1), forge.insert(forge.arg("page_size", default=None, type=int), index=-1), forge.insert(forge.arg("count", default=True, type=bool), index=-1), forge.delete("kwargs"), forge.returns(schema), ) try: if asyncio.iscoroutinefunction(func): @forge.compose(*forge_revision_list) @functools.wraps(func) async def decorator(*args, page: int = None, page_size: int = None, count: bool = True, **kwargs): return PageNumberResponse( schema=schema, page=page, page_size=page_size, count=count, content=await func(*args, **kwargs) ) else: @forge.compose(*forge_revision_list) @functools.wraps(func) def decorator(*args, page: int = None, page_size: int = None, count: bool = True, **kwargs): return PageNumberResponse( schema=schema, page=page, page_size=page_size, count=count, content=func(*args, **kwargs) ) except ValueError as e: raise TypeError("Paginated views must define **kwargs param") from e return decorator @classmethod def limit_offset(cls, func): """ Decorator for adding pagination behavior to a view. That decorator produces a view based on limit-offset and it adds three query parameters to control the pagination: limit, offset and count. Offset has a default value of zero to start with the first element of the collection, limit default value is defined in :class:`LimitOffsetResponse` and count defines if the response will define the total number of elements. The output schema is also modified by :class:`LimitOffsetSchema`, creating a new schema based on it but using the old output schema as the content of its data field. :param func: View to be decorated. :return: Decorated view. """ assert forge is not None, "`python-forge` must be installed to use OpenAPIResponse." resource_schema = get_output_schema(func) schema = type( "LimitOffsetPaginated" + resource_schema.__class__.__name__, # Add a prefix to avoid collision (LimitOffsetSchema,), {"data": marshmallow.fields.Nested(resource_schema, many=True)}, # Replace generic with resource schema )() forge_revision_list = ( forge.copy(func), forge.insert(forge.arg("limit", default=None, type=int), index=-1), forge.insert(forge.arg("offset", default=None, type=int), index=-1), forge.insert(forge.arg("count", default=True, type=bool), index=-1), forge.delete("kwargs"), forge.returns(schema), ) try: if asyncio.iscoroutinefunction(func): @forge.compose(*forge_revision_list) @functools.wraps(func) async def decorator(*args, limit: int = None, offset: int = None, count: bool = True, **kwargs): return LimitOffsetResponse( schema=schema, limit=limit, offset=offset, count=count, content=await func(*args, **kwargs) ) else: @forge.compose(*forge_revision_list) @functools.wraps(func) def decorator(*args, limit: int = None, offset: int = None, count: bool = True, **kwargs): return LimitOffsetResponse( schema=schema, limit=limit, offset=offset, count=count, content=func(*args, **kwargs) ) except ValueError as e: raise TypeError("Paginated views must define **kwargs param") from e return decorator PK!gV">">flama/resources.pyimport datetime import logging import re import typing import uuid import marshmallow from flama.exceptions import HTTPException from flama.pagination import Paginator from flama.responses import APIResponse from flama.types import Model, PrimaryKey, ResourceMeta, ResourceMethodMeta try: import sqlalchemy from sqlalchemy.dialects import postgresql except Exception: # pragma: no cover raise AssertionError("`sqlalchemy` must be installed to use resources") from None try: import databases except Exception: # pragma: no cover raise AssertionError("`databases` must be installed to use resources") from None logger = logging.getLogger(__name__) __all__ = ["resource_method", "BaseResource", "CRUDResource", "CRUDListResource", "CRUDListDropResource"] PK_MAPPING = { sqlalchemy.Integer: int, sqlalchemy.String: str, sqlalchemy.Date: datetime.date, sqlalchemy.DateTime: datetime.datetime, postgresql.UUID: uuid.UUID, } class DropCollection(marshmallow.Schema): deleted = marshmallow.fields.Integer(title="deleted", description="Number of deleted elements", required=True) def resource_method(path: str, methods: typing.List[str] = None, name: str = None, **kwargs) -> typing.Callable: def wrapper(func: typing.Callable) -> typing.Callable: func._meta = ResourceMethodMeta( path=path, methods=methods if methods is not None else ["GET"], name=name, kwargs=kwargs ) return func return wrapper class ResourceRoutes: """Routes descriptor""" def __init__(self, methods: typing.Dict[str, typing.Callable]): self.methods = methods def __get__(self, instance, owner) -> typing.Dict[str, typing.Callable]: return self.methods class BaseResource(type): METHODS = () # type: typing.Sequence[str] def __new__(mcs, name, bases, namespace): # Get database and replace it with a read-only descriptor database = mcs._get_attribute("database", name, namespace, bases) namespace["database"] = property(lambda self: self._meta.database) # Get model and replace it with a read-only descriptor model = mcs._get_model(name, namespace, bases) namespace["model"] = property(lambda self: self._meta.model.table) # Define resource names resource_name, verbose_name = mcs._get_resource_name(name, namespace) # Default columns and order for admin interface columns = namespace.pop("columns", [model.primary_key.name]) order = namespace.pop("order", model.primary_key.name) # Get input and output schemas input_schema, output_schema = mcs._get_schemas(name, namespace, bases) namespace["_meta"] = ResourceMeta( database=database, model=model, name=resource_name, verbose_name=verbose_name, input_schema=input_schema, output_schema=output_schema, columns=columns, order=order, ) # Create CRUD methods and routes mcs._add_methods(resource_name, verbose_name, namespace, database, input_schema, output_schema, model) mcs._add_routes(namespace) return super().__new__(mcs, name, bases, namespace) @classmethod def _get_attribute( mcs, attribute: str, name: str, namespace: typing.Dict[str, typing.Any], bases: typing.Sequence[typing.Any] ) -> typing.Any: try: return namespace.pop(attribute) except KeyError: for base in bases: if hasattr(base, "_meta") and hasattr(base._meta, attribute): return getattr(base._meta, attribute) elif hasattr(base, attribute): return getattr(base, attribute) raise AttributeError(f"{name} needs to define attribute '{attribute}'") @classmethod def _get_resource_name(mcs, name: str, namespace: typing.Dict[str, typing.Any]) -> typing.Tuple[str, str]: resource_name = namespace.pop("name", name.lower()) # Check resource name validity if re.match("[a-zA-Z][-_a-zA-Z]", resource_name) is None: raise AttributeError(f"Invalid resource name '{resource_name}'") return resource_name, namespace.pop("verbose_name", resource_name) @classmethod def _get_model( mcs, name: str, namespace: typing.Dict[str, typing.Any], bases: typing.Sequence[typing.Any] ) -> Model: model = mcs._get_attribute("model", name, namespace, bases) # Already defined model probably because resource inheritance, so no need to create it if isinstance(model, Model): return model # Resource define model as a sqlalchemy Table, so extract necessary info from it elif isinstance(model, sqlalchemy.Table): # Get model primary key model_pk = list(sqlalchemy.inspect(model).primary_key.columns.values()) # Check primary key exists and is a single column if len(model_pk) != 1: raise AttributeError(f"{name} model must define a single-column primary key") model_pk = model_pk[0] model_pk_name = model_pk.name # Check primary key is a valid type try: model_pk_type = PK_MAPPING[model_pk.type.__class__] except KeyError: raise AttributeError( f"{name} model primary key must be any of {', '.join((i.__name__ for i in PK_MAPPING.keys()))}" ) return Model(table=model, primary_key=PrimaryKey(model_pk_name, model_pk_type)) raise AttributeError(f"{name} model must be a valid SQLAlchemy Table instance or a Model instance") @classmethod def _get_schemas( mcs, name: str, namespace: typing.Dict[str, typing.Any], bases: typing.Sequence[typing.Any] ) -> typing.Tuple[marshmallow.Schema, marshmallow.Schema]: try: schema = mcs._get_attribute("schema", name, namespace, bases) input_schema = schema output_schema = schema except AttributeError: try: input_schema = mcs._get_attribute("input_schema", name, namespace, bases) output_schema = mcs._get_attribute("output_schema", name, namespace, bases) except AttributeError: raise AttributeError( f"{name} needs to define attribute 'schema' or the pair 'input_schema' and 'output_schema'" ) return input_schema, output_schema @classmethod def _add_routes(mcs, namespace: typing.Dict[str, typing.Any]): methods = {name: m for name, m in namespace.items() if getattr(m, "_meta", False) and not name.startswith("_")} routes = ResourceRoutes(methods) namespace["routes"] = routes @classmethod def _add_methods( mcs, name: str, verbose_name: str, namespace: typing.Dict[str, typing.Any], database: "databases.Database", input_schema: marshmallow.Schema, output_schema: marshmallow.Schema, model: Model, ): # Get available methods methods = [getattr(mcs, f"_add_{method}") for method in mcs.METHODS if hasattr(mcs, f"_add_{method}")] # Generate CRUD methods crud_namespace = { func_name: func for method in methods for func_name, func in method( name=name, verbose_name=verbose_name, database=database, input_schema=input_schema, output_schema=output_schema, model=model, ).items() } # Preserve already defined methods crud_namespace.update( {method: crud_namespace[f"_{method}"] for method in mcs.METHODS if method not in namespace} ) namespace.update(crud_namespace) class CreateMixin: @classmethod def _add_create( mcs, name: str, verbose_name: str, database: databases.Database, input_schema: marshmallow.Schema, output_schema: marshmallow.Schema, **kwargs, ) -> typing.Dict[str, typing.Any]: @resource_method("/", methods=["POST"], name=f"{name}-create") @database.transaction() async def create(self, element: input_schema) -> output_schema: query = self.model.insert().values(**element) await self.database.execute(query) return APIResponse(schema=output_schema(), content=element, status_code=201) create.__doc__ = f""" tags: - {verbose_name} summary: Create a new document. description: Create a new document in this resource. responses: 201: description: Document created successfully. """ return {"_create": create} class RetrieveMixin: @classmethod def _add_retrieve( mcs, name: str, verbose_name: str, output_schema: marshmallow.Schema, model: Model, **kwargs ) -> typing.Dict[str, typing.Any]: @resource_method("/{element_id}/", methods=["GET"], name=f"{name}-retrieve") async def retrieve(self, element_id: model.primary_key.type) -> output_schema: query = self.model.select().where(self.model.c[model.primary_key.name] == element_id) element = await self.database.fetch_one(query) if element is None: raise HTTPException(status_code=404) return dict(element) retrieve.__doc__ = f""" tags: - {verbose_name} summary: Retrieve a document. description: Retrieve a document from this resource. responses: 200: description: Document found. 404: description: Document not found. """ return {"_retrieve": retrieve} class UpdateMixin: @classmethod def _add_update( mcs, name: str, verbose_name: str, database: databases.Database, input_schema: marshmallow.Schema, output_schema: marshmallow.Schema, model: Model, **kwargs, ) -> typing.Dict[str, typing.Any]: @resource_method("/{element_id}/", methods=["PUT"], name=f"{name}-update") @database.transaction() async def update(self, element_id: model.primary_key.type, element: input_schema) -> output_schema: query = sqlalchemy.select([sqlalchemy.exists().where(self.model.c[model.primary_key.name] == element_id)]) exists = next((i for i in (await self.database.fetch_one(query)).values())) if not exists: raise HTTPException(status_code=404) query = self.model.update().where(self.model.c[model.primary_key.name] == element_id).values(**element) await self.database.execute(query) return {model.primary_key.name: element_id, **element} update.__doc__ = f""" tags: - {verbose_name} summary: Update a document. description: Update a document in this resource. responses: 200: description: Document updated successfully. 404: description: Document not found. """ return {"_update": update} class DeleteMixin: @classmethod def _add_delete( mcs, name: str, verbose_name: str, database: databases.Database, model: Model, **kwargs ) -> typing.Dict[str, typing.Any]: @resource_method("/{element_id}/", methods=["DELETE"], name=f"{name}-delete") @database.transaction() async def delete(self, element_id: model.primary_key.type): query = sqlalchemy.select([sqlalchemy.exists().where(self.model.c[model.primary_key.name] == element_id)]) exists = next((i for i in (await self.database.fetch_one(query)).values())) if not exists: raise HTTPException(status_code=404) query = self.model.delete().where(self.model.c[model.primary_key.name] == element_id) await self.database.execute(query) return APIResponse(status_code=204) delete.__doc__ = f""" tags: - {verbose_name} summary: Delete a document. description: Delete a document in this resource. responses: 204: description: Document deleted successfully. 404: description: Document not found. """ return {"_delete": delete} class ListMixin: @classmethod def _add_list( mcs, name: str, verbose_name: str, output_schema: marshmallow.Schema, **kwargs ) -> typing.Dict[str, typing.Any]: async def filter(self, *clauses, **filters) -> typing.List[typing.Dict]: query = self.model.select() where_clauses = tuple(clauses) + tuple(self.model.c[k] == v for k, v in filters.items()) if where_clauses: query = query.where(sqlalchemy.and_(*where_clauses)) return [dict(row) for row in await self.database.fetch_all(query)] @resource_method("/", methods=["GET"], name=f"{name}-list") @Paginator.page_number async def list(self, **kwargs) -> output_schema(many=True): return await self._filter() # noqa list.__doc__ = f""" tags: - {verbose_name} summary: List collection. description: List resource collection. responses: 200: description: List collection items. """ return {"_list": list, "_filter": filter} class DropMixin: @classmethod def _add_drop( mcs, name: str, verbose_name: str, database: databases.Database, model: Model, **kwargs ) -> typing.Dict[str, typing.Any]: @resource_method("/", methods=["DELETE"], name=f"{name}-drop") @database.transaction() async def drop(self) -> DropCollection: query = sqlalchemy.select([sqlalchemy.func.count(self.model.c[model.primary_key.name])]) result = next((i for i in (await self.database.fetch_one(query)).values())) query = self.model.delete() await self.database.execute(query) return APIResponse(schema=DropCollection(), content={"deleted": result}, status_code=204) drop.__doc__ = f""" tags: - {verbose_name} summary: Drop collection. description: Drop resource collection. responses: 204: description: Collection dropped successfully. """ return {"_drop": drop} class CRUDResource(BaseResource, CreateMixin, RetrieveMixin, UpdateMixin, DeleteMixin): METHODS = ("create", "retrieve", "update", "delete") class CRUDListResource(BaseResource, CreateMixin, RetrieveMixin, UpdateMixin, DeleteMixin, ListMixin): METHODS = ("create", "retrieve", "update", "delete", "list") class CRUDListDropResource(BaseResource, CreateMixin, RetrieveMixin, UpdateMixin, DeleteMixin, ListMixin, DropMixin): METHODS = ("create", "retrieve", "update", "delete", "list", "drop") PK!JTflama/responses.pyimport typing import marshmallow from starlette.responses import JSONResponse __all__ = ["APIResponse", "APIErrorResponse", "APIError"] class APIError(marshmallow.Schema): status_code = marshmallow.fields.Integer(title="status_code", description="HTTP status code", required=True) detail = marshmallow.fields.Raw(title="detail", description="Error detail", required=True) error = marshmallow.fields.String(title="type", description="Exception or error type") class APIResponse(JSONResponse): media_type = "application/json" def __init__(self, schema: typing.Optional[marshmallow.Schema] = None, *args, **kwargs): self.schema = schema super().__init__(*args, **kwargs) def render(self, content: typing.Any): # Use output schema to validate and format data if self.schema is not None: content = self.schema.dump(content) return super().render(content) class APIErrorResponse(APIResponse): def __init__( self, detail: typing.Any, status_code: int = 400, exception: typing.Optional[Exception] = None, *args, **kwargs ): content = { "status_code": status_code, "detail": detail, "error": str(exception.__class__.__name__) if exception is not None else None, } super().__init__(schema=APIError(), content=content, status_code=status_code, *args, **kwargs) self.detail = detail self.exception = exception PK!sV//flama/routing.pyimport asyncio import inspect import typing from functools import wraps import marshmallow import starlette.routing from starlette.concurrency import run_in_threadpool from starlette.routing import Match, Mount from starlette.types import ASGIApp, ASGIInstance, Receive, Scope, Send from flama import http, websockets from flama.components import Component from flama.responses import APIResponse from flama.types import Field, FieldLocation, HTTPMethod, OptBool, OptFloat, OptInt, OptStr from flama.validation import get_output_schema if typing.TYPE_CHECKING: from flama.resources import BaseResource __all__ = ["Route", "WebSocketRoute", "Router"] FieldsMap = typing.Dict[str, Field] MethodsMap = typing.Dict[str, FieldsMap] PATH_SCHEMA_MAPPING = { inspect.Signature.empty: lambda *args, **kwargs: None, int: marshmallow.fields.Integer, float: marshmallow.fields.Number, str: marshmallow.fields.String, bool: marshmallow.fields.Boolean, http.PathParam: marshmallow.fields.String, } QUERY_SCHEMA_MAPPING = { inspect.Signature.empty: lambda *args, **kwargs: None, int: marshmallow.fields.Integer, float: marshmallow.fields.Number, bool: marshmallow.fields.Boolean, str: marshmallow.fields.String, OptInt: marshmallow.fields.Integer, OptFloat: marshmallow.fields.Number, OptBool: marshmallow.fields.Boolean, OptStr: marshmallow.fields.String, http.QueryParam: marshmallow.fields.String, } class FieldsMixin: def _get_fields( self, router: "Router" ) -> typing.Tuple[MethodsMap, MethodsMap, typing.Dict[str, Field], typing.Dict[str, typing.Any]]: query_fields: MethodsMap = {} path_fields: MethodsMap = {} body_field: typing.Dict[str, Field] = {} output_field: typing.Dict[str, typing.Any] = {} if hasattr(self, "methods") and self.methods is not None: if inspect.isclass(self.endpoint): # HTTP endpoint methods = [(m, getattr(self.endpoint, m.lower() if m != "HEAD" else "get")) for m in self.methods] else: # HTTP function methods = [(m, self.endpoint) for m in self.methods] if self.methods else [] else: # Websocket methods = [("GET", self.endpoint)] for m, h in methods: query_fields[m], path_fields[m], body_field[m], output_field[m] = self._get_fields_from_handler(h, router) return query_fields, path_fields, body_field, output_field def _get_parameters_from_handler( self, handler: typing.Callable, router: "Router" ) -> typing.Dict[str, inspect.Parameter]: parameters = {} for name, parameter in inspect.signature(handler).parameters.items(): for component in router.components: if component.can_handle_parameter(parameter): parameters.update(self._get_parameters_from_handler(component.resolve, router)) break else: parameters[name] = parameter return parameters def _get_fields_from_handler( self, handler: typing.Callable, router: "Router" ) -> typing.Tuple[FieldsMap, FieldsMap, Field, typing.Any]: query_fields: FieldsMap = {} path_fields: FieldsMap = {} body_field: Field = None # Iterate over all params for name, param in self._get_parameters_from_handler(handler, router).items(): if name in ("self", "cls"): continue # Matches as path param if name in self.param_convertors.keys(): try: schema = PATH_SCHEMA_MAPPING[param.annotation] except KeyError: schema = marshmallow.fields.String path_fields[name] = Field( name=name, location=FieldLocation.path, schema=schema(required=True), required=True ) # Matches as query param elif param.annotation in QUERY_SCHEMA_MAPPING: if param.annotation in (OptInt, OptFloat, OptBool, OptStr) or param.default is not param.empty: required = False kwargs = {"missing": param.default if param.default is not param.empty else None} else: required = True kwargs = {"required": True} query_fields[name] = Field( name=name, location=FieldLocation.query, schema=QUERY_SCHEMA_MAPPING[param.annotation](**kwargs), required=required, ) # Body params elif inspect.isclass(param.annotation) and issubclass(param.annotation, marshmallow.Schema): body_field = Field(name=name, location=FieldLocation.body, schema=param.annotation()) output_field = inspect.signature(handler).return_annotation return query_fields, path_fields, body_field, output_field class Route(starlette.routing.Route, FieldsMixin): def __init__(self, path: str, endpoint: typing.Callable, router: "Router", *args, **kwargs): super().__init__(path, endpoint=endpoint, **kwargs) # Replace function with another wrapper that uses the injector if inspect.isfunction(endpoint) or inspect.ismethod(endpoint): self.app = self.endpoint_wrapper(endpoint) if self.methods is None: self.methods = [m for m in HTTPMethod.__members__.keys() if hasattr(self, m.lower())] self.query_fields, self.path_fields, self.body_field, self.output_field = self._get_fields(router) def endpoint_wrapper(self, endpoint: typing.Callable) -> ASGIApp: """ Wraps a http function into ASGI application. """ @wraps(endpoint) def _app(scope: Scope) -> ASGIInstance: async def awaitable(receive: Receive, send: Send) -> None: app = scope["app"] route, route_scope = app.router.get_route_from_scope(scope) state = { "scope": scope, "receive": receive, "send": send, "exc": None, "app": app, "path_params": route_scope["path_params"], "route": route, "request": http.Request(scope, receive), } injected_func = await app.injector.inject(endpoint, state) if asyncio.iscoroutinefunction(endpoint): response = await injected_func() else: response = await run_in_threadpool(injected_func) # Wrap response data with a proper response class if isinstance(response, (dict, list)): response = APIResponse(content=response, schema=get_output_schema(endpoint)) elif isinstance(response, str): response = APIResponse(content=response) elif response is None: response = APIResponse(content="") await response(receive, send) return awaitable return _app class WebSocketRoute(starlette.routing.WebSocketRoute, FieldsMixin): def __init__(self, path: str, endpoint: typing.Callable, router: "Router", *args, **kwargs): super().__init__(path, endpoint=endpoint, **kwargs) # Replace function with another wrapper that uses the injector if inspect.isfunction(endpoint): self.app = self.endpoint_wrapper(endpoint) self.query_fields, self.path_fields, self.body_field, self.output_field = self._get_fields(router) def endpoint_wrapper(self, endpoint: typing.Callable) -> ASGIApp: """ Wraps websocket function into ASGI application. """ @wraps(endpoint) def _app(scope: Scope) -> ASGIInstance: async def awaitable(receive: Receive, send: Send) -> None: app = scope["app"] route, route_scope = app.router.get_route_from_scope(scope) state = { "scope": scope, "receive": receive, "send": send, "exc": None, "app": app, "path_params": route_scope["path_params"], "route": route, "websocket": websockets.WebSocket(scope, receive, send), } injected_func = await app.injector.inject(endpoint, state) kwargs = scope.get("kwargs", {}) await injected_func(**kwargs) return awaitable return _app class Router(starlette.routing.Router): def __init__(self, components: typing.Optional[typing.List[Component]] = None, *args, **kwargs): super().__init__(*args, **kwargs) if components is None: components = [] self.components = components def add_route( self, path: str, endpoint: typing.Callable, methods: typing.List[str] = None, name: str = None, include_in_schema: bool = True, ): self.routes.append( Route(path, endpoint=endpoint, methods=methods, name=name, include_in_schema=include_in_schema, router=self) ) def add_websocket_route(self, path: str, endpoint: typing.Callable, name: str = None): self.routes.append(WebSocketRoute(path, endpoint=endpoint, name=name, router=self)) def add_resource(self, path: str, resource: "BaseResource"): # Handle class or instance objects if inspect.isclass(resource): # noqa resource = resource() for name, route in resource.routes.items(): route_path = path + resource._meta.name + route._meta.path route_func = getattr(resource, name) name = route._meta.name if route._meta.name is not None else f"{resource._meta.name}-{route.__name__}" self.add_route(route_path, route_func, route._meta.methods, name, **route._meta.kwargs) def mount(self, path: str, app: ASGIApp, name: str = None) -> None: if isinstance(app, Router): app.components = self.components path = path.rstrip("/") route = Mount(path, app=app, name=name) self.routes.append(route) def route( self, path: str, methods: typing.List[str] = None, name: str = None, include_in_schema: bool = True ) -> typing.Callable: def decorator(func: typing.Callable) -> typing.Callable: self.add_route(path, func, methods=methods, name=name, include_in_schema=include_in_schema) return func return decorator def websocket_route(self, path: str, name: str = None) -> typing.Callable: def decorator(func: typing.Callable) -> typing.Callable: self.add_websocket_route(path, func, name=name) return func return decorator def resource(self, path: str) -> typing.Callable: def decorator(resource: "BaseResource") -> "BaseResource": self.add_resource(path, resource=resource) return resource return decorator def get_route_from_scope(self, scope) -> typing.Tuple[Route, typing.Optional[typing.Dict]]: partial = None for route in self.routes: if isinstance(route, Mount): path = scope.get("path", "") root_path = scope.pop("root_path", "") scope["path"] = root_path + path match, child_scope = route.matches(scope) if match == Match.FULL: scope.update(child_scope) if isinstance(route, Mount): route, mount_scope = route.app.get_route_from_scope(scope) return route, mount_scope return route, scope elif match == Match.PARTIAL and partial is None: partial = route partial_scope = child_scope if partial is not None: scope.update(partial_scope) return partial, scope return self.not_found, None PK!K#(#(flama/schemas.pyimport inspect import itertools import os import typing from collections import defaultdict from string import Template import marshmallow from starlette import routing, schemas from starlette.responses import HTMLResponse from flama.responses import APIError from flama.types import EndpointInfo from flama.utils import dict_safe_add try: import apispec except Exception: # pragma: no cover apispec = None # type: ignore try: import yaml except Exception: # pragma: no cover yaml = None # type: ignore __all__ = ["OpenAPIResponse", "SchemaGenerator", "SchemaMixin"] if yaml is not None and apispec is not None: from apispec.core import YAMLDumper as BaseYAMLDumper class YAMLDumper(BaseYAMLDumper): def ignore_aliases(self, data): return True class OpenAPIResponse(schemas.OpenAPIResponse): def render(self, content: typing.Any) -> bytes: assert yaml is not None, "`pyyaml` must be installed to use OpenAPIResponse." assert apispec is not None, "`apispec` must be installed to use OpenAPIResponse." assert isinstance(content, dict), "The schema passed to OpenAPIResponse should be a dictionary." return yaml.dump(content, default_flow_style=False, Dumper=YAMLDumper).encode("utf-8") class SchemaRegistry(dict): def __init__(self, spec, *args, **kwargs): super().__init__(*args, **kwargs) self.spec = spec self.openapi = self.spec.plugins[0].openapi def __getitem__(self, item): try: schema = super().__getitem__(item) except KeyError: component_schema = item if inspect.isclass(item) else item.__class__ self.spec.definition(name=component_schema.__name__, schema=component_schema) schema = self.openapi.resolve_schema_dict(item) super().__setitem__(item, schema) return schema class SchemaGenerator(schemas.BaseSchemaGenerator): def __init__(self, title: str, version: str, description: str, openapi_version="3.0.0"): assert apispec is not None, "`apispec` must be installed to use SchemaGenerator." from apispec.ext.marshmallow import MarshmallowPlugin self.spec = apispec.APISpec( title=title, version=version, openapi_version=openapi_version, info={"description": description}, plugins=[MarshmallowPlugin()], ) self.openapi = self.spec.plugins[0].openapi # Builtin definitions self.schemas = SchemaRegistry(self.spec) def get_endpoints( self, routes: typing.List[routing.BaseRoute], base_path: str = "" ) -> typing.Dict[str, typing.Sequence[EndpointInfo]]: """ Given the routes, yields the following information: - path eg: /users/ - http_method one of 'get', 'post', 'put', 'patch', 'delete', 'options' - func method ready to extract the docstring """ endpoints_info: typing.Dict[str, typing.Sequence[EndpointInfo]] = defaultdict(list) for route in routes: if isinstance(route, routing.Route) and route.include_in_schema: _, path, _ = routing.compile_path(base_path + route.path) if inspect.isfunction(route.endpoint) or inspect.ismethod(route.endpoint): for method in route.methods or ["GET"]: if method == "HEAD": continue endpoints_info[path].append( EndpointInfo( path=path, method=method.lower(), func=route.endpoint, query_fields=route.query_fields.get(method, {}), path_fields=route.path_fields.get(method, {}), body_field=route.body_field.get(method), output_field=route.output_field.get(method), ) ) else: for method in ["get", "post", "put", "patch", "delete", "options"]: if not hasattr(route.endpoint, method): continue func = getattr(route.endpoint, method) endpoints_info[path].append( EndpointInfo( path=path, method=method.lower(), func=func, query_fields=route.query_fields.get(method.upper(), {}), path_fields=route.path_fields.get(method.upper(), {}), body_field=route.body_field.get(method.upper()), output_field=route.output_field.get(method.upper()), ) ) elif isinstance(route, routing.Mount): endpoints_info.update(self.get_endpoints(route.routes, base_path=route.path)) return endpoints_info def _add_endpoint_parameters(self, endpoint: EndpointInfo, schema: typing.Dict): schema["parameters"] = [ self.openapi.field2parameter(field.schema, name=field.name, default_in=field.location.name) for field in itertools.chain(endpoint.query_fields.values(), endpoint.path_fields.values()) ] def _add_endpoint_body(self, endpoint: EndpointInfo, schema: typing.Dict): component_schema = ( endpoint.body_field.schema if inspect.isclass(endpoint.body_field.schema) else endpoint.body_field.schema.__class__ ) self.spec.definition(name=component_schema.__name__, schema=component_schema) dict_safe_add( schema, self.openapi.schema2jsonschema(endpoint.body_field.schema), "requestBody", "content", "application/json", "schema", ) def _add_endpoint_response(self, endpoint: EndpointInfo, schema: typing.Dict): response_codes = list(schema.get("responses", {}).keys()) main_response = response_codes[0] if response_codes else 200 dict_safe_add( schema, self.schemas[endpoint.output_field], "responses", main_response, "content", "application/json", "schema", ) def _add_endpoint_default_response(self, schema: typing.Dict): dict_safe_add(schema, self.schemas[APIError], "responses", "default", "content", "application/json", "schema") # Default description schema["responses"]["default"]["description"] = schema["responses"]["default"].get( "description", "Unexpected error." ) def get_endpoint_schema(self, endpoint: EndpointInfo) -> typing.Dict[str, typing.Any]: schema = self.parse_docstring(endpoint.func) # Query and Path parameters if endpoint.query_fields or endpoint.path_fields: self._add_endpoint_parameters(endpoint, schema) # Body if endpoint.body_field: self._add_endpoint_body(endpoint, schema) # Response if endpoint.output_field and ( (inspect.isclass(endpoint.output_field) and issubclass(endpoint.output_field, marshmallow.Schema)) or isinstance(endpoint.output_field, marshmallow.Schema) ): self._add_endpoint_response(endpoint, schema) # Default response self._add_endpoint_default_response(schema) return schema def get_schema(self, routes: typing.List[routing.BaseRoute]) -> typing.Dict[str, typing.Any]: endpoints_info = self.get_endpoints(routes) for path, endpoints in endpoints_info.items(): self.spec.add_path(path=path, operations={e.method: self.get_endpoint_schema(e) for e in endpoints}) return self.spec.to_dict() class SchemaMixin: def add_schema_docs_routes( self, title: str = "", version: str = "", description: str = "", schema: typing.Optional[str] = "/schema/", docs: typing.Optional[str] = "/docs/", redoc: typing.Optional[str] = None, ): # Schema self.title = title self.version = version self.description = description self.schema_url = schema if self.schema_url: self.add_schema_route() # Docs (Swagger UI) self.docs_url = docs if self.docs_url: self.add_docs_route() # Redoc self.redoc_url = redoc if self.redoc_url: self.add_redoc_route() @property def schema_generator(self): if not hasattr(self, "_schema_generator"): self._schema_generator = SchemaGenerator( title=self.title, version=self.version, description=self.description ) return self._schema_generator @property def schema(self): return self.schema_generator.get_schema(self.routes) def add_schema_route(self): def schema(): return OpenAPIResponse(self.schema) self.add_route(path=self.schema_url, route=schema, methods=["GET"], include_in_schema=False) def add_docs_route(self): def swagger_ui() -> HTMLResponse: with open(os.path.join(os.path.dirname(__file__), "templates/swagger_ui.html")) as f: content = Template(f.read()).substitute(title=self.title, schema_url=self.schema_url) return HTMLResponse(content) self.add_route(path=self.docs_url, route=swagger_ui, methods=["GET"], include_in_schema=False) def add_redoc_route(self): def redoc() -> HTMLResponse: with open(os.path.join(os.path.dirname(__file__), "templates/redoc.html")) as f: content = Template(f.read()).substitute(title=self.title, schema_url=self.schema_url) return HTMLResponse(content) self.add_route(path=self.redoc_url, route=redoc, methods=["GET"], include_in_schema=False) PK!BK}}flama/templates/redoc.html $title PK!?55flama/templates/swagger_ui.html $title
PK!X"flama/types.pyimport datetime import enum import typing import uuid import marshmallow try: from sqlalchemy import Table except Exception: # pragma: no cover Table = typing.Any try: from databases import Database except Exception: # pragma: no cover Database = typing.Any __all__ = [ "FieldLocation", "Field", "EndpointInfo", "OptInt", "OptStr", "OptBool", "OptFloat", "OptUUID", "OptDate", "OptDateTime", "Model", "PrimaryKey", "ResourceMeta", "ResourceMethodMeta", "HTTPMethod", ] class FieldLocation(enum.Enum): query = enum.auto() path = enum.auto() body = enum.auto() class Field(typing.NamedTuple): name: str location: FieldLocation schema: typing.Union[marshmallow.fields.Field, marshmallow.Schema] required: bool = False class EndpointInfo(typing.NamedTuple): path: str method: str func: typing.Callable query_fields: typing.Dict[str, Field] path_fields: typing.Dict[str, Field] body_field: Field output_field: typing.Any OptInt = typing.Optional[int] OptStr = typing.Optional[str] OptBool = typing.Optional[bool] OptFloat = typing.Optional[float] OptUUID = typing.Optional[uuid.UUID] OptDate = typing.Optional[datetime.date] OptDateTime = typing.Optional[datetime.datetime] class PrimaryKey(typing.NamedTuple): name: str type: typing.Any class Model(typing.NamedTuple): table: Table primary_key: PrimaryKey class ResourceMeta(typing.NamedTuple): model: Model input_schema: marshmallow.Schema output_schema: marshmallow.Schema database: Database name: str verbose_name: str columns: typing.Sequence[str] order: str class ResourceMethodMeta(typing.NamedTuple): path: str methods: typing.List[str] = ["GET"] name: str = None kwargs: typing.Dict[str, typing.Any] = {} HTTPMethod = enum.Enum("HTTPMethod", ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]) PK!gOflama/utils.pyimport typing __all__ = ["dict_safe_add"] def dict_safe_add(d: typing.Dict, v: typing.Any, *keys): _d = d for k in keys[:-1]: if not _d.get(k): _d[k] = {} _d = _d[k] _d[keys[-1]] = v PK!flama/validation.pyimport asyncio import inspect from functools import wraps import marshmallow from flama import exceptions __all__ = ["get_output_schema", "output_validation"] def get_output_schema(func): """ Get output schema annotated as function's return. If there is no schema, return None. :param func: Annotated function. :returns: Output schema. """ return_annotation = inspect.signature(func).return_annotation if inspect.isclass(return_annotation) and issubclass(return_annotation, marshmallow.Schema): return return_annotation() elif isinstance(return_annotation, marshmallow.Schema): return return_annotation return None def output_validation(error_cls=exceptions.OutputValidationError, error_status_code=500): """ Validate view output using schema annotated as function's return. :param error_cls: Error class to be raised when validation fails. Errors dict will be passed through 'detail' param. :param error_status_code: HTTP status code assigned to response when it fails to validate output, default 500. :raises exceptions.ValidationError: if output validation fails. """ def outer_decorator(func): schema = get_output_schema(func) assert schema is not None, "Return annotation must be a valid marshmallow schema" @wraps(func) async def inner_decorator(*args, **kwargs): response = await func(*args, **kwargs) if asyncio.iscoroutinefunction(func) else func(*args, **kwargs) try: # Use output schema to first deserialize the date and later validate it errors = schema.validate(schema.dump(response)) if errors: raise error_cls(detail=errors, status_code=error_status_code) except marshmallow.ValidationError as e: raise error_cls(detail=e.messages, status_code=error_status_code) return response return inner_decorator return outer_decorator PK!"[flama/websockets.pyimport typing from starlette.websockets import Message, WebSocket __all__ = ["WebSocket", "Message", "Code", "Encoding", "Data"] Code = typing.NewType("Code", int) Encoding = typing.NewType("Encoding", str) Data = typing.TypeVar("Data") PK! .[[flama-0.8.2.dist-info/LICENSE GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Flama Copyright (C) 2018-present José Antonio Perdiguero López This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . PK!HڽTUflama-0.8.2.dist-info/WHEEL A н#Z;/"d&F[xzw@Zpy3Fv]\fi4WZ^EgM_-]#0(q7PK!H ~ $flama-0.8.2.dist-info/METADATAXrء; %%ïUEp8X[Xdv@Gȋ;giɉXY|*JWiSI|}#s5L2j_hZ繴X|u)S[qq{-6Zj3jmF/&WR p]U+P֋81V]5CF'p{}{38GGSԍTU,5>$PE.Y+ȸcW~(*Sh#nMVֈWXt6%7_XNX:7m@'gOQtIR+( x,^AoފתPVf^d:iN">~|'֚yŪHGCO>7s)ՃNW?UV",|sET88ӗ6?ţ/"61qg[Hg>_sXn,3bF#|:|dKca$?X|idyǧ^23Q:6.>=˪6ǃC)TI5x{w3w4NW6_++ ;4EiJVC]j6EBfzULzHNdd<LUIo蝟|%M: +7R;ea1:IPH:7eG5+l(ϣay4@!󓗧_3?gCP#mL%XwM 0;[kjE K'ޟkbZɪvIUbH3}cH5B+"dT6Qd^xRN;dYV&1= *E LRT?:9;?x0Hz!8RNTF,,Hnݠ[5Vf)fmΉRB):̔KNS2S9 :sRvt֫uP›\_SLaawo(],hClZLhV 6.r^V$kie B7Ӊ:1ʥ ]cDy>b0&4$LT艨t"6woյIn.BXɀuLy-Af@'@ξfܫg*%V뢬+1u*"hAF3M 19:z@#4\I]PF VWdU$ Kę!"#6a C"X EJS80  ~= ">=:TNs tD1 g Txܗ;$leJ3C&Y"GJC'LN;U!CBhD<8Fx# I#`aA㐒ŊxCnڑE =/ gDb2.|.xY$T7t#W+9iv6-/疒(Q!!$@׈5L [YK$\&'f:Gs,NU}Ak(|Ac",=Դ_:紤~LV,A#>+VkTtcp&SDKpkfźj--gwHM[7Œy_l3A.!-_%*WT^LmlGN$舯 T޾V4+#-!vOF-$|KwO8cRX|.ao:YE΂:vKd6 y! }v[TԤ1A󐩘.䍭UH^ <мCn%~ vūHv܍1w\+tekh@'"Mnk4D?\d4x?`̵-z0 U/Ŝ.z4g/i?82Ht1yF .h& ͛mwH72맿XLLj2Miyk!];胅) xtnn,mFlUsg.:3Δ&lB:딟Q4״^;¼W Zbﳳ~?b%;ߙ>w[~]9L!Gj0lxH#r{lQ_,\ɷVVm`3-SLDjKQf@Fza&P׉pIPtIȺ? -=v_k(l-w?"/Y>?W@=q?D?dc9_gfT6{RSML:O[k%tF]ʕcшSvdD v\jһ2i| RHw]*tOS`AY3vѴ&8iR5 _Ujv(4)s\'cctف зhwA2&sۃA/U M9`S2~GF懋o>Dmwl1U?arW F;%KiPK!H= flama-0.8.2.dist-info/RECORDuǒXD-Ѓ7Y `C}:F5 '{y3o/by?y䴾)4l2k^5"ܘO}_Q0];+mgP ЋZ{U>ɍt Ihbn@BBhn4(Ϲ}Gezq`[٩)Z#W^Ө8Rfꥪ[kI0sҁÆZ_Y4 WF5(\[١Pb:u '~G2sL@˱k` ޠYFQaT7NR!LbL#טNU}mz*`ިxV9\V3qY[5蜛UCۆG2[7yC=9B3\62J mBjrb$Jobw(|Lˎ LSSn]")y_SCd_ /)z߸%$9 AbJ*x @)e8뀔UhLФb-.4mkm8;%ۻnx z#؋Z Ku009-mM_ԋ mWk{t?Owe x\ÕvIR AcVyڤ:E+'ӇwS/gU-%E/AV?Y-j^8ژsm#Jx?iR6 ȩ?wd]4Obc5Xc(>īPc|-C:g2p0o&L7hDkyQ/'KS]]ZO@!Y(VGMr?;L>ʜG n   4dflama/http.pyPK!811iiflama/injection.pyPK!9W2yyʄflama/negotiation.pyPK!'!kJJuflama/pagination/__init__.pyPK!@u^ flama/pagination/limit_offset.pyPK!Eggflama/pagination/page_number.pyPK!|flama/pagination/paginator.pyPK!gV">">flama/resources.pyPK!JTflama/responses.pyPK!sV//flama/routing.pyPK!K#(#(%flama/schemas.pyPK!BK}}gMflama/templates/redoc.htmlPK!?55Pflama/templates/swagger_ui.htmlPK!X"Rflama/types.pyPK!gOZflama/utils.pyPK![flama/validation.pyPK!"[cflama/websockets.pyPK! .[[dflama-0.8.2.dist-info/LICENSEPK!HڽTU^flama-0.8.2.dist-info/WHEELPK!H ~ $flama-0.8.2.dist-info/METADATAPK!H= flama-0.8.2.dist-info/RECORDPK''