ramka package

Subpackages

• ramka.middleware package
  • Submodules
  • ramka.middleware.base_middleware module
  • Module contents
• ramka.request package
  • Submodules
  • ramka.request.request module
  • Module contents
• ramka.response package
  • Submodules
  • ramka.response.response module
  • Module contents
• ramka.routing package
  • Submodules
  • ramka.routing.route module
  • ramka.routing.router module
  • Module contents
• ramka.static package
  • Submodules
  • ramka.static.engine module
  • Module contents
• ramka.templates package
  • Submodules
  • ramka.templates.engine module
  • Module contents
• ramka.test package
  • Submodules
  • ramka.test.session module
  • Module contents
• ramka.views package
  • Submodules
  • ramka.views.base_view module
  • ramka.views.errors module
  • Module contents

Submodules

ramka.app module

class ramka.app.App(root_dir: str, *, router: Optional[BaseRouter] = None, router_kwargs: Optional[Dict] = None, template_engine: Optional[BaseTemplateEngine] = None, template_engine_kwargs: Optional[Dict] = None, static_files_dir: Optional[str] = None, static_files_engine: Optional[BaseStaticFilesEngine] = None, static_files_engine_kwargs: Optional[Dict] = None, http_404_not_found_handler: Optional[Callable] = None, http_405_method_not_allowed_handler: Optional[Callable] = None, error_handler: Optional[Callable] = None, middleware_classes: Optional[List[Type[Middleware]]] = None)

Bases: object

The main application class.

This is the entrypoint for the application.

add_route(path: str, view: Union[BaseView, Callable], methods: Optional[List[str]] = None) → None

Add a route to the router.

It’s supposed to be used as a method.

Parameters:

• path (str) – The path to add the route to.

• view (Union[BaseView, Callable]) – The view to add the route to.

• methods (Optional[List[str]]) – The list of methods to add the route to.

handle_request(request: Request) → Response

Handle a request.

Parameters:

request (Request) – The request to handle.

Returns:

The response.

Return type:

Response

Raises:

Exception – An error occurred if no handler found.

has_route(path: str) → bool

Check if the router has a route for the given path.

Parameters:

path (str) – The path to check.

Returns:

True if the router has a route for the given path, False otherwise.

Return type:

bool

route(path: str, methods: Optional[List[str]] = None) → Callable

Add a route to the router.

It’s supposed to be used as a decorator.

Parameters:

• path (str) – The path to add the route to.

• methods (Optional[List[str]]) – The list of methods to add the route to.

template(template_name, context: Optional[Dict[str, Any]] = None) → Any

Render a template using defined template engine.

Parameters:

• template_name (str) – The name of the template to render.

• context (Optional[Dict[str, Any]]) – The context to use.

Returns:

The rendered template.

Return type:

Any

Module contents