2024-08-16 15:09:07 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "UTF-8" >
< title > Quart-Imp Blueprint Introduction | Quart-Imp</ title >
< link rel = "stylesheet" href = "static/water.css" >
< link rel = "stylesheet" href = "static/pygments.emacs-dull.css" >
< link rel = "apple-touch-icon" sizes = "180x180" href = "static/apple-touch-icon.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "static/favicon-32x32.png" >
< link rel = "icon" type = "image/png" sizes = "16x16" href = "static/favicon-16x16.png" >
< link rel = "manifest" href = "static/site.webmanifest" >
< link rel = "mask-icon" href = "static/safari-pinned-tab.svg" color = "#5bbad5" >
< meta name = "msapplication-TileColor" content = "#da532c" >
< meta name = "theme-color" content = "#ffffff" >
</ head >
< body >
< aside >
2024-08-16 15:36:56 +01:00
< img src = "static/quart-Imp-Medium.png" alt = "Quart-Imp Logo" style = "margin-top: 20px; width: 50%" >
2024-08-16 15:09:07 +01:00
< h1 > Quart-Imp</ h1 >
< div >< small > Version: 1.0.x</ small ></ div >
< div >< small > Last Updated:</ small ></ div >
< div >< small > Fri, 16 Aug 2024</ small ></ div >
< h2 > Menu</ h2 >
< ul >
< li >< a href = "index.html" >< strong > Index</ strong ></ a ></ li >
</ ul >
< ul >
< li >< strong > CLI Commands</ strong ></ li >
< ul >
< li >< a href = "cli_commands-quart-imp_init.html" > quart-imp init</ a ></ li >
< li >< a href = "cli_commands-quart-imp_blueprint.html" > quart-imp blueprint</ a ></ li >
</ ul >
< li >< strong > Imp</ strong ></ li >
< ul >
< li >< a href = "imp-introduction.html" > Introduction</ a ></ li >
< li >< a href = "imp-init_app-init.html" > init_app, __init__</ a ></ li >
< li >< a href = "imp-init_session.html" > init_session</ a ></ li >
< li >< a href = "imp-import_app_resources.html" > import_app_resources</ a ></ li >
< li >< a href = "imp-import_blueprint.html" > import_blueprint</ a ></ li >
< li >< a href = "imp-import_blueprints.html" > import_blueprints</ a ></ li >
</ ul >
< li >< strong > ImpBlueprint</ strong ></ li >
< ul >
< li >< a href = "impblueprint-introduction.html" > Introduction</ a ></ li >
< li >< a href = "impblueprint-init.html" > __init__</ a ></ li >
< li >< a href = "impblueprint-import_resources.html" > import_resources</ a ></ li >
< li >< a href = "impblueprint-import_nested_blueprint.html" > import_nested_blueprint</ a ></ li >
< li >< a href = "impblueprint-import_nested_blueprints.html" > import_nested_blueprints</ a ></ li >
< li >< a href = "impblueprint-tmpl.html" > tmpl</ a ></ li >
</ ul >
< li >< strong > quart_imp.config</ strong ></ li >
< ul >
< li >< a href = "quart_imp_config-quartconfig.html" > QuartConfig</ a ></ li >
< li >< a href = "quart_imp_config-impconfig.html" > ImpConfig</ a ></ li >
< li >< a href = "quart_imp_config-impblueprintconfig.html" > ImpBlueprintConfig</ a ></ li >
</ ul >
< li >< strong > quart_imp.security</ strong ></ li >
< ul >
< li >< a href = "quart_imp_security-login_check.html" > login_check</ a ></ li >
< li >< a href = "quart_imp_security-permission_check.html" > permission_check</ a ></ li >
< li >< a href = "quart_imp_security-pass_function_check.html" > pass_function_check</ a ></ li >
< li >< a href = "quart_imp_security-api_login_check.html" > api_login_check</ a ></ li >
< li >< a href = "quart_imp_security-include_csrf.html" > include_csrf</ a ></ li >
</ ul >
< li >< strong > quart_imp.auth</ strong ></ li >
< ul >
< li >< a href = "quart_imp_auth-encrypt_password.html" > encrypt_password</ a ></ li >
< li >< a href = "quart_imp_auth-authenticate_password.html" > authenticate_password</ a ></ li >
< li >< a href = "quart_imp_auth-generate_password.html" > generate_password</ a ></ li >
< li >< a href = "quart_imp_auth-generate_salt.html" > generate_salt</ a ></ li >
< li >< a href = "quart_imp_auth-generate_csrf_token.html" > generate_csrf_token</ a ></ li >
< li >< a href = "quart_imp_auth-generate_private_key.html" > generate_private_key</ a ></ li >
< li >< a href = "quart_imp_auth-generate_email_validator.html" > generate_email_validator</ a ></ li >
< li >< a href = "quart_imp_auth-generate_numeric_validator.html" > generate_numeric_validator</ a ></ li >
< li >< a href = "quart_imp_auth-generate_alphanumeric_validator.html" > generate_alphanumeric_validator</ a ></ li >
< li >< a href = "quart_imp_auth-is_email_address_valid.html" > is_email_address_valid</ a ></ li >
< li >< a href = "quart_imp_auth-is_username_valid.html" > is_username_valid</ a ></ li >
</ ul >
</ ul >
< div style = "padding-top: 5px; margin-bottom: 20px;" >< small > Hosted on GitHub Pages.</ small ></ div >
</ aside >
< section >
< h1 style = "font-size: 2.6rem; margin: 0;" > Quart-Imp Blueprint Introduction</ h1 >
< p > The Quart-Imp Blueprint inherits from the Quart Blueprint class, then adds some additional methods to allow for auto
importing of resources and other nested blueprints.</ p >
< p > The Quart-Imp Blueprint requires you to provide the < code > ImpBlueprintConfig</ code > class as the second argument to the Blueprint.</ p >
< p > Here's an example of a Quart-Imp Blueprint structure:</ p >
< div class = "highlight" >< pre >< span ></ span > www/
├── nested_blueprints/
│ ├── blueprint_one/
│ │ ├── ...
│ │ └── __init__.py
│ └── blueprint_two/
│ ├── ...
│ └── __init__.py
├── standalone_nested_blueprint/
│ ├── ...
│ └── __init__.py
├── routes/
│ └── index.py
├── static/
│ └── ...
├── templates/
│ └── www/
│ └── index.html
└── __init__.py
</ pre ></ div >
< p > File: < code > __init__.py</ code ></ p >
< div class = "highlight" >< pre >< span ></ span >< span class = "kn" > from</ span > < span class = "nn" > quart_imp</ span > < span class = "kn" > import</ span > < span class = "n" > ImpBlueprint</ span >
< span class = "kn" > from</ span > < span class = "nn" > quart_imp.config</ span > < span class = "kn" > import</ span > < span class = "n" > ImpBlueprintConfig</ span >
< span class = "n" > bp</ span > < span class = "o" > =</ span > < span class = "n" > ImpBlueprint</ span >< span class = "p" > (</ span >< span class = "vm" > __name__</ span >< span class = "p" > ,</ span > < span class = "n" > ImpBlueprintConfig</ span >< span class = "p" > (</ span >
< span class = "n" > enabled</ span >< span class = "o" > =</ span >< span class = "kc" > True</ span >< span class = "p" > ,</ span >
< span class = "n" > url_prefix</ span >< span class = "o" > =</ span >< span class = "s2" > " /www" </ span >< span class = "p" > ,</ span >
< span class = "n" > static_folder</ span >< span class = "o" > =</ span >< span class = "s2" > " static" </ span >< span class = "p" > ,</ span >
< span class = "n" > template_folder</ span >< span class = "o" > =</ span >< span class = "s2" > " templates" </ span >< span class = "p" > ,</ span >
< span class = "n" > init_session</ span >< span class = "o" > =</ span >< span class = "p" > {</ span >< span class = "s2" > " logged_in" </ span >< span class = "p" > :</ span > < span class = "kc" > False</ span >< span class = "p" > },</ span >
< span class = "p" > ))</ span >
< span class = "n" > bp</ span >< span class = "o" > .</ span >< span class = "n" > import_resources</ span >< span class = "p" > (</ span >< span class = "s2" > " routes" </ span >< span class = "p" > )</ span >
< span class = "n" > bp</ span >< span class = "o" > .</ span >< span class = "n" > import_nested_blueprints</ span >< span class = "p" > (</ span >< span class = "s2" > " nested_blueprints" </ span >< span class = "p" > )</ span >
< span class = "n" > bp</ span >< span class = "o" > .</ span >< span class = "n" > import_nested_blueprint</ span >< span class = "p" > (</ span >< span class = "s2" > " standalone_nested_blueprint" </ span >< span class = "p" > )</ span >
</ pre ></ div >
< p > The < code > ImpBlueprintConfig</ code > class is used to configure the Blueprint. It provides a little more flexibility than the
standard Quart Blueprint configuration, like the ability to enable or disable the Blueprint.</ p >
< p >< code > ImpBlueprintConfig</ code > 's < code > init_session</ code > works the same as < code > ImpConfig</ code > 's < code > init_session</ code > , this will add the session data to
the Quart app's session object on initialization of the Quart app.</ p >
< p > To see more about configuration see: < a href = "quart_imp_config-impblueprintconfig.html" > quart_imp.config / ImpBlueprintConfig</ a ></ p >
< p >< code > import_resources</ code > method will walk one level deep into the < code > routes</ code > folder, and import all < code > .py</ code > files as modules.
For more information see: < a href = "impblueprint-import_resources.html" > ImpBlueprint / import_resources</ a ></ p >
< p >< code > import_nested_blueprints</ code > will do the same as < code > imp.import_blueprints</ code > , but will register the blueprints found as
nested to the current blueprint. For example < code > www.blueprint_one.index</ code ></ p >
< p >< code > import_nested_blueprint</ code > behaves the same as < code > import_nested_blueprints</ code > , but will only import a single blueprint.</ p >
</ section >
</ body >
</ html >
