Додайте префікс до всіх маршрутів Flask

У мене є префікс, який я хочу додати до кожного маршруту. Зараз я додаю константу до маршруту при кожному визначенні. Чи є спосіб зробити це автоматично?

PREFIX = "/abc/123"

@app.route(PREFIX + "/")
def index_page():
  return "This is a website about burritos"

@app.route(PREFIX + "/about")
def about_page():
  return "This is a website about burritos"

Відповідь залежить від того, як ви обслуговуєте цю програму.

Встановлено всередині іншого контейнера WSGI

Припускаючи, що ви збираєтеся запустити цю програму всередині контейнера WSGI (mod_wsgi, uwsgi, gunicorn тощо); вам потрібно фактично встановити цей префікс програми як підрозділ цього контейнера WSGI (все, що говорить WSGI), і встановити APPLICATION_ROOTдля вашого префікса значення конфігурації:

app.config["APPLICATION_ROOT"] = "/abc/123"

@app.route("/")
def index():
    return "The URL for this page is {}".format(url_for("index"))

# Will return "The URL for this page is /abc/123/"

Встановлюючи APPLICATION_ROOTзначення конфігурації, просто обмежте файл cookie сеансу Flask цим префіксом URL. Все інше буде автоматично оброблено для вас завдяки чудовим можливостям обробки WSGI від Flask та Werkzeug.

Приклад належної установки програми

Якщо ви не впевнені, що означає перший абзац, погляньте на цей приклад програми із встановленою всередині колбою:

from flask import Flask, url_for
from werkzeug.serving import run_simple
from werkzeug.wsgi import DispatcherMiddleware

app = Flask(__name__)
app.config['APPLICATION_ROOT'] = '/abc/123'

@app.route('/')
def index():
    return 'The URL for this page is {}'.format(url_for('index'))

def simple(env, resp):
    resp(b'200 OK', [(b'Content-Type', b'text/plain')])
    return [b'Hello WSGI World']

app.wsgi_app = DispatcherMiddleware(simple, {'/abc/123': app.wsgi_app})

if __name__ == '__main__':
    app.run('localhost', 5000)

Подання запитів на додаток

Якщо, з іншого боку, ви запускатимете свою програму Flask у корені її контейнера WSGI і проксіруватимете до неї запити (наприклад, якщо це буде FastCGI'd, або якщо nginx виконує proxy_pass-ing-запити на під-кінцеву точку на ваш автономний uwsgi/ geventсервер, тоді ви можете:

• Використовуйте План, на що вказує Мігель у своїй відповіді .
• або скористайтеся DispatcherMiddlewareвід werkzeug(або PrefixMiddlewareвід відповіді su27 ), щоб встановити додаток на автономному сервері WSGI, який ви використовуєте. (Див . Приклад правильного підмонтування програми вище, щоб дізнатися про код, який потрібно використовувати).

Ви можете розмістити свої маршрути в проекті:

bp = Blueprint('burritos', __name__,
                        template_folder='templates')

@bp.route("/")
def index_page():
  return "This is a website about burritos"

@bp.route("/about")
def about_page():
  return "This is a website about burritos"

Потім ви реєструєте креслення програми за допомогою префікса:

app = Flask(__name__)
app.register_blueprint(bp, url_prefix='/abc/123')

Слід зазначити, що APPLICATION_ROOTНЕ для цієї мети.

Все, що вам потрібно зробити, це написати проміжне програмне забезпечення, щоб внести такі зміни:

1. змінити, PATH_INFOщоб обробити префікс URL-адреси.
2. модифікувати, SCRIPT_NAMEщоб згенерувати префікс url.

Подобається це:

class PrefixMiddleware(object):

    def __init__(self, app, prefix=''):
        self.app = app
        self.prefix = prefix

    def __call__(self, environ, start_response):

        if environ['PATH_INFO'].startswith(self.prefix):
            environ['PATH_INFO'] = environ['PATH_INFO'][len(self.prefix):]
            environ['SCRIPT_NAME'] = self.prefix
            return self.app(environ, start_response)
        else:
            start_response('404', [('Content-Type', 'text/plain')])
            return ["This url does not belong to the app.".encode()]

Оберніть свій додаток проміжним програмним забезпеченням, наприклад:

from flask import Flask, url_for

app = Flask(__name__)
app.debug = True
app.wsgi_app = PrefixMiddleware(app.wsgi_app, prefix='/foo')


@app.route('/bar')
def bar():
    return "The URL for this page is {}".format(url_for('bar'))


if __name__ == '__main__':
    app.run('0.0.0.0', 9010)

Відвідайте http://localhost:9010/foo/bar,

Ви отримаєте правильний результат: The URL for this page is /foo/bar

І не забудьте встановити домен cookie, якщо вам потрібно.

Це рішення дано суттю Larivact . Це APPLICATION_ROOTне для цієї роботи, хоча, схоже, буде. Це справді бентежить.

Це більше відповідь на python, ніж відповідь Flask / werkzeug; але це просто і працює.

Якщо, як і я, ви хочете, щоб параметри програми (завантажені з .iniфайлу) також містили префікс програми Flask (таким чином, щоб значення не було встановлено під час розгортання, а під час виконання), ви можете вибрати наступне:

def prefix_route(route_function, prefix='', mask='{0}{1}'):
  '''
    Defines a new route function with a prefix.
    The mask argument is a `format string` formatted with, in that order:
      prefix, route
  '''
  def newroute(route, *args, **kwargs):
    '''New function to prefix the route'''
    return route_function(mask.format(prefix, route), *args, **kwargs)
  return newroute

Можливо, це дещо хаком і спирається на той факт , що функція маршруту колба вимагаєroute в якості першого позиційного аргументу.

Ви можете використовувати його так:

app = Flask(__name__)
app.route = prefix_route(app.route, '/your_prefix')

NB: Нічого не варто, щоб можна було використовувати змінну в префіксі (наприклад, встановивши її в /<prefix>), а потім обробити цей префікс у функціях, які ви прикрашаєте @app.route(...). Якщо ви це зробите, вам, очевидно, доведеться оголосити prefixпараметр у ваших оформлених функціях. Крім того, ви можете перевірити поданий префікс на відповідність деяким правилам і повернути 404, якщо перевірка не вдасться. Щоб уникнути повторної реалізації 404, будь ласка, from werkzeug.exceptions import NotFoundа потім, raise NotFound()якщо перевірка не вдасться.

Отже, я вважаю, що на це справедлива відповідь: префікс повинен бути налаштований у фактичному сервері, який ви використовуєте, коли розробка завершена. Apache, nginx тощо.

Однак якщо ви хочете, щоб це працювало під час розробки під час запуску програми Flask у налагодженні, погляньте на цю суть .

Колба DispatcherMiddlewareна допомогу!

Я скопіюю тут код для нащадків:

"Serve a Flask app on a sub-url during localhost development."

from flask import Flask


APPLICATION_ROOT = '/spam'


app = Flask(__name__)
app.config.from_object(__name__)  # I think this adds APPLICATION_ROOT
                                  # to the config - I'm not exactly sure how!
# alternatively:
# app.config['APPLICATION_ROOT'] = APPLICATION_ROOT


@app.route('/')
def index():
    return 'Hello, world!'


if __name__ == '__main__':
    # Relevant documents:
    # http://werkzeug.pocoo.org/docs/middlewares/
    # http://flask.pocoo.org/docs/patterns/appdispatch/
    from werkzeug.serving import run_simple
    from werkzeug.wsgi import DispatcherMiddleware
    app.config['DEBUG'] = True
    # Load a dummy app at the root URL to give 404 errors.
    # Serve app at APPLICATION_ROOT for localhost development.
    application = DispatcherMiddleware(Flask('dummy_app'), {
        app.config['APPLICATION_ROOT']: app,
    })
    run_simple('localhost', 5000, application, use_reloader=True)

Тепер при запуску вищезазначеного коду як автономної програми Flask http://localhost:5000/spam/відображатиметься Hello, world!.

У коментарі до іншої відповіді я висловив побажання зробити щось подібне:

from flask import Flask, Blueprint

# Let's pretend module_blueprint defines a route, '/record/<id>/'
from some_submodule.flask import module_blueprint

app = Flask(__name__)
app.config['APPLICATION_ROOT'] = '/api'
app.register_blueprint(module_blueprint, url_prefix='/some_submodule')
app.run()

# I now would like to be able to get to my route via this url:
# http://host:8080/api/some_submodule/record/1/

Застосування DispatcherMiddlewareдо мого надуманого прикладу:

from flask import Flask, Blueprint
from flask.serving import run_simple
from flask.wsgi import DispatcherMiddleware

# Let's pretend module_blueprint defines a route, '/record/<id>/'
from some_submodule.flask import module_blueprint

app = Flask(__name__)
app.config['APPLICATION_ROOT'] = '/api'
app.register_blueprint(module_blueprint, url_prefix='/some_submodule')
application = DispatcherMiddleware(Flask('dummy_app'), {
    app.config['APPLICATION_ROOT']: app
})
run_simple('localhost', 5000, application, use_reloader=True)

# Now, this url works!
# http://host:8080/api/some_submodule/record/1/

Інший зовсім інший спосіб - це використання точок монтування в uwsgi.

Від документа про розміщення кількох додатків в одному процесі ( постійна посилання ).

У свою uwsgi.iniви додаєте

[uwsgi]
mount = /foo=main.py
manage-script-name = true

# also stuff which is not relevant for this, but included for completeness sake:    
module = main
callable = app
socket = /tmp/uwsgi.sock

Якщо ви не зателефонували до свого файлу main.py, вам потрібно змінити і mountіmodule

Ви main.pyможете виглядати так:

from flask import Flask, url_for
app = Flask(__name__)
@app.route('/bar')
def bar():
  return "The URL for this page is {}".format(url_for('bar'))
# end def

І конфігурація nginx (знову ж для повноти):

server {
  listen 80;
  server_name example.com

  location /foo {
    include uwsgi_params;
    uwsgi_pass unix:///temp/uwsgi.sock;
  }
}

Тепер дзвінок example.com/foo/barвідображатиметься /foo/barяк повернений у колбі url_for('bar'), оскільки він адаптується автоматично. Таким чином ваші посилання працюватимуть без проблем із префіксами.

from flask import Flask

app = Flask(__name__)

app.register_blueprint(bp, url_prefix='/abc/123')

if __name__ == "__main__":
    app.run(debug='True', port=4444)


bp = Blueprint('burritos', __name__,
                        template_folder='templates')

@bp.route('/')
def test():
    return "success"

Мені знадобився подібний так званий "context-root". Я робив це у конф-файлі під /etc/httpd/conf.d/ за допомогою WSGIScriptAlias:

myapp.conf:

<VirtualHost *:80>
    WSGIScriptAlias /myapp /home/<myid>/myapp/wsgi.py

    <Directory /home/<myid>/myapp>
        Order deny,allow
        Allow from all
    </Directory>

</VirtualHost>

Тож тепер я можу отримати доступ до свого додатка як: http: // localhost: 5000 / myapp

Дивіться посібник - http://modwsgi.readthedocs.io/en/develop/user-guides/quick-configuration-guide.html

Моє рішення, коли програми flask та PHP співіснують nginx та PHP5.6

Зберігайте колбу в кореневій системі та PHP у підкаталогах

sudo vi /etc/php/5.6/fpm/php.ini

Додайте 1 рядок

cgi.fix_pathinfo=0

sudo vi /etc/php/5.6/fpm/pool.d/www.conf
listen = /run/php/php5.6-fpm.sock

uwsgi

sudo vi /etc/nginx/sites-available/default

ВИКОРИСТУЙТЕ НАДАННІ ЛОКАЦІЇ для PHP і нехай FLASK залишається в корені

server {
    listen 80 default_server;
    listen [::]:80 default_server;

    # SSL configuration
    #
    # listen 443 ssl default_server;
    # listen [::]:443 ssl default_server;
    #
    # Note: You should disable gzip for SSL traffic.
    # See: https://bugs.debian.org/773332
    #
    # Read up on ssl_ciphers to ensure a secure configuration.
    # See: https://bugs.debian.org/765782
    #
    # Self signed certs generated by the ssl-cert package
    # Don't use them in a production server!
    #
    # include snippets/snakeoil.conf;

    root /var/www/html;

    # Add index.php to the list if you are using PHP
    index index.html index.htm index.php index.nginx-debian.html;

    server_name _;

    # Serve a static file (ex. favico) outside static dir.
    location = /favico.ico  {    
        root /var/www/html/favico.ico;    
    }

    # Proxying connections to application servers
    location / {
        include            uwsgi_params;
        uwsgi_pass         127.0.0.1:5000;
    }

    location /pcdp {
        location ~* \.php$ {
            try_files $uri =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$;
            fastcgi_pass unix:/var/run/php/php5.6-fpm.sock;
            fastcgi_index index.php;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            include fastcgi_params;
        }
    }

    location /phpmyadmin {
        location ~* \.php$ {
            try_files $uri =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$;
            fastcgi_pass unix:/var/run/php/php5.6-fpm.sock;
            fastcgi_index index.php;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            include fastcgi_params;
        }
    }

    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #   include snippets/fastcgi-php.conf;
    #
    #   # With php7.0-cgi alone:
    #   fastcgi_pass 127.0.0.1:9000;
    #   # With php7.0-fpm:
    #   fastcgi_pass unix:/run/php/php7.0-fpm.sock;
    #}

    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #   deny all;
    #}
}

УВАЖНО ПРОЧИТАЙТЕ https://www.digitalocean.com/community/tutorials/understanding-nginx-server-and-location-block-selection-algorithms

Нам потрібно зрозуміти відповідність розташування (жодного): Якщо немає модифікаторів, розташування інтерпретується як відповідність префіксу. Це означає, що вказане розташування буде збігатися з початком URI запиту для визначення відповідності. =: Якщо використовується знак рівності, цей блок вважатиметься збігом, якщо URI запиту точно відповідає вказаному розташуванню. ~: Якщо присутній модифікатор тильди, це місце буде інтерпретовано як збіг регулярних виразів, чутливий до регістру. ~ *: Якщо використовується модифікатор тильди та зірочки, блок розташування буде інтерпретований як збіг регулярних виразів, що не враховує регістр. ^ ~: Якщо присутній модифікатор карат і тильда, і якщо цей блок вибрано як найкращий збіг нерегулярних виразів, збіг регулярних виразів не відбудеться.

Важливо замовлення, з опису "розташування" nginx:

Щоб знайти місце, яке відповідає заданому запиту, nginx спочатку перевіряє місця, визначені за допомогою рядків префікса (розташування префіксу). Серед них вибирається та запам'ятовується місце з найдовшим відповідним префіксом. Потім перевіряються регулярні вирази в порядку їх появи у файлі конфігурації. Пошук регулярних виразів закінчується в першій відповідності, і використовується відповідна конфігурація. Якщо не знайдено збігу з регулярним виразом, тоді використовується конфігурація пам'яті, що запам'ятовувалася раніше.

Це означає:

First =. ("longest matching prefix" match)
Then implicit ones. ("longest matching prefix" match)
Then regex. (first match)

Для людей, які все ще борються з цим, перший приклад працює, але повний приклад тут, якщо у вас є програма Flask, яка не під вашим контролем:

from os import getenv
from werkzeug.middleware.dispatcher import DispatcherMiddleware
from werkzeug.serving import run_simple
from custom_app import app

application = DispatcherMiddleware(
    app, {getenv("REBROW_BASEURL", "/rebrow"): app}
)

if __name__ == "__main__":
    run_simple(
        "0.0.0.0",
        int(getenv("REBROW_PORT", "5001")),
        application,
        use_debugger=False,
        threaded=True,
    )