As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Como gerenciar dependências do Python em requirements.txt
Este tópico descreve como instalar e gerenciar dependências do Python em um arquivo `requirements.txt` para um ambiente Amazon Managed Workflows for Apache Airflow.
**Contents**
+ [Como testar DAGs usando o utilitário Amazon MWAA CLI](#best-practices-dependencies-cli-utility)
+ [Instalando dependências do Python usando PyPi.org o formato de arquivo de requisitos](#best-practices-dependencies-different-ways)
+ [Opção 1: dependências do Python do Python Package Index](#best-practices-dependencies-pip-extras)
+ [Opção dois: wheel do Python (.whl)](#best-practices-dependencies-python-wheels)
+ [Usando o arquivo `plugins.zip` em um bucket do Amazon S3](#best-practices-dependencies-python-wheels-s3)
+ [Como usar um arquivo WHL hospedado em uma URL](#best-practices-dependencies-python-wheels-url)
+ [Como criar arquivos WHL a partir de um DAG](#best-practices-dependencies-python-wheels-dag)
+ [Opção três: dependências do Python hospedadas em um repositório compatível privado PyPi/PEP-503](#best-practices-dependencies-custom-auth-url)
+ [Como habilitar logs no console do Amazon MWAA](#best-practices-dependencies-troubleshooting-enable)
+ [Acessando registros no console CloudWatch de registros](#best-practices-dependencies-troubleshooting-view)
+ [Como acessar erros na IU do Apache Airflow](#best-practices-dependencies-troubleshooting-aa)
+ [Login no Apache Airflow](#airflow-access-and-login)
+ [Exemplos de cenários `do requirements.txt`](#best-practices-dependencies-ex-mix-match)
## Como testar DAGs usando o utilitário Amazon MWAA CLI
+ O utilitário da interface de linha de comandos (CLI) replica localmente um ambiente do Amazon Managed Workflows for Apache Airflow.
+ A CLI cria localmente uma imagem de contêiner Docker semelhante a uma imagem de produção do Amazon MWAA. Você pode usá-la para executar um ambiente local do Apache Airflow para desenvolver e testar DAGs, plug-ins personalizados e dependências antes da implantação no Amazon MWAA.
+ Para executar a CLI, consulte [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images) on. GitHub
## Instalando dependências do Python usando PyPi.org o formato de arquivo de requisitos
A seção a seguir descreve as diferentes maneiras de instalar dependências do Python de acordo com o Formato do Arquivo de PyPi.org [Requisitos](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format).
### Opção 1: dependências do Python do Python Package Index
A seção a seguir descreve como especificar dependências do Python do [Python Package Index](https://pypi.org/) em um arquivo `requirements.txt`.
------
#### [ Apache Airflow v3 ]
1. **Testar localmente**. Adicione bibliotecas adicionais de forma iterativa para encontrar a combinação certa de pacotes e suas versões, antes de criar um arquivo `requirements.txt`. [Para executar o utilitário Amazon MWAA CLI, consulte aws-mwaa-docker-images em.](https://github.com/aws/amazon-mwaa-docker-images) GitHub
1. **Revise os extras do pacote Apache Airflow**. [Para acessar uma lista dos pacotes instalados para o Apache Airflow v3 no Amazon MWAA, consulte aws-mwaa-docker-images no site. `requirements.txt`](https://github.com/aws/amazon-mwaa-docker-images/blob/main/requirements.txt) GitHub
1. **Adicione uma declaração de restrições**. Adicione o arquivo de restrições do seu ambiente Apache Airflow v3 na parte superior do seu arquivo. `requirements.txt` Os arquivos de restrições do Apache Airflow especificam as versões do provedor disponíveis no momento de um lançamento do Apache Airflow.
No exemplo a seguir, substitua {{{environment-version}}} pelo número da versão do seu ambiente e {{{Python-version}}} pela versão do Python compatível com seu ambiente.
Para obter informações sobre a versão do Python compatível com o ambiente do Apache Airflow, consulte [Versões do Apache Airflow](airflow-versions.md#airflow-versions-official).
```
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-{{{Airflow-version}}}/constraints-{{{Python-version}}}.txt"
```
Se o arquivo de restrições determinar que o pacote `xyz==1.0` não é compatível com outros pacotes em seu ambiente, `pip3 install` não conseguirá impedir que bibliotecas incompatíveis sejam instaladas em seu ambiente. Se a instalação falhar em qualquer pacote, você poderá acessar os registros de erros de cada componente do Apache Airflow (o agendador, o trabalhador e o servidor web) no fluxo de log correspondente em Logs. CloudWatch Para obter mais informações sobre tipos de log, consulte [Acessando os registros do Airflow na Amazon CloudWatch](monitoring-airflow.md).
1. **Pacotes do Apache Airflow**. Adicione os [extras do pacote](http://airflow.apache.org/docs/apache-airflow/2.5.1/extra-packages-ref.html) e a versão (`==`). Isso ajuda a evitar que pacotes com o mesmo nome, mas com versões diferentes, sejam instalados em seu ambiente.
```
apache-airflow[package-extra]==2.5.1
```
1. **Bibliotecas Python**. Adicione o nome do pacote e a versão (`==`) em seu arquivo `requirements.txt`. Isso ajuda a evitar que uma atualização futura [PyPi.org](https://pypi.org)de última hora seja aplicada automaticamente.
```
{{library}} == {{version}}
```
**Example Boto3 e psycopg2-binary**
Esse exemplo de código é fornecido para fins de demonstração. As bibliotecas boto e psycopg2-binary estão incluídas na instalação básica do Apache Airflow v3 e não precisam ser especificadas em um arquivo `requirements.txt`.
```
boto3==1.17.54
boto==2.49.0
botocore==1.20.54
psycopg2-binary==2.8.6
```
Se um pacote for especificado sem uma versão, o Amazon MWAA instalará a versão mais recente do pacote a partir de. [PyPi.org](https://pypi.org) Essa versão pode entrar em conflito com outros pacotes em seu `requirements.txt`.
------
#### [ Apache Airflow v2 ]
1. **Testar localmente**. Adicione bibliotecas adicionais de forma iterativa para encontrar a combinação certa de pacotes e suas versões, antes de criar um arquivo `requirements.txt`. [Para executar o utilitário Amazon MWAA CLI, consulte aws-mwaa-docker-images em.](https://github.com/aws/amazon-mwaa-docker-images) GitHub
1. **Revise os extras do pacote Apache Airflow**. [Para acessar uma lista dos pacotes instalados para o Apache Airflow v2 no Amazon MWAA, acesse aws-mwaa-docker-images no site. `requirements.txt`](https://github.com/aws/amazon-mwaa-docker-images/blob/main/requirements.txt) GitHub
1. **Adicione uma declaração de restrições**. Adicione o arquivo de restrições do seu ambiente Apache Airflow v2 na parte superior do seu arquivo `requirements.txt`. Os arquivos de restrições do Apache Airflow especificam as versões do provedor disponíveis no momento de um lançamento do Apache Airflow.
A partir do Apache Airflow v2.7.2, seu arquivo de requisitos deve incluir uma declaração `--constraint`. Se você não fornecer uma restrição, o Amazon MWAA especificará uma para garantir que os pacotes listados em seus requisitos sejam compatíveis com a versão do Apache Airflow que você está usando.
No exemplo a seguir, substitua {{{environment-version}}} pelo número da versão do seu ambiente e {{{Python-version}}} pela versão do Python compatível com seu ambiente.
Para obter informações sobre a versão do Python compatível com o ambiente do Apache Airflow, consulte [Versões do Apache Airflow](airflow-versions.md#airflow-versions-official).
```
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-{{{Airflow-version}}}/constraints-{{{Python-version}}}.txt"
```
Se o arquivo de restrições determinar que o pacote `xyz==1.0` não é compatível com outros pacotes em seu ambiente, `pip3 install` não conseguirá impedir que bibliotecas incompatíveis sejam instaladas em seu ambiente. Se a instalação falhar em qualquer pacote, você poderá acessar os registros de erros de cada componente do Apache Airflow (o agendador, o trabalhador e o servidor web) no fluxo de log correspondente em Logs. CloudWatch Para obter mais informações sobre tipos de log, consulte [Acessando os registros do Airflow na Amazon CloudWatch](monitoring-airflow.md).
1. **Pacotes do Apache Airflow**. Adicione os [extras do pacote](http://airflow.apache.org/docs/apache-airflow/2.5.1/extra-packages-ref.html) e a versão (`==`). Isso ajuda a evitar que pacotes com o mesmo nome, mas com versões diferentes, sejam instalados em seu ambiente.
```
apache-airflow[package-extra]==2.5.1
```
1. **Bibliotecas Python**. Adicione o nome do pacote e a versão (`==`) em seu arquivo `requirements.txt`. Isso ajuda a evitar que uma atualização futura [PyPi.org](https://pypi.org)de última hora seja aplicada automaticamente.
```
{{library}} == {{version}}
```
**Example Boto3 e psycopg2-binary**
Esse exemplo de código é fornecido para fins de demonstração. As bibliotecas boto e psycopg2-binary estão incluídas na instalação básica do Apache Airflow v2 e não precisam ser especificadas em um arquivo `requirements.txt`.
```
boto3==1.17.54
boto==2.49.0
botocore==1.20.54
psycopg2-binary==2.8.6
```
Se um pacote for especificado sem uma versão, o Amazon MWAA instalará a versão mais recente do pacote a partir de. [PyPi.org](https://pypi.org) Essa versão pode entrar em conflito com outros pacotes em seu `requirements.txt`.
------
### Opção dois: wheel do Python (.whl)
O wheel do Python é um formato de pacote projetado para enviar bibliotecas com artefatos compilados. Há vários benefícios em usar pacotes wheel como um método para instalar dependências no Amazon MWAA:
+ **Instalação mais rápida**: os arquivos WHL são copiados para o contêiner como um único ZIP e depois instalados localmente, sem precisar baixar um por um.
+ **Menos conflitos**: você pode determinar a compatibilidade de versões de seus pacotes com antecedência. Como resultado, não há necessidade de `pip` para elaborar recursivamente versões compatíveis.
+ **Mais resiliência**: com bibliotecas hospedadas externamente, os requisitos posteriores podem mudar, resultando em incompatibilidade de versões entre contêineres em um ambiente do Amazon MWAA. Por não depender de uma fonte externa para dependências, cada contêiner tem as mesmas bibliotecas, independentemente de quando cada contêiner é instanciado.
Recomendamos os seguintes métodos para instalar dependências do Python a partir de um arquivo wheel do Python (`.whl`) no seu arquivo `requirements.txt`.
**Topics**
+ [Usando o arquivo `plugins.zip` em um bucket do Amazon S3](#best-practices-dependencies-python-wheels-s3)
+ [Como usar um arquivo WHL hospedado em uma URL](#best-practices-dependencies-python-wheels-url)
+ [Como criar arquivos WHL a partir de um DAG](#best-practices-dependencies-python-wheels-dag)
#### Usando o arquivo `plugins.zip` em um bucket do Amazon S3
O agendador, os trabalhadores e o servidor web do Apache Airflow (para o Apache Airflow v2.2.2 e versões posteriores) pesquisam plug-ins personalizados durante a inicialização no contêiner Fargate gerenciado para seu ambiente em. AWS`/usr/local/airflow/plugins/{{*}}` Esse processo começa antes de `pip3 install -r requirements.txt` do Amazon MWAA para as dependências do Python e da inicialização do serviço no Apache Airflow. Um arquivo `plugins.zip` pode ser usado para qualquer arquivo que você não queira que seja alterado continuamente durante a execução do ambiente ou que você não queira conceder acesso aos usuários que gravem DAGs. Por exemplo, arquivos de wheel de biblioteca Python, arquivos PEM de certificado e arquivos YAML de configuração.
A seção a seguir descreve como instalar um wheel que está no arquivo `plugins.zip` em seu bucket do Amazon S3.
1. **Baixe os arquivos WHL necessários** Você pode usar [https://pip.pypa.io/en/stable/cli/pip_download/](https://pip.pypa.io/en/stable/cli/pip_download/) com seu `requirements.txt` existente no [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images) do Amazon MWAA ou em outro contêiner do [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2) para solucionar e baixar os arquivos necessários do wheel do Python.
```
pip3 download -r "$AIRFLOW_HOME/dags/requirements.txt" -d "$AIRFLOW_HOME/plugins"
cd "{{$AIRFLOW_HOME}}/plugins"
zip "{{$AIRFLOW_HOME}}/plugins.zip" *
```
1. **Especifique o caminho em seu `requirements.txt`**. Especifique o diretório de plug-ins na parte superior do seu requirements.txt usando [https://pip.pypa.io/en/stable/cli/pip_install/#install-find-links](https://pip.pypa.io/en/stable/cli/pip_install/#install-find-links) e instrua `pip` a não instalar de outras fontes usando [https://pip.pypa.io/en/stable/cli/pip_install/#install-no-index](https://pip.pypa.io/en/stable/cli/pip_install/#install-no-index), conforme mostrado no seguinte código:
```
--find-links /usr/local/airflow/plugins
--no-index
```
**Example wheel em requirements.txt**
O exemplo a seguir pressupõe que você tenha carregado o wheel em um arquivo `plugins.zip` na raiz do seu bucket do Amazon S3. Por exemplo:
```
--find-links /usr/local/airflow/plugins
--no-index
numpy
```
O Amazon MWAA busca o wheel `numpy-1.20.1-cp37-cp37m-manylinux1_x86_64.whl` da pasta `plugins` e o instala em seu ambiente.
#### Como usar um arquivo WHL hospedado em uma URL
A seção a seguir descreve como instalar um wheel hospedado em uma URL. A URL deve ser acessível publicamente ou de dentro do Amazon VPC personalizado que você especificou para seu ambiente do Amazon MWAA.
+ **Forneça um URL**. Forneça o URL de um wheel em seu arquivo `requirements.txt`.
**Example arquivo wheel em um URL público**
O exemplo a seguir baixa um wheel de um site público.
```
--find-links https://files.pythonhosted.org/packages/
--no-index
```
O Amazon MWAA busca o wheel a partir da URL que você especificou e a instala em seu ambiente.
**nota**
Os URLs não são acessíveis a partir de servidores Web privados que instalam requisitos no Amazon MWAA v2.2.2 e versões posteriores.
#### Como criar arquivos WHL a partir de um DAG
Se você tem um ambiente de **rede privada** usando o Apache Airflow v2.2.2 ou posterior e não consegue instalar os requisitos porque seu ambiente não tem acesso a repositórios externos, você pode usar o seguinte DAG para pegar seus requisitos existentes do Amazon MWAA e empacotá-los no Amazon S3:
```
from airflow import DAG
from airflow.operators.bash_operator import BashOperator
from airflow.utils.dates import days_ago
S3_BUCKET = 'my-s3-bucket'
S3_KEY = 'backup/plugins_whl.zip'
with DAG(dag_id="create_whl_file", schedule_interval=None, catchup=False, start_date=days_ago(1)) as dag:
cli_command = BashOperator(
task_id="bash_command",
bash_command=f"mkdir /tmp/whls;pip3 download -r /usr/local/airflow/requirements/requirements.txt -d /tmp/whls;zip -j /tmp/plugins.zip /tmp/whls/*;aws s3 cp /tmp/plugins.zip s3://{{amzn-s3-demo-bucket}}/{{{S3_KEY}}}"
)
```
Depois de executar o DAG, use esse novo arquivo como seu `plugins.zip` do Amazon MWAA, opcionalmente, empacotado com outros plug-ins. Em seguida, atualize seus `requirements.txt` precedidos por `--find-links /usr/local/airflow/plugins` e `--no-index` sem adicionar `--constraint`.
Esse método permite que você use as mesmas bibliotecas off-line.
### Opção três: dependências do Python hospedadas em um repositório compatível privado PyPi/PEP-503
A seção a seguir descreve como instalar um extra do Apache Airflow hospedado em uma URL privada com autenticação.
1. Adicione seu nome de usuário e senha como [opções de configuração do Apache Airflow](configuring-env-variables.md). Por exemplo:
+ `foo.user` : `{{YOUR_USER_NAME}}`
+ `foo.pass` : `{{YOUR_PASSWORD}}`
1. crie seu arquivo `requirements.txt`. Substitua os espaços reservados no exemplo a seguir pelo seu URL privado e pelo nome de usuário e senha que você adicionou como [opções de configuração do Apache Airflow](configuring-env-variables.md). Por exemplo:
```
--index-url https://${AIRFLOW__FOO__USER}:${AIRFLOW__FOO__PASS}@my.privatepypi.com
```
1. adicione outras bibliotecas ao seu arquivo `requirements.txt`. Por exemplo:
```
--index-url https://${AIRFLOW__FOO__USER}:${AIRFLOW__FOO__PASS}@my.privatepypi.com
my-private-package==1.2.3
```
## Como habilitar logs no console do Amazon MWAA
A [função de execução](mwaa-create-role.md) do seu ambiente Amazon MWAA precisa de permissão para enviar registros para CloudWatch Logs. Para atualizar as permissões de um perfil de execução, consulte [Perfil de execução do Amazon MWAA](mwaa-create-role.md).
Você pode ativar os logs do Apache Airflow no nível `INFO`, `WARNING`, `ERROR` e `CRITICAL`. Quando você escolhe um nível de log, o Amazon MWAA envia logs desse nível e de todos os níveis mais altos de severidade. Por exemplo, se você habilitar registros no `INFO` nível, o Amazon MWAA enviará `INFO` registros e `WARNING``ERROR`, e níveis de `CRITICAL` log para CloudWatch Logs. Recomendamos habilitar os logs do Apache Airflow no nível `INFO` do agendador para acessar os logs recebidos para `requirements.txt`.
## Acessando registros no console CloudWatch de registros
Você pode acessar os logs do Apache Airflow para o agendador que agendar seus fluxos de trabalho e analisar sua pasta `dags`. As etapas a seguir descrevem como abrir o grupo de registros para o agendador no console do Amazon MWAA e acessar os registros do Apache Airflow no console Logs. CloudWatch
**Para acessar os registros de um `requirements.txt`**
1. Abra a [página Ambientes](https://console.aws.amazon.com/mwaa/home#/environments) no console do Amazon MWAA.
1. Escolha um ambiente.
1. Escolha **grupo de logs de agendador do Airflow** no painel **Monitoramento**.
1. Escolha o log `requirements_install_ip` em **Fluxos de logs**.
1. Consulte a lista de pacotes que foram instalados no ambiente em `/usr/local/airflow/.local/bin`. Por exemplo:
```
Collecting appdirs==1.4.4 (from -r /usr/local/airflow/.local/bin (line 1))
Downloading https://files.pythonhosted.org/packages/3b/00/2344469e2084fb28kjdsfiuyweb47389789vxbmnbjhsdgf5463acd6cf5e3db69324/appdirs-1.4.4-py2.py3-none-any.whl
Collecting astroid==2.4.2 (from -r /usr/local/airflow/.local/bin (line 2))
```
1. Analise a lista de pacotes e verifique se algum deles encontrou algum erro durante a instalação. Se algo der errado, pode ocorrer um erro semelhante ao seguinte:
```
2021-03-05T14:34:42.731-07:00
No matching distribution found for LibraryName==1.0.0 (from -r /usr/local/airflow/.local/bin (line 4))
No matching distribution found for LibraryName==1.0.0 (from -r /usr/local/airflow/.local/bin (line 4))
```
## Como acessar erros na IU do Apache Airflow
Você também pode verificar sua IU do Apache Airflow para identificar se um erro pode estar relacionado a outro problema. O erro mais comum que você pode encontrar com o Apache Airflow no Amazon MWAA é:
```
Broken DAG: No module named {{x}}
```
Se ocorrer esse erro na IU do Apache Airflow, provavelmente está faltando uma dependência necessária em seu arquivo `requirements.txt`.
### Login no Apache Airflow
Você precisa de [Política de acesso à interface do Apache Airflow: AmazonMWAAWebServerAccess](access-policies.md#web-ui-access) permissões para que seu Conta da AWS in AWS Identity and Access Management (IAM) acesse sua interface de usuário do Apache Airflow.
**Para acessar sua IU do Apache Airflow**
1. Abra a [página Ambientes](https://console.aws.amazon.com/mwaa/home#/environments) no console do Amazon MWAA.
1. Escolha um ambiente.
1. Escolha **Abrir a IU do Airflow**.
## Exemplos de cenários `do requirements.txt`
Você pode misturar e combinar diferentes formatos no seu `requirements.txt`. O exemplo a seguir usa uma combinação das diferentes formas de instalar extras.
**Example Extras PyPi.org ativados e um URL público**
Você precisa usar a `--index-url` opção ao especificar pacotes de PyPi.org, além dos pacotes em uma URL pública, como URLs de repositório personalizados compatíveis com PEP 503.
```
aws-batch == 0.6
phoenix-letter >= 0.3
--index-url http://dist.repoze.org/zope2/2.10/simple
zopelib
```