Python Package

Simplificando Seus Imports em Python: Como Importar por Classe, Não por Arquivo

Ao trabalhar com Python, especialmente em projetos maiores, gerenciar imports de forma eficaz se torna crucial. Você pode se ver desejando acessar classes diretamente de seu pacote em vez de seus respectivos arquivos. Este método pode tornar seu código mais limpo e fácil de ler. Neste post do blog, abordaremos como alcançar isso em seus projetos Python com uma estrutura simples.

O Problema

Considere a seguinte estrutura de arquivos para sua aplicação Python:

app/
  app.py
  controllers/
    __init__.py
    project.py
    plugin.py

Neste caso, se você definir uma classe Project em project.py, importá-la em app.py tradicionalmente seria assim:

from app.controllers.project import Project

No entanto, e se você quisesse que sua declaração de importação fosse mais curta e limpa? Você pode desejar importá-la assim:

from app.controllers import Project

Isso não apenas simplifica suas declarações de importação, mas mantém seu código mais organizado. A pergunta que surge é: Como você pode configurar isso?

A Solução

Para simplificar seu processo de importação e permitir a importação de classes diretamente de um pacote, você precisa fazer uma pequena modificação em seu arquivo __init__.py localizado no diretório controllers.

Guia Passo a Passo

Abra o arquivo __init__.py: Este arquivo é tipicamente usado para inicializar seu pacote Python e permite que você controle o que é importado quando você importa o pacote em si.
Adicione a declaração de importação: Para permitir que a classe Project seja importada diretamente de controllers, adicione a seguinte linha ao seu __init__.py:
```
from project import Project
```
Isso informa ao Python para importar a classe Project de project.py automaticamente quando você importar o pacote controllers.
Ajuste para Imports Absolutos: Com a introdução do Python 2.7 e além, os imports absolutos se tornam o modo padrão para as importações. Para evitar conflitos potenciais com um módulo de nível superior que poderia inadvertidamente compartilhar um nome (como project), é benéfico incluir um ponto para indicar um import relativo. Assim, você modificaria sua importação em __init__.py para:
```
from .project import Project
```
Isso indica que a classe Project está sendo importada do pacote atual (controllers).

Principais Conclusões

Ao modificar seu __init__.py, você simplifica significativamente seus imports.
Usar o ponto (.) na frente do nome do módulo garante que você está referenciando o módulo correto, o que é especialmente útil em aplicações maiores com possíveis conflitos de nomenclatura.
Essa prática não apenas melhora a legibilidade do seu código, mas também ajuda você a manter uma estrutura clara à medida que seu projeto se expande.

Conclusão

Ao seguir os passos simples descritos acima, você pode aprimorar suas práticas de codificação em Python tornando seus imports mais diretos. Essa técnica não apenas economiza tempo, mas também contribui para um código limpo e fácil de manter. Lembre-se, uma aplicação bem estruturada começa com o gerenciamento eficaz de seus imports!

Sinta-se à vontade para experimentar essa abordagem em seus próprios projetos e veja a diferença que ela faz!