2019-06-18 22:08:20 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-07-30 22:48:40 +00:00
< title > pylorax.api.flask_blueprint — Lorax 31.9 documentation< / title >
2019-06-18 22:08:20 +00:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "../../../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../../../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../../../_static/language_data.js" > < / script >
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
< link rel = "stylesheet" href = "../../../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../../_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "../../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../../search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../../index.html" class = "icon icon-home" > Lorax
< / a >
< div class = "version" >
2019-07-30 22:48:40 +00:00
31.9
2019-06-18 22:08:20 +00:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../intro.html" > Introduction to Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../intro.html#before-lorax" > Before Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax.html" > Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../livemedia-creator.html" > livemedia-creator< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax-composer.html" > lorax-composer< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../composer-cli.html" > composer-cli< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../product-images.html" > Product and Updates Images< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../modules.html" > src< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../../index.html" > Lorax< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../../index.html" > Docs< / a > » < / li >
< li > < a href = "../../index.html" > Module code< / a > » < / li >
< li > < a href = "../../pylorax.html" > pylorax< / a > » < / li >
< li > pylorax.api.flask_blueprint< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for pylorax.api.flask_blueprint< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "c1" > #< / span >
< span class = "c1" > # Copyright (C) 2019 Red Hat, Inc.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is free software; you can redistribute it and/or modify< / span >
< span class = "c1" > # it under the terms of the GNU General Public License as published by< / span >
< span class = "c1" > # the Free Software Foundation; either version 2 of the License, or< / span >
< span class = "c1" > # (at your option) any later version.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is distributed in the hope that it will be useful,< / span >
< span class = "c1" > # but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< span class = "c1" > # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< span class = "c1" > # GNU General Public License for more details.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # You should have received a copy of the GNU General Public License< / span >
< span class = "c1" > # along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< span class = "c1" > #< / span >
< span class = "sd" > " " " Flask Blueprints that support skipping routes< / span >
< span class = "sd" > When using Blueprints for API versioning you will usually want to fall back< / span >
< span class = "sd" > to the previous version' s rules for routes that have no new behavior. To do< / span >
< span class = "sd" > this we add a ' skip_rule' list to the Blueprint' s options dictionary. It lists< / span >
< span class = "sd" > all of the routes that you do not want to register.< / span >
< span class = "sd" > For example:< / span >
< span class = "sd" > from pylorax.api.v0 import v0< / span >
< span class = "sd" > from pylorax.api.v1 import v1< / span >
< span class = "sd" > server.register_blueprint(v0, url_prefix=" /api/v0/" )< / span >
< span class = "sd" > server.register_blueprint(v0, url_prefix=" /api/v1/" , skip_rules=[" /blueprints/list" ]< / span >
< span class = "sd" > server.register_blueprint(v1, url_prefix=" /api/v1/" )< / span >
< span class = "sd" > This will register all of v0' s routes under `/api/v0`, and all but `/blueprints/list` under /api/v1,< / span >
< span class = "sd" > and then register v1' s version of `/blueprints/list` under `/api/v1`< / span >
< span class = "sd" > " " " < / span >
< span class = "kn" > from< / span > < span class = "nn" > flask< / span > < span class = "k" > import< / span > < span class = "n" > Blueprint< / span >
< span class = "kn" > from< / span > < span class = "nn" > flask.blueprints< / span > < span class = "k" > import< / span > < span class = "n" > BlueprintSetupState< / span >
< div class = "viewcode-block" id = "BlueprintSetupStateSkip" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.flask_blueprint.BlueprintSetupStateSkip" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > BlueprintSetupStateSkip< / span > < span class = "p" > (< / span > < span class = "n" > BlueprintSetupState< / span > < span class = "p" > ):< / span >
< span class = "k" > def< / span > < span class = "nf" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > blueprint< / span > < span class = "p" > ,< / span > < span class = "n" > app< / span > < span class = "p" > ,< / span > < span class = "n" > options< / span > < span class = "p" > ,< / span > < span class = "n" > first_registration< / span > < span class = "p" > ,< / span > < span class = "n" > skip_rules< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _skip_rules< / span > < span class = "o" > =< / span > < span class = "n" > skip_rules< / span >
< span class = "nb" > super< / span > < span class = "p" > (< / span > < span class = "n" > BlueprintSetupStateSkip< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "n" > blueprint< / span > < span class = "p" > ,< / span > < span class = "n" > app< / span > < span class = "p" > ,< / span > < span class = "n" > options< / span > < span class = "p" > ,< / span > < span class = "n" > first_registration< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "BlueprintSetupStateSkip.add_url_rule" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.flask_blueprint.BlueprintSetupStateSkip.add_url_rule" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > add_url_rule< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > rule< / span > < span class = "p" > ,< / span > < span class = "n" > endpoint< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ,< / span > < span class = "n" > view_func< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > options< / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "n" > rule< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _skip_rules< / span > < span class = "p" > :< / span >
< span class = "nb" > super< / span > < span class = "p" > (< / span > < span class = "n" > BlueprintSetupStateSkip< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > add_url_rule< / span > < span class = "p" > (< / span > < span class = "n" > rule< / span > < span class = "p" > ,< / span > < span class = "n" > endpoint< / span > < span class = "p" > ,< / span > < span class = "n" > view_func< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > options< / span > < span class = "p" > )< / span > < / div > < / div >
< div class = "viewcode-block" id = "BlueprintSkip" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.flask_blueprint.BlueprintSkip" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > BlueprintSkip< / span > < span class = "p" > (< / span > < span class = "n" > Blueprint< / span > < span class = "p" > ):< / span >
< span class = "k" > def< / span > < span class = "nf" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > (< / span > < span class = "n" > BlueprintSkip< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "BlueprintSkip.make_setup_state" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.flask_blueprint.BlueprintSkip.make_setup_state" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > make_setup_state< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > app< / span > < span class = "p" > ,< / span > < span class = "n" > options< / span > < span class = "p" > ,< / span > < span class = "n" > first_registration< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ):< / span >
< span class = "n" > skip_rules< / span > < span class = "o" > =< / span > < span class = "n" > options< / span > < span class = "o" > .< / span > < span class = "n" > pop< / span > < span class = "p" > (< / span > < span class = "s2" > " skip_rules" < / span > < span class = "p" > ,< / span > < span class = "p" > [])< / span >
< span class = "k" > return< / span > < span class = "n" > BlueprintSetupStateSkip< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > app< / span > < span class = "p" > ,< / span > < span class = "n" > options< / span > < span class = "p" > ,< / span > < span class = "n" > first_registration< / span > < span class = "p" > ,< / span > < span class = "n" > skip_rules< / span > < span class = "p" > )< / span > < / div > < / div >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2018, Red Hat, Inc.
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
