Стиль кодирования в Django

Группировка импортированных пакетов

Импортированный пакет может быть сгруппирован следующими способами:

• Импорт стандартных библиотек: Подходит для таких библиотек, как sys, os, process и т.д.

  import re
  import simplejson
  
• Импорт сторонних библиотек: Обычно скачиваются через PyPy (используйте команду pip install). Вот пример:

  from decimal import *
• Импорт локальных библиотек/особых библиотек: Включает локальные модули вашего проекта, такие как модели, представления и т.д.

  from models import ModelFoo
  from models import ModelBar 
  

Соглашение об именах в Python/Django

В любом языке программирования и фреймворке есть свое соглашение об именах. В Python/Django оно более или менее схоже, но лучше осветить его здесь. Вам необходимо следовать ему, когда вы присваиваете имена переменным, или даете имена глобальным переменным, называете класс, модуль, и т.д.

Вот так в общих чертах выглядит соглашение об именах, которого мы должны придерживаться:

• Давайте правильные имена переменным: Никогда не используйте отдельные символы для имен переменных, например, ‘X’ или ‘x’. Это может годиться для скриптов на языке Python, но, когда вы создаёте веб-приложение, давайте такие имена, чтобы они определяли возможность чтения всего проекта.
• Имена пакетов и модулей: Для модулей рекомендуются строчные буквы и короткие имена. Нижнее подчеркивание также может использоваться для улучшения читаемости. Пакеты для Python также должны носить короткие имена, состоящие из букв нижнего регистра, хотя использование нижнего подчеркивания может сбить с толку.
• Так как имена модулей отображаются в имена файлов (models.py, urls.py и др.), важно чтобы имена модулей были достаточно короткими, так как некоторые файловые системы нечувствительны к регистру и могут обрезать длинные имена.
• Имя класса: Имена классов должны подчиняться соглашению об именах CamelCase, а имена внутренних классов могут иметь имена, начинающиеся с нижнего подчеркивания.
• Имена глобальных переменных: Прежде всего, вы должны остерегаться использования глобальных переменных, но если это необходимо, то предотвратить экспорт с помощью _all_ или поместив в начале ее нижнее подчеркивание (способ старого соглашения).
• Имена функций и аргументов методов: Имена функций должны быть в нижнем регистре и отделяться нижним подчеркиванием. Метод должен начинаться с self. Для методов классов используйте CLS
• Имена переменных и методов экземпляра: Используйте правила именования функций – буквы нижнего регистра, слова, разделенные нижними подчеркиваниями как необходимое условие улучшение читаемости. Используйте нижнее подчеркивание первым символом для не-public методов и переменных экземпляра.

Использование IDE для быстрой разработки

На рынке много вариантов, если речь идет о редакторах исходного кода. Одни предпочитают полновесные IDE, других устраивают простые текстовые редакторы. Выбор за вами: возьмите то, что вам удобней. Если вы уже используете какую-то программу для работы с исходными файлами Python, то мы полагаем, что вы привыкли к ней и она будет хорошо работать и с Django. С другой стороны, я могу порекомендовать вам такие программы, как:

• SublimeText: Этот редактор является легковесным и очень мощным. Он доступен для всех основных платформ, поддерживает подсветку синтаксиса и автозаполнение кода и хорошо работает с Python. Редактор является open source проектом, и вы можете найти его на http://www.sublimetext.com/
• PyCharm: Я бы сказал, что это самый умный редактор кода из всех и он обладает расширенными функциями, такими как рефакторинг кода и анализ кода, что делает разработку более чистой. Особенности для Django включают отладку по шаблону (который является победителем), а также краткую документацию, что выглядит привлекательно для начинающих. Версия от сообщества является бесплатной, и вы можете попробовать 30-дневную пробную версию перед покупкой профессиональной редакции.

Настройка вашего проекта с использованием текстового редактора Sublime.

Многие из примеров, написанных для этого курса, написаны с помощью текстового редактора Sublime. В этом разделе мы покажем, как установить и настроить проект Django.

1. Скачивание и настройка: Вы можете скачать Sublime из раздела загрузок на сайте http://www.sublimetext.com/. Нажмите на выбранный файл для скачивания и установите.
2. Настройка для Django: Sublime – это экосистема, богато расширяемая плагинами, что означает, что вы однажды скачиваете текстовый редактор и потом устанавливаете плагины для добавления в него возможностей

По завершении установки, вы увидите что-то похожее на это:

Гораздо важнее всего Package Control, который является менеджером установки других плагинов прямо изнутри Sublime. Это позволит вам производить ручную установку пакета. Не беспокойтесь о дальнейшей установке пакета.

увеличить изображение

SublimeCodeIntel: Создана разработчиком SublimeLint. SublimeCodeIntel обладает расширенную функциональность, такую как, определение на ходу, умное дополнение кода и импорт предложений.

Вы можете найти и другие плагины для Sublime для увеличения вашей производительности.

Настройка PyCharm IDE

Вы можете использовать одну из ваших любимых IDE для разработки проектов на Django. В этой книге мы используем pycharm. Эта IDE рекомендуется, так как она поможет вам с отладкой, используя точки останова, которые сэкономят вам кучу времени, если что-то пойдет не так.

Вот так можно установить и настроить IDE pycharm для Django:

1. Скачивание и установка: Вы можете проверить функции и скачать IDE pycharm по следующей ссылке: http://www.JetBrains.com/pycharm/
   

   
   увеличить изображение
   
2. Настройка для Django: Настроить pycharm для работы с Django очень легко. Вы должны импортировать папку проекта и указать путь к файлу manage.py.