Советы для Джанго

Импорты в Django

Импорт модулей является неотъемлемой частью разработки на Python и Django. PEP8 - официальное руководство по стилю для Python, рекомендует размещать иморты в начале файла, на отдельных строчках и группировать следующим образом:

  1. Импорт стандартных библиотек.
  2. Импорт сторонних библиотек.
  3. Импорт лоакальных приложений или библиотек.

По возможности используйте такой подход, чтобы было проще работать с импортами.

Вот пример views.py для приложения блога:

# blog/views.py
from django.views.generic import ListView, DetailView
from django.views.generic.edit import CreateView, UpdateView, DeleteView
from django.urls import reverse_lazy

from .models import Post # относительный импорт

class BlogListView(ListView):
    model = Post
    template_name = 'home.html'

Первые три импорта - абсолютный иморт, который используется для импорта пакетов из рабочего окружения проекта или глобально установленных пакетов. Данный пример показывает импорт основного кода Django.

Для импорта нашей модели используется относительный иморт, таким образом мы не указываем напрямую имя приложения, что делает код более переносимым. Если бы мы использовали from blog.models import Post, то если название приложения (blog) потом изменится, то придется везде, где оно используется, редактировать код.

Еще одно замечатльное правило - никогда не использовать импорт всего, т.е. *. Это плохой пример:

# blog/views.py
from django.views.generic import * # Плохая идея!

Почему не следует использовать такой импорт? Если views.generic в какой-то момент в будущем изменится непредвиденными способами, это может вызвать проблемы с безопасностью.

Поделитесь с другими: