musha

Musha: A python framework built for learning purposes

PyPI

musha is a Python web framework built for learning purposes.

It’s a WSGI framework and can be used with any WSGI application server such as Gunicorn.

Important packages: musha is built with

gunicorn
webob
parse
requests-wsgi-adapter
jinja2
whitenoise

Installation

pip install musha

How to use it

Basic usage:

from musha.api import API

app = API()

# Function based views
@app.route("/home")
def home(request, response):
    response.text = "Hello from the HOME page"


@app.route("/hello/{name}")
def greeting(request, response, name):
    response.text = f"Hello, {name}"

@app.route("/sum/{num_1:d}/{num_2:d}")
def sum(request, response, num_1, num_2):
    total = int(num_1) + int(num_2)
    response.text = f"{num_1} + {num_2} = {total}"


@app.route("/books")
class BookView: # This is a class based view
    def get(self, req, resp):
        resp.text = "Books Page"

    def post(self, req, resp):
        resp.text = "Endpoint to create a book"

# Different data endpoints
@app.route("/template")
def template_handler(req, resp):
    resp.html = app.template("index.html", context={"name": "Musha", "title": "Best Framework"}) #Return a template

@app.route("/json")
def json_handler(req, resp):
    resp.json = {"name": "data", "type": "JSON"} #return json

@app.route("/text")
def text_handler(req, resp):
    resp.text = "This is a simple text" #return text

# Testing Django based routes
def handler(req, resp):
    resp.text = "sample"
app.add_route("/sample", handler)

Start Server

gunicorn app:<name-of-app>

Unit Tests

The recommended way of writing unit tests is with pytest. There are two built in fixtures that you may want to use when writing unit tests with Musha. The first one is app which is an instance of the main API class:

def test_route_overlap_throws_exception(app):
    @app.route("/")
    def home(req, resp):
        resp.text = "Welcome Home."

    with pytest.raises(AssertionError):
        @app.route("/")
        def home2(req, resp):
            resp.text = "Welcome Home2."

The other one is client that you can use to send HTTP requests to your handlers. It is based on the famous requests and it should feel very familiar:

def test_parameterized_route(app, client):
    @app.route("/{name}")
    def hello(req, resp, name):
        resp.text = f"hey {name}"

    assert client.get("http://testserver/matthew").text == "hey matthew"

Templates

The default folder for templates is templates. You can change it when initializing the main API() class:

app = API(templates_dir="templates_dir_name")

Then you can use HTML files in that folder like so in a handler:

@app.route("/show/template")
def handler_with_template(req, resp):
    resp.html = app.template(
        "example.html", context={"title": "Awesome Framework", "body": "welcome to the future!"})

Static Files

Just like templates, the default folder for static files is static and you can override it:

app = API(static_dir="static_dir_name")

Then you can use the files inside this folder in HTML files:

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <title></title>

  <link href="/static/main.css" rel="stylesheet" type="text/css">
</head>

<body>
    <h1></h1>
    <p>This is a paragraph</p>
</body>
</html>

Middleware

You can create custom middleware classes by inheriting from the musha.middleware.Middleware class and overriding its two methods that are called before and after each request:

from musha.api import API
from musha.middleware import Middleware

app = API()

class SimpleCustomMiddleware(Middleware):
    def process_request(self, req):
        print("Before dispatch", req.url)

    def process_response(self, req, res):
        print("After dispatch", req.url)

app.add_middleware(SimpleCustomMiddleware)

from musha.api import API
from musha.middleware import Middleware

app = API()

# Custome exception handlers
def custom_exception_handler(request, response, exception_cls):
    response.text = str(exception_cls)
app.add_exception_handler(custom_exception_handler)

class SimpleCustomMiddleware(Middleware):
    def process_request(self, req):
        print("Before dispatch", req.url)

    def process_response(self, req, res):
        print("After dispatch", req.url)

app.add_middleware(SimpleCustomMiddleware)