turn standard Flask into mvc
Project description
You can use the mvc pattern in your flask application using this extension.
This real world implementation FLASK MVC
example: https://github.com/negrosdev/negros.dev
Installation
Run the follow command to install mvc_flask
:
$ pip install mvc_flask
Configuration
To configure the mvc_flask
you need import and register in your application, e.g:
from flask import Flask
from mvc_flask import FlaskMVC
app = Flask(__name__)
FlaskMVC(app)
Or use application factories
, e.g:
mvc = FlaskMVC()
def create_app():
...
mvc.init_app(app)
By default the mvc_flask
assumes that your application directory will be app
and if it doesn't exist, create it!
If you can use other directory, you can use the path
paramenter when the instance of FlaskMVC is initialized. E.g:
mvc = FlaskMVC()
def create_app():
...
mvc.init_app(app, path='src')
Now, you can use src
as default directory for prepare your application.
You structure should be look like this:
app
├── __ini__.py
├── controllers
│ └── home_controller.py
├── routes.py
└── views
├── index.html
Router
You can create routes in app/routes.py
and after create file, you can start register routes, e.g:
from mvc_flask import Router
Router.get("/", "home#index")
The same must be make done to POST
, PUT
and DELETE
methods. E.g: Router.post("/messages", "messages#create")
The first param represent the relative path and second represent the controller#action
. Remember that we are working with MVC pattern
, so we have controller
and action
.
The controller
can be created in app/controllers
and action is method of controller
.
You can use Router.all()
to register all routes of CRUD
.
Router.all("messages")
The previous command produce this:
messages.create POST /messages
messages.delete DELETE /messages/<id>
messages.edit GET /messages/<id>/edit
messages.index GET /messages
messages.new GET /messages/new
messages.show GET /messages/<id>
messages.update PATCH, PUT /messages/<id>
You can also use only parameter
to controll routes, e.g:
Router.all("messages", only="index show new create")
The previous command produce this:
messages.index GET /messages
messages.show GET /messages/<id>
messages.new GET /messages/new
messages.create POST /messages
The paramenter only
accept string
or array
, so, you can use only=["index", "show", "new", "create"]
Namespace
In app/routes.py
, you can start register namespace, e.g:
from mvc_flask import Router
api = Router.namespace("/api/v1")
api.get("/health", "health#index")
api.all("user")
posts = api.namespace("/posts")
posts.get("", "posts#index")
posts.post("", "posts#create")
posts.get("/<id>", "posts#show")
posts.put("/<id>", "posts#update")
posts.get("/<id>", "posts#delete")
The source produce this:
health.index GET /api/v1/health
posts.create POST /api/v1/posts
posts.delete GET /api/v1/posts/<id>
posts.index GET /api/v1/posts
posts.show GET /api/v1/posts/<id>
posts.update PATCH, PUT /api/v1/posts/<id>
user.create POST /api/v1/user
user.delete DELETE /api/v1/user/<id>
user.edit GET /api/v1/user/<id>/edit
user.index GET /api/v1/user
user.new GET /api/v1/user/new
user.show GET /api/v1/user/<id>
user.update PATCH, PUT /api/v1/user/<id>
Controller
Now that configure routes, the home_controller.py
file must contain the HomeController
class, registering the action
, e.g:
class HomeController:
def index(self):
return view("index.html")
If you have question, please, check de app directory to more details.
To use the hooks as before_request
, after_request
and etc... Just describe it in the controller, see:
class HomeController:
before_request = ["hi"]
def index(self):
return "home"
def hi(self):
...
The previous example describes the hi(self)
will be called every times that the visitors access the controller.
Views
Flask use the templates
directory by default to store HTMLs
files. However, using the mvc-flask
the default becomes views
. You can use the app/views
directory to stores templates.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mvc_flask-2.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdd98188cbb1f97661145cd32aa58b439006f86127561138b9456269f1dd5d91 |
|
MD5 | 38b44f43e7b69e8040a92dc403c35689 |
|
BLAKE2b-256 | 776ec1fcc5d1c56cbe65c53cf880379cb5da50bf36bdbcdd449283d807bba176 |