Token: {{ cookie('token') }}
``` -------------------------------- ### Registering Package Routes and Controllers Source: https://docs.masonite.dev/digging-deeper/package-development Illustrates how to register route files and specify controller locations for a package. The `controllers()` method should be called before `routes()` to ensure controllers are resolved correctly. ```python def configure(self): ( self.root("super_awesome_package") .name("super_awesome") .controllers("controllers") # before routes ! .routes("routes/api.py", "routes/web.py") ) ``` -------------------------------- ### Create a Blog View Template Source: https://docs.masonite.dev/getting-started/create-a-blog Create an HTML file in the 'templates' directory to serve as the view for your blog route. ```html This is a blog ``` -------------------------------- ### Configure PyPI Authentication Source: https://docs.masonite.dev/digging-deeper/package-development Example of a .pypirc file configuration using an API token for authentication with PyPI. Replace 'pypi-AgEIcHlwaS5vcmcCJGNjYjA4M...' with your actual token. ```ini [distutils] index-servers = pypi pypitest [pypi] username=__token__ password=pypi-AgEIcHlwaS5vcmcCJGNjYjA4M... ``` -------------------------------- ### Creating a Custom Facade Source: https://docs.masonite.dev/architecture/facades This shows the basic structure for creating your own facade by inheriting from the base Facade class and defining a container key. ```python from masonite.facades import Facade class YourFacade(metaclass=Facade): key = 'container_key' ``` -------------------------------- ### Aggregate Column Count Source: https://docs.masonite.dev/orm/query-builder Get the count of a column. An alias can be specified using the 'as' modifier. ```python .count('column as alias') ``` -------------------------------- ### Aggregate Column Sum Source: https://docs.masonite.dev/orm/query-builder Get the sum of a column. An alias can be specified using the 'as' modifier. ```python .sum('column as alias') ``` -------------------------------- ### Using Built-in Mail Facade Source: https://docs.masonite.dev/architecture/facades This shows how to use the Mail facade as a shortcut to send emails, importing it from the masonite.facades namespace. ```python from masonite.facades import Mail Mail.send() ``` -------------------------------- ### Aggregate Column Average Source: https://docs.masonite.dev/orm/query-builder Get the average of a column. An alias can be specified using the 'as' modifier. ```python .avg('column as alias') ``` -------------------------------- ### Initialize Pusher Client Instance Source: https://docs.masonite.dev/digging-deeper/broadcasting Create a new Pusher instance on the client-side using your application's key and cluster. It is recommended to use environment variables for credentials instead of hardcoding them. ```javascript const pusher = new Pusher("478b45309560f3456211", { cluster: "eu", }); ``` -------------------------------- ### Get All Records Source: https://docs.masonite.dev/orm/query-builder Fetch all records from a table using the all() method. This is typically used when no chaining is involved. ```python builder.table('users').all() # SELECT * from `users` ``` -------------------------------- ### Checking Route Existence Source: https://docs.masonite.dev/testing/http-tests Verifies if a route exists by using the get and post test methods. ```python def test_route_exists(self): self.assertTrue(self.get('/testing')) self.assertTrue(self.post('/testing')) ``` -------------------------------- ### Show All Posts Method Source: https://docs.masonite.dev/getting-started/create-a-blog Retrieves all posts from the database and renders the 'posts' view, passing the list of posts to the template. ```python from app.models.Post import Post ... def show(self, view: View): posts = Post.all() return view.render('posts', {'posts': posts}) ``` -------------------------------- ### Get Request Method Source: https://docs.masonite.dev/the-basics/request Retrieve the current request method. Ensure the Request class is imported. ```python from masonite.request import Request #.. def show(self, request: Request): request.get_request_method() #== PUT ``` -------------------------------- ### Create a Full Path URL Source: https://docs.masonite.dev/digging-deeper/helpers Use the url helper to create a full URL based on the APP_URL configuration. It accepts a path and optional query parameters. ```python from masonite.helpers import url url.url("/dashboard") #== example.com/dashboard ``` ```python url.url("/search/users", query_params={"search": "John Doe" "order": "asc"}) #== http://masonite.app/users/?search=John%2Doe&order=asc ``` -------------------------------- ### Create Migration with Table Creation Boilerplate Source: https://docs.masonite.dev/orm/schema-and-migrations Use the --create flag to generate a migration file with boilerplate code for creating a new table. ```bash $ masonite-orm migration migration_for_users_table --create users ``` -------------------------------- ### Get Request Path Source: https://docs.masonite.dev/the-basics/request Retrieve the current request URI. Ensure the Request class is imported. ```python from masonite.request import Request #.. def show(self, request: Request): request.get_path() #== /dashboard/1 ``` -------------------------------- ### Route for Showing All Posts Source: https://docs.masonite.dev/getting-started/create-a-blog Defines a GET route for '/posts' that maps to the 'show' method in the PostController. ```python Route.get('/posts', 'PostController@show') ``` -------------------------------- ### Create PyPI Configuration File Source: https://docs.masonite.dev/digging-deeper/package-development Generate the .pypirc file in your home directory to configure PyPI credentials. This command moves the file to the correct location. ```bash make pypirc ``` -------------------------------- ### Create New Masonite Application Source: https://docs.masonite.dev/getting-started/installation Creates a new Masonite application named 'blog'. This command initiates an interactive wizard to configure the application stack, frontend preset, and database. ```bash $ masonite new blog ``` -------------------------------- ### Aggregate Column Min Source: https://docs.masonite.dev/orm/query-builder Get the minimum value of a column. An alias can be specified using the 'as' modifier. ```python .min('column as alias') ``` -------------------------------- ### Registering Package Migrations Source: https://docs.masonite.dev/digging-deeper/package-development Shows how to register migration files from a package using the `migrations()` method. These files will be published to the project's database migrations directory when the package publish command is run. ```python def configure(self): ( self.root("super_awesome_package") .name("super_awesome") .migrations("migrations/create_some_table.py", "migrations/create_other_table.py") ) ``` -------------------------------- ### Aggregate Column Max Source: https://docs.masonite.dev/orm/query-builder Get the maximum value of a column. An alias can be specified using the 'as' modifier. ```python .max('column as alias') ``` -------------------------------- ### Execute Query with Chained Methods Source: https://docs.masonite.dev/orm/query-builder Use the get() method to execute a query after chaining multiple methods. ```python builder.table('users').select('username').get() ``` -------------------------------- ### Add Masonite Classifier to setup.py Source: https://docs.masonite.dev/digging-deeper/package-development Include the 'Framework :: Masonite' classifier in your setup.py file to make your package discoverable on PyPI as a Masonite package. ```python # setup.py classifiers=[ #... "Framework :: Masonite", ] ``` -------------------------------- ### Create Resource with Craft Source: https://docs.masonite.dev/official-packages/collapsar/quickstart Generate a new resource for a Masonite Model using the craft command. ```bash python craft resource MyModel ``` -------------------------------- ### Get Subdomain from Host Source: https://docs.masonite.dev/the-basics/request Extract the subdomain from the incoming request host. Assumes a valid host format. ```python from masonite.request import Request #.. def show(self, request: Request): # URI: work.example.com request.get_subdomain() #== work ``` -------------------------------- ### Show Migration SQL Dumps Source: https://docs.masonite.dev/orm/schema-and-migrations Preview the SQL statements that will be executed by migrations without actually running them. Use the `-s` or `--show` flag with `craft migrate` or `craft migrate:rollback`. ```bash python craft migrate -s ``` -------------------------------- ### Get Header from Request Source: https://docs.masonite.dev/the-basics/request Retrieve a specific header from the incoming request. The Request class must be imported. ```python from masonite.request import Request #.. def show(self, request: Request): request.header('X-Custom') ``` -------------------------------- ### Get Cookie from Request Source: https://docs.masonite.dev/the-basics/request Fetch a cookie from the incoming request headers. Ensure the Request class is imported. ```python from masonite.request import Request #.. def show(self, request: Request): request.cookie('Accepted-Cookies') ``` -------------------------------- ### Specify Connection with QueryBuilder Source: https://docs.masonite.dev/orm/query-builder Initialize the QueryBuilder and specify a connection on the fly using the 'on' method. ```python from masoniteorm.query import QueryBuilder builder = QueryBuilder().on('staging').table("users") ``` -------------------------------- ### Render a View from Controller Source: https://docs.masonite.dev/the-basics/controllers Renders a specific view file ('views.welcome') using the injected View class. ```python def show(self, view: View): return view.render("views.welcome") ``` -------------------------------- ### Get Authenticated User Source: https://docs.masonite.dev/security/authentication Retrieve the currently authenticated user object. Returns None if no user is authenticated. ```python from masonite.authentication import Auth from masonite.request import Request def login(self, auth: Auth, request: Request): user = auth.user() #==
Copyright {{ copyright }}
```
--------------------------------
### Implement Post Creation in Store Method
Source: https://docs.masonite.dev/getting-started/create-a-blog
This snippet shows the implementation of the `store` method in `BlogController.py`. It imports the `Post` model and `Request` object to create a new post using form input and associates it with the authenticated user.
```python
from app.models.Post import Post
from masonite.request import Request
# ...
def store(self, request: Request):
Post.create(
title=request.input('title'),
body=request.input('body'),
author_id=request.user().id
)
return 'post created'
```
--------------------------------
### Method Docstring with Dependencies Example
Source: https://docs.masonite.dev/prologue/contributing-guide
When methods have dependencies or parameters, specify them in the docstring, including their type and a brief description. For object dependencies, provide the module path.
```python
def route(self, route, output):
"""Load the route into the class. This also looks for the controller and attaches it to the route.
Arguments:
route {string} -- This is a URI to attach to the route (/dashboard/user).
output {string|object} -- Controller to attach to the route.
Returns:
self
"""
```
```python
def __init__(self, request: Request, csrf: Csrf, view: View):
"""Initialize the CSRF Middleware
Arguments:
request {masonite.request.Request} -- The normal Masonite request class.
csrf {masonite.auth.Csrf} -- CSRF auth class.
view {masonite.view.View} -- The normal Masonite view class.
Returns:
self
"""
pass
```
--------------------------------
### Serve Static Files from S3 Configuration
Source: https://docs.masonite.dev/the-basics/static-files
Example of configuring S3 as a static file storage with a specific bucket path. This configuration is used with the `asset()` template function.
```python
....
's3': {
's3_client': 'sIS8shn...'
...
'path': 'https://s3.us-east-2.amazonaws.com/bucket'
},
....
```
--------------------------------
### Get Route Parameter
Source: https://docs.masonite.dev/the-basics/request
Access route parameters from the request object. Ensure the parameter is defined in your route definition.
```python
from masonite.request import Request
#..
def show(self, request: Request):
# GET /dashboard?user_id=1
request.param('user_id') #== 1
```
--------------------------------
### Displaying Files with Asset Helper
Source: https://docs.masonite.dev/digging-deeper/filesystem
Combines a base path from filesystem configuration with a filename to generate a displayable URL for assets. Requires the `path` to be set in the disk configuration.
```html