Helpers

Masonite has several helpers available. Many helpers are used internally to help write clean Masonite code but can be used in your projects as well.
Url
Url
The Url helper allows you to create a full path URL:
from masonite.helpers import url
​
url.url("/dashboard") #== example.com/dashboard
The URL will come from the APP_URL in your application config file.
It accepts a dictionary to add query string parameters when building the url:
url.url("/search/users",  query_params={"search": "John Doe" "order": "asc"})
#== http://masonite.app/users/?search=John%2Doe&order=asc
Asset
You can also generate a URL for an asset:
url.asset("s3.invoices", "invoice-01-2021.pdf")
Route
You can also generate a URL for a route by its route name:
url.route("users.profile", {"id": 1}) #== http://masonite.app/users/1/profile/
You can also generate just a path:
url.route("users.profile", {"id": 1}, absolute=False) #== /users/1/profile/
It accepts a dictionary to add query string parameters when building the route url:
url.route("user.profile", {"id": 1}, query_params={"preview": 1})
#== http://masonite.app/users/1/profile/?preview=1
Compact
The compact helper is a shortcut helper when you want to compile a dictionary from variables.
There are times when you will have instances like this:
from masonite.view import View
​
def show(self, view: View):
  users = User.all()
  articles = Article.all()
  return view.render('some.view', {"users": users, "articles": articles})
Notice we repeated the users and articles key the same as the variables name. In this case we can use the compact helper to clean the code up a bit:
from masonite.view import View
from masonite.helpers import compact
​
def show(self, view: View):
  users = User.all()
  articles = Article.all()
  return view.render('some.view', compact(users, articles))
Optional
The optional helper takes an object and allows any method calls on the object. If the method exists on the object it will return the value or else it will return None:
You may have a peice of code that looks like this:
if request.user() and request.user().admin == 1:
  #.. do something
with the optional helper you can condense the code into something like this:
from masonite.helpers import optional
​
if optional(request.user()).admin == 1:
  #.. do something
Dump
You can easily dump variables into console for debugging, from inside a controller for example: For this you can use Dump facade or the built-in dump python method:
from masonite.facades import Dump
​
test = 1
data = {"key": "value"}
Dump.dump(test, data)
​
# OR
​
dump(test, data)
This will dump data in console in a nice format to ease debugging.
Dump and Die
If you want the code to stop and renders a dump page instead you can use the dump and die helper named dd:
from masonite.facades import Dump
​
test = 1
data = {"key": "value"}
Dump.dd(test, data)
​
# OR
​
dd(test, data)
This will stop code at this line and renders a nice dump page where you can see all variables dumped until now.
Note that dumps will accumulate into session. If you want to clear dumps, you can use Dump.clear() or you can enable the HTTP middleware ClearDumpsBetweenRequestsMiddleware to clear dumps between every requests.
Kernel.py
from masonite.middleware import ClearDumpsBetweenRequestsMiddleware
​
class Kernel:
​
    http_middleware = [
        #...
        ClearDumpsBetweenRequestsMiddleware
    ]
Last modified 6mo ago