Imagine a dificuldade de criar um aplicativo extenso, confinado a um único arquivo Python. Embora seja tecnicamente possível, essa abordagem contraria os princípios fundamentais do desenvolvimento de software eficiente, sustentável e reutilizável. Por isso, pacotes e módulos são indispensáveis na construção e evolução de projetos de software.
O que é um Pacote?
No universo Python, um pacote funciona como um organizador para módulos e recursos que compartilham uma relação lógica. Trata-se de um diretório, que pode conter vários módulos Python, subpacotes e outros tipos de recursos.
Os pacotes estabelecem uma hierarquia, permitindo estruturar o código do seu projeto em diferentes níveis de abstração, facilitando a compreensão e manutenção.
Diferenças entre Pacotes e Módulos
Apesar de ambos servirem para organizar o código, pacotes e módulos possuem características distintas:
- Módulo: Refere-se a um único arquivo que contém código Python. Ele pode conter definições de funções, classes, variáveis e outros objetos que podem ser importados e usados em seu projeto.
- Pacote: É um agrupamento de um ou mais módulos, que também pode incluir outros subpacotes. Ele atua como um contêiner para uma coleção de módulos relacionados.
Como Criar um Pacote em Python
Para criar um pacote, siga estas etapas:
Etapa 1: Crie um Diretório de Projeto
Comece criando um diretório para o seu projeto:
estudo_pratico/
Etapa 2: Crie um Diretório de Pacote
Dentro do diretório do seu projeto, crie outro diretório que atuará como diretório do pacote. Escolha um nome que reflita bem o propósito ou funcionalidade do pacote. Este diretório conterá módulos e subpacotes relacionados:
estudo_pratico/ ferramenta_matematica/
Etapa 3: Defina o Arquivo __init__.py do Pacote
Dentro do diretório do pacote, crie um arquivo chamado __init__.py. A presença deste arquivo é que define o diretório como um pacote em Python.
Se você precisar que algum código seja executado sempre que o pacote for utilizado, inclua-o neste arquivo. Caso contrário, ele pode permanecer vazio.
estudo_pratico/
ferramenta_matematica/
__init__.py
Etapa 4: Adicione Módulos ao Pacote
Dentro do diretório do pacote, insira arquivos Python (.py) que definem funções, classes ou variáveis.
Esses módulos são onde o código que provê a funcionalidade do seu pacote é implementado. É possível criar vários módulos dentro do mesmo pacote.
estudo_pratico/
ferramenta_matematica/
__init__.py
operacoes.py
estatistica.py
Etapa 5: Adicione Subpacotes ao Pacote
Se seu pacote necessitar de uma estrutura hierárquica ou contiver funcionalidades distintas, você pode adicionar subpacotes dentro do diretório principal.
Um subpacote nada mais é do que outro diretório que também contém um arquivo __init__.py. Subpacotes promovem uma melhor organização e separação de responsabilidades.
estudo_pratico/
ferramenta_matematica/
__init__.py
operacoes.py
estatistica.py
geometria/
__init__.py
formas.py
calculo/
__init__.py
integracoes.py
Seguindo essas etapas, você criou um pacote chamado `ferramenta_matematica`, adicionou dois módulos (`operacoes.py` e `estatistica.py`) e dois subpacotes (`geometria` e `calculo`), cada um com seus respectivos módulos.
Com esta organização, fica mais fácil gerenciar e reutilizar seu código.
Como Utilizar um Pacote em Python
Para usar um pacote, é preciso importá-lo. As palavras-chave `import` e `from` permitem que você importe e utilize o pacote em seu código.
import ferramenta_matematica
Você também pode utilizar a notação de ponto para importar módulos, subpacotes ou propriedades específicas de um pacote. Esta notação permite navegar pela estrutura de diretórios do pacote, tornando suas importações mais legíveis e fáceis de manter.
from ferramenta_matematica.operacoes import somar, multiplicar
No código acima, foi feita a navegação do diretório do pacote (ferramenta_matematica) até o módulo de operações usando a notação de ponto, e duas funções (somar e multiplicar) foram importadas.
Importações Absolutas vs. Importações Relativas
Em importações absolutas, você define o caminho completo do pacote de nível superior (o pacote raiz) até o módulo ou subpacote desejado. Esta é a maneira mais comum e recomendada de importar módulos e pacotes em Python.
from ferramenta_matematica.geometria.formas import paralelogramo
Este código acessa o subpacote `geometria` dentro do pacote `ferramenta_matematica`, busca o módulo `formas.py` e importa a função `paralelogramo`.
Já as importações relativas permitem importar módulos a partir do local do módulo atual, utilizando a notação de ponto para especificar a importação.
Por exemplo, dentro do módulo `calculo/integracoes.py`, é possível utilizar uma importação relativa para importar uma função do módulo `formas.py` localizado no subpacote `geometria`.
from ..geometria.formas import losango
Os dois pontos (`..`) indicam ao Python para:
- Iniciar no diretório do subpacote (`calculo`), onde o módulo (`integracoes.py`) está.
- Subir um nível até o diretório do pacote pai (`ferramenta_matematica`).
- Localizar o subpacote `geometria` no diretório pai.
- Acessar o módulo `formas.py` e importar o `losango`.
Assim, a notação de ponto representa quantos níveis acima navegar a partir do diretório do módulo atual.
Atribuindo Alias para Importações
Você pode atribuir um alias a uma importação, facilitando a referência no seu código. Alias são úteis ao lidar com nomes de pacotes ou módulos muito longos.
Para definir um alias, utilize a palavra-chave `as`.
import ferramenta_matematica.calculo as calc
Como Distribuir seu Pacote em Python
Python oferece ferramentas e uma plataforma para construir e distribuir seu pacote. A distribuição permite compartilhar seu código com outros desenvolvedores, promovendo a colaboração, simplificando a instalação para usuários e contribuindo para a comunidade Python.
Passo 1: Crie uma conta no PyPI
Python Package Index (PyPI) é o repositório padrão de pacotes Python. É possível publicar pacotes no PyPI para que outros desenvolvedores possam encontrá-los e instalá-los com facilidade.
Certifique-se de guardar seu nome de usuário e senha, pois serão necessários para autenticação ao enviar o pacote para o PyPI.
Etapa 2: Instale as Ferramentas de Gerenciamento de Pacotes
Estas ferramentas facilitam a configuração, compilação e envio de um pacote distribuível com um único comando:
pip install build wheel twine
Etapa 3: Crie um Arquivo setup.py
Para distribuir seu pacote, crie um arquivo setup.py na raiz do diretório do seu projeto. Este arquivo contém metadados sobre seu pacote, como nome, versão, autor, descrição, dependências e outras informações.
As ferramentas de gerenciamento de pacotes usarão o arquivo `setup.py` para configurar e construir seu pacote.
from setuptools import setup, find_packages
setup(
name="<nome do pacote>",
version='1.0.0',
author="<Seu Nome>",
description='Uma coleção de funções matemáticas úteis',
packages=find_packages(),
install_requires=[
'numpy',
'scipy',
],
)
Etapa 4: Construa o Pacote
Com o arquivo `setup.py` pronto, você pode utilizá-lo para construir um pacote distribuível. No terminal ou prompt de comando, navegue até o diretório que contém o arquivo `setup.py` e execute o seguinte comando:
python setup.py sdist bdist_wheel
Este comando gera um diretório `dist` que contém um pacote de distribuição de origem (.tar.gz) e um pacote de distribuição wheel (.whl). Você também verá um diretório de `build` e outras informações.
Etapa 5: Envie o Pacote para o PyPI
Com o pacote pronto, envie-o para o PyPI.
Execute o seguinte comando:
twine upload dist/* > Uploading distributions to https://upload.pypi.org/legacy/ > Enter your username: ********** > Enter your password: **********
Acesse sua página de gerenciamento de projetos no PyPI para visualizar seu pacote.
Agora, outros desenvolvedores que acharem seu pacote útil podem instalá-lo e utilizá-lo localmente.
Como Instalar um Pacote Python
Gerenciadores de pacotes como o `pip` facilitam a instalação e o gerenciamento de pacotes Python de diversas fontes, incluindo o Python Package Index (PyPI). Para instalar um pacote utilizando o `pip`, abra o terminal ou prompt de comando e utilize o seguinte comando:
pip install <nome_do_pacote>
Para ver todos os comandos e opções disponíveis para o `pip`, utilize a opção `–help`.
Escrevendo Módulos Limpos
Pacotes contêm módulos e subpacotes, que por sua vez, podem conter outros módulos. É fundamental modularizar o seu código, especialmente ao trabalhar em projetos maiores, pois isso promove organização e legibilidade. Portanto, ao desenvolver em Python, é importante que seus módulos sejam claros e bem estruturados.