> 백엔드 개발 > 파이썬 튜토리얼 > Python의 Flask 프레임워크 개발 환경을 심층적으로 사용자 정의하기 위한 몇 가지 팁 요약

Python의 Flask 프레임워크 개발 환경을 심층적으로 사용자 정의하기 위한 몇 가지 팁 요약

WBOY
풀어 주다: 2016-08-04 08:55:46
원래의
1050명이 탐색했습니다.

Flask 환경 구성
애플리케이션이 제대로 작동하려면 많은 수의 패키지가 필요할 수 있습니다. Flask 패키지가 필요하지 않다면 잘못된 튜토리얼을 읽었을 수도 있습니다. 애플리케이션 환경은 기본적으로 애플리케이션이 실행될 때 발생하는 모든 일의 기반입니다. 우리는 환경을 쉽게 관리할 수 있는 방법이 많기 때문에 운이 좋습니다.
virtualenv를 사용하여 환경을 관리하세요
virtualenv는 소위 가상 환경에서 애플리케이션을 격리하기 위한 도구입니다. 가상 환경은 애플리케이션이 의존하는 소프트웨어가 포함된 디렉터리입니다. 가상 환경은 개발 환경에 포함된 환경 변수를 유지하기 위해 환경 변수를 변경할 수도 있습니다. Flask와 같은 패키지를 시스템 수준 또는 사용자 수준 패키지 디렉터리에 다운로드하는 대신 애플리케이션에서만 사용되는 별도의 디렉터리에 다운로드할 수 있습니다. 이를 통해 사용되는 Python 버전과 각 프로젝트가 의존하는 패키지를 쉽게 지정할 수 있습니다.
Virtualenv를 사용하면 다른 프로젝트에서 동일한 패키지의 다른 버전을 사용할 수도 있습니다. 이러한 유연성은 이전 시스템을 사용하고 있고 다른 버전이 필요한 여러 프로젝트가 있는 경우 중요할 수 있습니다.
virtualenv를 사용할 때 일반적으로 시스템에 몇 가지 Python 패키지만 설치하면 됩니다. 그 중 하나가 virtualenv 자체입니다. Pip을 사용하여 virtualenv 패키지를 설치할 수 있습니다.
virtualenv가 시스템에 설치되면 가상 환경 생성을 시작할 수 있습니다. 프로젝트가 있는 디렉터리로 이동하여 virtualenv 명령을 실행하세요. 가상 환경의 대상 디렉터리인 하나의 매개 변수가 필요합니다. 다음은 그 모습에 대한 개요입니다.

$ virtualenv venv
New python executable in venv/bin/python
Installing Setuptools...........[...].....done.
Installing Pip..................[...].....done.
로그인 후 복사

virtualenv는 새 디렉터리를 생성하고 종속 패키지가 이 디렉터리에 설치됩니다.
새 가상 환경이 생성되면 가상 환경 내에서 생성된 bin/activate 스크립트를 실행하여 이를 활성화해야 합니다.

$ which python
/usr/local/bin/python
$ source venv/bin/activate
(venv)$ which python
/Users/robert/Code/myapp/venv/bin/python
로그인 후 복사

bin/activate 스크립트는 모든 것이 전역 시스템 대신 새로운 가상 환경을 가리키도록 셸 환경 변수를 일부 변경합니다. 위의 코드 블록에서 효과를 확인할 수 있습니다. 활성화 후 python 명령은 가상 환경의 Python bin 디렉터리를 가리킵니다. 가상 환경이 활성화되면 Pip을 사용하여 설치된 종속성 패키지가 글로벌 시스템이 아닌 가상 환경에 다운로드됩니다.
셸의 프롬프트도 변경되었음을 알 수 있습니다. virtualenv는 현재 활성화된 가상 환경의 이름을 미리 설정하므로 전역 시스템에서 작업하고 있지 않다는 것을 알 수 있습니다.
deactivate 명령을 실행하여 가상 환경을 비활성화할 수 있습니다.

(venv)$ deactivate
로그인 후 복사

virtualenvwrapper
virtualenvwrapper는 virtualenv로 생성된 가상 환경을 관리하기 위한 패키지입니다. 여러분이 virtualenv의 기본 사항을 살펴보고 이 도구의 개선 사항과 사용해야 하는 이유를 이해하기 전까지는 이 도구에 대해 언급하고 싶지 않습니다.
이전 섹션에서 생성된 가상 환경 디렉토리는 프로젝트 라이브러리를 혼란스럽게 만듭니다. 상호 작용하려면 가상 환경을 활성화하기만 하면 되지만 버전 제어에 표시되어서는 안 되므로 가상 환경 디렉터리가 여기에 있어서는 안 됩니다. 해결책은 virtualenvwrapper를 사용하는 것입니다. 이 패키지는 모든 가상 환경을 하나의 디렉터리(보통 기본적으로 ~/.virtualenvs/)에 저장합니다.
virtualenvwrapper를 설치하려면 http://virtualenvwrapper.readthedocs.org/en/latest/install.html에 있는 설명서의 지침을 따르십시오.
virtualenvwrapper를 설치하기 전에 모든 가상 환경을 비활성화했는지 확인하십시오. 가상 환경이 아닌 전역적으로 설치해야 합니다.
이제 환경을 생성하기 위해 virtualenv를 실행하는 대신 mkvirtualenv를 실행해야 합니다.

$ mkvirtualenv rocket
New python executable in rocket/bin/python
Installing setuptools...........[...].....done.
Installing pip..................[...].....done.
(rocket)$

로그인 후 복사

mkvirtualenv는 가상 환경 디렉터리에 폴더를 생성하고 가상 환경을 활성화합니다. 위의 virtualenv와 마찬가지로 Python과 pip는 전역 시스템이 아닌 가상 환경의 바이너리를 가리킵니다. 특정 환경을 활성화하려면 workon [환경 이름] 명령을 사용하십시오. deactivate는 여전히 가상 환경을 비활성화합니다.
종속성 패키지 설치
프로젝트가 성장함에 따라 종속 패키지 목록도 늘어나는 것을 알게 될 것입니다. Flask 애플리케이션을 실행하려면 수십 개의 Python 패키지가 필요한 것은 드문 일이 아닙니다. 이를 관리하는 가장 쉬운 방법은 간단한 텍스트 파일을 사용하는 것입니다. Pip은 설치된 모든 패키지를 나열하는 텍스트 파일을 생성할 수 있습니다. 새로운 시스템이나 새로 생성된 환경에서는 파일의 목록을 읽고 각각 설치하는 것도 가능합니다.

핍 동결:

requirements.txt는 많은 Flask 애플리케이션에서 애플리케이션을 실행하는 데 필요한 모든 패키지를 나열하는 데 사용되는 텍스트 파일입니다. 이 코드 블록은 이 파일을 만드는 방법을 보여주고 다음 코드 블록은 이 파일을 사용하여 새 환경에 종속성을 설치하는 방법을 보여줍니다.

(rocket)$ pip freeze > requirements.txt
$ workon fresh-env
(fresh-env)$ pip install -r requirements.txt
[...]
Successfully installed flask Werkzeug Jinja2 itsdangerous markupsafe
Cleaning up...
(fresh-env)$
로그인 후 복사

人工管理依赖包
随着项目的发展,你可能会发现 pip freeze 列出的某些包实际上并不是运行应用必须的。你安装这些包仅仅为开发用的。pip freeze 并不能区分,它仅仅列出目前已经安装的包。因此,你可能要手动地管理这些依赖包。你可以分别把那些运行应用必须的包放入 require\_run.txt 以及那些开发应用程序需要的包放入 require\_dev.txt 。
版本控制
选择一个版本控制系统并且使用它。我推荐 Git。从我所看到的,Git 是这些天来新项目最流行的选择。能够删除代码而不必担心犯了一个不可逆转的错误是非常宝贵的。你也可以让你的项目摆脱大量注释掉的代码的困扰,因为你可以删除它们,以后如有需要可以恢复它们。另外,你可以在 GitHub,Bitbucket 或者你自己的 Gitolite 服务器上备份整个项目。
置身版本控制之外的文件
我通常会让一个文件置身版本控制之外有两个原因:要么就是它会让整个项目显得混乱,要么它就是一个很隐私的密钥/证书。编译的 .pyc 文件和虚拟环境 — 如果由于某些原因你没有使用 virtualenvwrapper — 就是让项目显得很混乱的例子。它们不需要在版本控制之中因为它们能够分别地从 .py 文件和你的 requirements.txt 文件重新创建。
API 秘钥,应用程序秘钥以及数据库证书是很隐私的密钥/证书的示例。它们不应该出现在版本控制中因为它们的曝光将是一个巨大的安全漏洞。
当做跟安全有关的决定的时候,我总是喜欢假设我的版本库将在某个时候变成公开的。这就意味着要保守秘密并且从不假设一个安全漏洞不会被发现,“谁来猜猜他们能做到”这类型的假设被称为通过隐匿来实现安全,这是十分槽糕的策略。
当使用 Git 的时候,你可以在你的版本库中创建名为 .gitignore 的一个特殊文件。在这个文件里,使用列表通配符来匹配文件名。任何匹配其中一个模式的文件名都会被 Git 给忽略掉。我推荐使用 .gitignore 来控制不需要版本控制的文件。例如:

*.pyc
instance/
로그인 후 복사

Instance 文件夹是用于以一种更安全地方式提供给你的应用程序敏感配置变量。我将会在后面更多地谈到它。
你可以阅读更多的关于 .gitignore 的内容从这里: http://git-scm.com/docs/gitignore
调试
1.调试模式
Flask 有一个称为调试模式方便的功能。要打开调试功能的话,你只必须在你的开发配置中设置 debug = True。当它打开的时候,服务器会在代码变化的时候自动加载并且出错的时候会伴随着一个堆栈跟踪和一个交互式控制台。
小心!不要在生产环境中使用调试模式。交互式控制台允许执行任意代码并会是一个巨大的安全漏洞。
2.Flask-DebugToolbar
Flask-DebugToolbar 是另一个非常了不起的工具,它可以帮助在你的应用程序中调试问题。在调试模式下,它会把一个侧边栏置于你的应用程序的每一页上。侧边栏提供了有关 SQL 查询,日志记录,版本,模板,配置和其它有趣的信息,使得更容易地跟踪问题。
看看快速入门中的 调试模式。在 Flask 官方文档 中有一些关于错误处理,日志记录以及使用调试器等不错的信息。

Flask 工程配置
当你学习 Flask 的时候,配置看起来很简单。你只要在 config.py 中定义一些变量接着一切就能工作了。当你开始必须要管理生产应用的配置的时候,这些简单性开始消失了。你可能需要保护 API 密钥以及为不同的环境使用不同的配置(例如,开发和生产环境)。在本章节中我们会介绍 Flask 一些先进的功能,它可以使得管理配置容易些。
简单的例子
一个简单的应用程序可能不会需要任何这些复杂的功能。你可能只需要把 config.py 放在你的仓库/版本库的根目录并且在 app.py 或者 yourapp/\\_init\\_.py 中加载它。
config.py 文件中应该每行包含一个配置变量赋值。当你的应用程序初始化的时候,在 config.py 中的配置变量用于配置 Flask 和它的扩展并且它们能够通过 app.config 字典访问到 – 例如,app.config["DEBUG"]。

DEBUG = True # Turns on debugging features in Flask
BCRYPT_LEVEL = 12 # Configuration for the Flask-Bcrypt extension
MAIL_FROM_EMAIL = "robert@example.com" # For use in application emails
로그인 후 복사

配置的变量可以被 Flask,它的扩展或者你来使用。这个例子中, 每当我们在一封事务性邮件中需要默认的 “发件人” 的时候,我们可以使用 app.config["MAIL_FROM_EMAIL"] – 例如,密码重置。把这些信息放置于一个配置变量中使得以后能够容易地修改它。

# app.py or app/__init__.pyfrom flask import Flask
app = Flask(__name__)
app.config.from_object('config')
# Now we can access the configuration variables via app.config["VAR_NAME"].
로그인 후 복사

  • DEBUG: 为你提供了调试错误的一些方便的工具。 这包括一个基于 Web 的堆栈跟踪和交互式的 Python 控制台。在开发环境中设置成 True; 生产环境中设置成 False。
  • SECRET\_KEY:这是 Flask 用来为 cookies 签名的密钥。 它也能被像 Flask-Bcrypt 类的扩展使用。 你应该在你的实例文件夹中定义它, 这样可以远离版本控制。 你可以在下一个章节中阅读更多关于示例文件夹的内容。一般情况下这应该是一个复杂的随机值。
  • BCRYPT\_LEVEL:如果你使用 Flask-Bcrypt 来散列用户密码的话, 你需要指定一个“循环”数,这个数是在执行散列密码的 算法需要的。如果你不使用 Flask-Bcrypt,你可以 忽略这里。用于散列密码的循环数越大,攻击者猜测密码 的时间会越长。同时,循环数越大会增加散列密码的时间。后面我们会给出在 Flask 应用中 使用 Bcrypt 的一些最佳实践。

确保在生产环境中 DEBUG 设置成 False。如果保留 DEBUG 为 True,它允许用户在你的服务器上执行任意的 Python。
实例文件夹
有时候你需要定义包含敏感信息的配置变量。我们想要从 config.py 中分离这些变量并且让它们保留在仓库/版本库之外。你可能会隐藏像数据库密码以及 API 密钥的一些敏感信息,或者定义于特定于指定机器的配置变量。为让实现这些要求更加容易些,Flask 提供了一个叫做 instance folders 的功能。实例文件夹是仓库/版本库下的一个子目录并且包含专门为这个应用程序的实例的一个配置文件。我们不希望它提交到版本控制。

config.py
requirements.txt
run.py
instance/
 config.py
yourapp/
 __init__.py
 models.py
 views.py
 templates/
 static/
로그인 후 복사

使用实例文件夹
我们使用 app.config.from_pyfile() 来从一个实例文件夹中加载配置变量。当我们调用 Flask() 来创建我们的应用的时候,如果我们设置了 instance_relative_config=True, app.config.from_pyfile() 将会从 instance/ 目录加载指定文件。

# app.py or app/__init__.py
app = Flask(__name__, instance_relative_config=True)
app.config.from_object('config')
app.config.from_pyfile('config.py')
로그인 후 복사

现在我们可以像在 config.py 中那样在 instance/config.py 中定义配置变量。你也应该把你的实例文件夹加入到版本控制系统的忽略列表中。要使用 Git 做到这一点的话,你需要在 .gitignore 新的一行中添加 instance/ 。
密钥
实例文件夹的隐私性成为在其里面定义不想暴露到版本控制的密钥的最佳候选。这些密钥可能包含了你的应用的密钥或者第三方 API 密钥。如果你的应用是开源的或者以后可能会公开的话,这一点特别重要。我们通常要求其他用户或者贡献者使用自己的密钥。

# instance/config.py
SECRET_KEY = 'Sm9obiBTY2hyb20ga2lja3MgYXNz'
STRIPE_API_KEY = 'SmFjb2IgS2FwbGFuLU1vc3MgaXMgYSBoZXJv'
SQLALCHEMY_DATABASE_URI= \\"postgresql://user:TWljaGHFgiBCYXJ0b3N6a2lld2ljeiEh@localhost/databasename"
로그인 후 복사

基于环境的配置
如果在你的生产环境和开发环境中的差异非常小的话,你可能想要使用实例文件夹来处理配置的变化。定义在 'instance/config.py' 文件中的配置变量能够覆盖 'config.py' 中的值。你只需要在 'app.config.from_object()' 后调用 'app.config.from_pyfile()'。这样用法的好处之一就是在不同的机器上修改你的应用的配置。

# config.py
DEBUG = False
SQLALCHEMY_ECHO = False
# instance/config.py
DEBUG = True
SQLALCHEMY_ECHO = True
로그인 후 복사

在生产环境上,我们略去上面 'instance/-config.py' 中的配置变量,它会退回到定义在 'config.py' 中的值。
了解更多关于 Flask-SQLAlchemy 的 配置项。(中文版的位于:http://www.pythondoc.com/flask-sqlalchemy/config.html#configuration-keys)
基于环境变量配置
实例文件夹不应该出现在版本控制中。这就意味着你将无法跟踪你的实例配置的变化。如果只是一、两个变量这可能不是什么问题,但是如果你在不同的环境上(生产,预升级,开发,等等)配置都有些微调话,你就不会想要存在丢失它们的风险。
Flask 给我们选择配置文件的能力,它可以基于一个环境变量的值来加载不同的配置文件。这就意味着在我们的仓库/版本库里,我们可以有多个配置文件并且总会加载正确的那一个。一旦我们有多个配置文件的话,我可以把它们移入它们自己 config 文件夹中。

requirements.txt
run.py
config/
 __init__.py # Empty, just here to tell Python that it's a package.
 default.py
 production.py
 development.py
 staging.py
instance/
 config.py
yourapp/
 __init__.py
 models.py
 views.py
 static/
 templates/
로그인 후 복사

在上面的文件列表中我们有多个不同的配置文件。

  • config/default.py: 默认的配置值,可用于所有的环境或者被个人的环境给覆盖。
  • config/development.py: 用于开发环境的配置值。这里你可能会指定本地数据库的 URI。
  • config/production.py: 用于生产环境的配置值。在这里 DEBUG 一定要设置成 False。
  • config/staging.py: 根据开发进度,你可能会有一个模拟生产环境,这个文件主要用于这种场景。

为了决定要加载哪个配置文件,我们会调用 'app.config.from_envvar()'。

# yourapp/\\_\\_init\\_\\_.py
app = Flask(__name__, instance_relative_config=True)
# Load the default configuration
app.config.from_object('config.default')
# Load the configuration from the instance folder
app.config.from_pyfile('config.py')
# Load the file specified by the APP\\_CONFIG\\_FILE environment variable# Variables defined here will override those in the default configuration
app.config.from_envvar('APP_CONFIG_FILE')
로그인 후 복사

环境变量的值应该是配置文件的绝对路径。
我们如何设置这个环境变量取决于我们运行应用所在的平台。如果我们运行在一个普通的 Linux 服务器上,我们可以编写一个设置环境变量的 shell 脚本并且运行 run.py。

# start.sh
APP\\_CONFIG\\_FILE=/var/www/yourapp/config/production.py
python run.py
로그인 후 복사

start.sh 对于每一个环境都是独一无二的,因此它应该被排除在版本控制之外。在 Heroku 上,我们需要使用 Heroku 工具来设置环境变量。这种设置方式也适用于其它的 PaaS 平台。

관련 라벨:
원천:php.cn
본 웹사이트의 성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
인기 튜토리얼
더>
최신 다운로드
더>
웹 효과
웹사이트 소스 코드
웹사이트 자료
프론트엔드 템플릿