The source content for blog.juliobiason.me
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

231 lines
11 KiB

<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<!-- Enable responsiveness on mobile devices-->
<!-- viewport-fit=cover is to support iPhone X rounded corners and notch in landscape-->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1, viewport-fit=cover">
<title>Julio Biason .Me 4.3</title>
<!-- CSS -->
<link rel="stylesheet" href="https://blog.juliobiason.me/print.css" media="print">
<link rel="stylesheet" href="https://blog.juliobiason.me/poole.css">
<link rel="stylesheet" href="https://blog.juliobiason.me/hyde.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400italic,700|Abril+Fatface">
</head>
<body class=" ">
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="https:&#x2F;&#x2F;blog.juliobiason.me"><h1>Julio Biason .Me 4.3</h1></a>
<p class="lead">Old school dev living in a 2.0 dev world</p>
</div>
<ul class="sidebar-nav">
<li class="sidebar-nav-item"><a href="&#x2F;">English</a></li>
<li class="sidebar-nav-item"><a href="&#x2F;pt">Português</a></li>
<li class="sidebar-nav-item"><a href="&#x2F;tags">Tags (EN)</a></li>
<li class="sidebar-nav-item"><a href="&#x2F;pt&#x2F;tags">Tags (PT)</a></li>
</ul>
</div>
</div>
<div class="content container">
<div class="post">
<h1 class="post-title">Flask em 40 Minutos ou Menos: Iniciando</h1>
<span class="post-date">
2017-09-25
<a href="https://blog.juliobiason.me/pt/tags/python/">#python</a>
<a href="https://blog.juliobiason.me/pt/tags/flask/">#flask</a>
<a href="https://blog.juliobiason.me/pt/tags/uwsgi/">#uwsgi</a>
<a href="https://blog.juliobiason.me/pt/tags/companion-post/">#companion post</a>
</span>
<p>Uma &quot;breve&quot; explicação de como colocar uma aplicação Flask em produção em 40
minutos. Nessa primeira parte, vamos mostrar como começar um script Flask.</p>
<span id="continue-reading"></span>
<p>Flask é um micro framework web em Python, muito fácil de ser usado e
configurado. Mas o processo inteiro de como começar a aplicação, adicionar
rotas e depois disso partir para colocar em produção pode ser uma pequena dor
de cabeça. Então veremos como fazer todo o processo.</p>
<h2 id="o-virtualenv">O VirtualEnv</h2>
<p>O primeiro passo de qualquer grande aplicação Python é o VirtualEnv.
VirtualEnv é utilizado para separar as bibliotecas do Python entre aplicações
-- assim você pode ter a biblioteca X numa versão para um determinado projeto
e outra versão para outro projeto. Apenas lembre-se que o VirtualEnv gerencia
apenas bibliotecas do <em>Python</em>, portanto não espere que o mesmo controle
versões diferentes de MySQL, por exemplo.</p>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>VirtualEnv não vai cuidar da versão do MySQL, mas pode controlar a versão do driver para Python.&quot;)</p>
</div>
<p>Para criar um VirtualEnv:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>python -m venv venv
</span></code></pre>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Se ainda estiver usando Python 2, o comando é <code>virtualenv venv</code>.</p>
</div>
<p>Depois de executar esse comando, você verá que irá surgir um diretório
<code>venv</code>. O último parâmetro é justamente o diretório que será utilizado para
armazenar as informações do VirtualEnv e pode ser criado com qualquer nome e
em qualquer lugar -- inclusive fora do projeto [#venvwrapper]_.</p>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Alguns pacotes como o <a href="http://virtualenvwrapper.readthedocs.io/en/latest/">VirtualEnvWrapper</a>_
fazem exatamente isso: Os pacotes são instalados em um diretório separado,
apenas para VirtualEnvs.</p>
</div>
<p>Uma vez criado o VirtualEnv, é preciso ativar o mesmo:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>source venv/bin/active
</span></code></pre>
<p>Ou, se estiver usando Windows (sim, você pode rodar os comandos no Windows):</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>venv/Scripts/activate.bat
</span></code></pre>
<p>Se tudo deu certo, deve aparecer um <code>(venv)</code> no começo do prompt, indicando
que o VirtualEnv está ativo.</p>
<p>Apenas note o seguinte: O VirtualEnv foi projetado para ser destruído e
reconstruído quantas vezes forem necessárias. Por isso, você <em>não deve</em>
adicionar o diretório do VirtualEnv no seu repositório;
quem precisar utilizar, que recrie o ambiente.</p>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Além de não colocar o diretório do virtualenv no seu repositório, tente não
instalar pacotes Python utilizando o sistema de pacotes da sua distribuição.</p>
</div>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>O que o <code>venv</code> faz é criar vários scripts para as tarefas
relacionadas com o mesmo -- como a ativação do VirtualEnv -- e estes
scripts mantém o caminho de onde foram criados. Com isso, se você adicionar
o mesmo no seu sistema de controle de versão, somente você poderá usar (a
não ser que a outra pessoa tenha exatamente a mesma estrutura de
diretórios). Lembre-se: VirtualEnvs existem para conter as bibliotecas que
você usa e podem ser destruídos e criados livremente -- E como podem ser
criados facilmente, não devem ser incluídos no seu controle de versão -- e
se estou me repetindo, é porque <em>muitas</em> pessoas fazem isso, erroneamente.</p>
</div>
<h2 id="requirements-txt">Requirements.txt</h2>
<p>O modo mais fácil de instalar um pacote -- dentro de um VirtualEnv, obviamente
-- é utilizando o módulo <code>pip</code>:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>python -m pip install flask
</span></code></pre>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Ou, se ainda estiver usando Python 2, <code>pip install</code> -- se
realmente preferir, você pode usar <code>pip install</code> mesmo com Python 3, pois
ele instala um alias para <code>python -m pip</code>.</p>
</div>
<p>Mas, como comentado sobre VirtualEnv, onde a ideia é criar, destruir e criar o
ambiente quantas vezes você quiser, ficar passando a lista de pacotes a serem
instalados não faz sentido. Por isso, normalmente é gerado um arquivo com a
lista de requisitos. Esse arquivo, mais por convenção da comunidade do que por
requisito da ferramenta, é o chamado <code>requirements.txt</code> Nesse
arquivo você pode colocar a lista de requisitos do seu sistema, incluindo a
versão se necessário.</p>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>E, caso você tenha requisitos que são necessários somente para
desenvolvimento, a convenção diz pra ter um arquivo chamado
<code>requirements-dev.txt</code>, cuja a primeira linha é <code>-r requirements.txt</code>.</p>
</div>
<p>Por exemplo, como a versão do Flask no momento da escrita desse artigo é a
0.12.2, podemos ter um <code>requirements.txt</code> com o seguinte conteúdo:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>flask==0.12.2
</span></code></pre>
<p>... indicando que queremos que seja instala a versão 0.12.2. Existe ainda o
operador <code>~=</code> [#specifiers]_,que significa &quot;versão compatível com a
indicada&quot;. Assim nos precavemos da possibilidade de ser encontrada uma falha
de segurança no Flask, sem precisar sair correndo atrás de todos os
<code>requirements.txt</code> com Flask para atualizar a versão e garantimos que,
quando sair a versão 0.13 (ou qualquer outra seguinte) que seja incompatível
com 0.12.2, nosso código ainda vá funcionar.</p>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Para uma lista de todas as formas de como especificar
versões, olhe o <a href="https://www.python.org/dev/peps/pep-0440/#version-specifiers">PEP 440</a>.</p>
</div>
<p>Assim sendo, teremos um <code>requirements.txt</code> com o seguinte conteúdo:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>flask~=0.12.2
</span></code></pre>
<p>Mas e para instalar isso? Para isso existe a opção <code>-r</code> do pip, que ao invês de
esperar por um nome de pacote para ser instalado, a lista de pacotes é
carregada a partir do arquivo indicado. Então para
gerar o ambiente:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>python -m pip install -r requirements.txt
</span></code></pre>
<h2 id="o-esqueleto-de-uma-aplicacao-flask">O Esqueleto de uma Aplicação Flask</h2>
<p>Para verificar se tudo está instalado corretamente, você pode utilizar o
seguinte arquivo de exemplo:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>from flask import Flask
</span><span>
</span><span>app = Flask(__name__)
</span><span>
</span><span>
</span><span>@app.route(&#39;/&#39;)
</span><span>def index():
</span><span> return &#39;Olá&#39;
</span></code></pre>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Apenas lembre-se de <em>não</em> chamar o nome do arquivo de <code>flask.py</code>,
porque esse é o nome do módulo e ao invés de importar o módulo do Flask,
ele vai tentar importar o conteúdo do próprio arquivo e, como o objeto
<code>Flask</code> não existe, você vai receber um erro de <code>ImportError: cannot import name 'Flask'</code>.</p>
</div>
<p>E para executar:</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>FLASK_APP=main.py flask run
</span></code></pre>
<div style="border:1px solid grey; margin:7px; padding: 7px">
<p>Se você percebeu, a variável <code>FLASK_APP</code> foi definida com o
nome <code>main.py</code>; esse é o nome que eu escolhi para a minha aplicação (e o
nome do arquivo fonte -- aquele que não pode ser <code>flask.py</code>),
mas você pode usar o nome que quiser. Apenas lembre-se de usar esse mesmo
nome em <code>FLASK_APP</code>.</p>
</div>
<p>Se estiver tudo ok, você deve receber a mensagem</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>* Serving Flask app &quot;main&quot;
</span><span>* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
</span></code></pre>
<p>E acessando a URL indicada, você deverá ver o &quot;Olá&quot;.</p>
<p>Até aqui vimos como instalar e iniciar um projeto Flask básico. No próximo
post vou falar da aplicação Flask em si.</p>
</div>
</div>
</body>
</html>