Emacs как редактор кода для Python и Golang

  • Tutorial

image


Введение


Когда полгода назад я решил перейти с Vim на Emacs сначала я решил поискать статьи по настройке последнего на хабре. К моему удивлению нашлась всего одна статья в которой рассказывали, как настроить данный редактор для работы с Python. У меня было 2 года опыта работы с vim и имелись определенные требования, которые не были затронуты в данной статье. Вообще рускоязычных статей про работу в Emacs над Python очень мало на просторах интернета. Я не буду рассказывать про тонкости настройки самого Emacs, для этого не хватит даже отдельной статьи.


Сразу хочу предупредить любителей холивара Emacs vs Vim, а также Emacs/Vim vs IDE — я не хочу разводить бесполезные споры на эти темы. После долгих поисков я нашел редактор, который устраивает меня всем и который можно настроить как душе угодно. Я просто хочу поделится своими конфигами, а также надеюсь увидеть альтернативные решения в комментариях, чтобы продолжать настраивать данный инструмент под себя.


Требования


Самое первое требование — легко переносимая конфигурация и установка плагинов между домом и работой.
Для этого использую github. Так как часто случается, что я изменяю что-то в конфигах, я использую meld для просмотра разницы между файлами.
В meld можно просматривать как директории, так и отдельные файлы. После синхронизации тем же мелдом все изменения добавляю в домашнюю директорию.


Не менее важное требование — удобный менеджер плагинов, с ленивой загрузкой и обновлением, как NeoBundle из vim. В процессе поиска такого менеджера также выяснилось, что в емаксе плагины можно скомпилировать, для ускорения загрузки. На счастье, нашелся как раз такой менеджер, который удовлетворял всем требованиям и даже больше. Это el-get — идеальный менеджер с автокомпиляцией, автоматической инициализацией, а также самое важное — рецептами установки. Приведу короткий пример рецепта, для наглядности.


(:name flycheck
       :type github
       :pkgname "flycheck/flycheck"
       :checkout "0.25.1"
       :minimum-emacs-version "24.3"
       :description "On-the-fly syntax checking extension"
       :build '(("makeinfo" "-o" "doc/flycheck.info" "doc/flycheck.texi"))
       :info "./doc"
       :depends (dash pkg-info let-alist seq)
       :post-init (progn
                    (add-hook 'python-mode-hook             #'flycheck-mode)
                    (add-hook 'js-mode-hook                 #'flycheck-mode)
                    (add-hook 'web-mode-hook                #'flycheck-mode)
                    (add-hook 'lisp-interaction-mode-hook   #'flycheck-mode)
                    (add-hook 'fish-mode-hook               #'flycheck-mode)
                    (add-hook 'markdown-mode-hook           #'flycheck-mode)
                    (add-hook 'go-mode-hook                 #'flycheck-mode)
                    (setq flycheck-check-syntax-automatically '(mode-enabled save idle-change))
                    (setq flycheck-highlighting-mode 'lines)
                    (setq flycheck-indication-mode 'left-fringe)
                    (setq flycheck-checker-error-threshold 2000)
                    ))

Это рецепт установки flycheck — плагина, для синтаксической проверки файлов при редактировании, на лету. В рецепте можно указывать источник кода — репозиторий git/github или просто ссылку на файл или название плагина в ELPA/MELPA, необходимые зависимости, в случае github — ветку или таг.
Команда :build позволяет запускать системные утилиты, если они необходимы для корректной установки плагина.
Также есть замечательная команда — :post-init, в ней можна указывать лисповый код, который будет запускатся каждый раз после инициализации плагина. Я решил прописывать в этой команде все настройки связанные с данным плагином. В общем — очень удобный инструмент.


Я сразу отказался от файла ~/.emacs.el по причине синхронизации между работой и домом.
Поэтому все настройки расположены в папке ~/.emacs.d. Максимально тонкий init.el в котором подключаются логически разбитые файлы из папки settings.


(add-to-list 'load-path (expand-file-name "settings" user-emacs-directory))
(require 'dark-mint-theme)
(require 'scratch_my)
(require 'package_my)
(require 'hooks_my)
(require 'keybindings_my)
...
автоматически генерируемый при customize код

Первый файл — тема оформления. Больше тем тут


scratch_my.el описывает все стандартные настройки и включает необходимые режимы, которые уже присутствуют с нуля в любом свежем Emacs.


В package_my.el список всех устанавливаемых плагинов и несколько функций для корректной установки.


Хуки разных режимов описаны в файле hooks_my.el.


Смена сочетаний клавиш вынесена в отдельный файл keybindings_my.el.


Также синхронизируются папка с сниппетами yasnippet и с рецептами.
Очень часто я вношу изменения в рецепты, добавляя туда настройки плагинов, поэтому я храню их в отдельной папке.


Плагины, не зависимые от языка программирования


Я подробно не буду описывать все плагины, к каждому прилагается ссылка, где подробно все расписано.


Начнем пожалуй с avy, плагина позволяющего переходить на слово, содержащее введеный символ(аналог vim-easymotion).


Для автодополнения используется company-mode — универсальное автодополнение для Emacs.
Очень быстро работает, полностью настраивается, хотя документация у него неполная, в исходники заглядывал частенько. Удобство проявляется в структуре даного плагина. Есть бекенд — индивидуальный код для разных режимов и фронтенд — общий код, который отрисовывает результаты автодополнения в самом Emacs. Для разных режимов используются разные бекенды. Например для лиспа используется company-elisp бекенд, для Python — company-jedi(бекенд для jedi — библиотеки статического анализа кода Python).
Для дополнения golang кода используется company-go бекенд.


expand-region используется для семантического выделения текста. Более подробно в этом видео.


Для работы с git использую три замечательных плагина — git-gutter, mo-git-blame и magit. Хочу особо выделить последний плагин — он просто потрясающий, пару касаний и код уже на сервере (видео).


А как же файловый менеджер спросите вы? neotree. Интеграция с git присутствует.


Очень полезный плагин — helm — автодополнение к всему. Поиск по открытым буферам(helm-swoop), по недавно открытым файлам, по файлам в текущей директории, поиск по командам, переименование переменных в нескольких буферах и много всего остального. Отличная статья описывает все возможности данного плагина.


multiple-cursors — после просмотра данного видео вам обязательно захочется его попробовать:).


Плагин, с помощью которого можно назначить действие на двойное нажатие любых клавиш называется key-chord(видео)


Аналог vim-powerlinepowerline


projectile — плагин для управления проектами в Emacs. Поиск по проекту, замена по файлам проекта, переход внутри проекта, переключение проекта и множество других полезных функций. Подробности в этой статье


yasnippet — позволяет создавать и использовать сниппеты для разных языков программирования.


Python mode


Наконец-то мы переходим к настройке Emacs непосредственно для работы с Python.


Начнем пожалуй с хуков


;; Python mode
(defun my-merge-imenu ()
  (interactive)
  (let ((mode-imenu (imenu-default-create-index-function))
        (custom-imenu (imenu--generic-function imenu-generic-expression)))
    (append mode-imenu custom-imenu)))

(defun my-python-hooks()
    (interactive)
    (setq tab-width     4
          python-indent 4
          python-shell-interpreter "ipython"
          python-shell-interpreter-args "-i")
    (if (string-match-p "rita" (or (buffer-file-name) ""))
        (setq indent-tabs-mode t)
      (setq indent-tabs-mode nil)
    )
    (add-to-list
        'imenu-generic-expression
        '("Sections" "^#### \\[ \\(.*\\) \\]$" 1))
    (setq imenu-create-index-function 'my-merge-imenu)
    ;; pythom mode keybindings
    (define-key python-mode-map (kbd "M-.") 'jedi:goto-definition)
    (define-key python-mode-map (kbd "M-,") 'jedi:goto-definition-pop-marker)
    (define-key python-mode-map (kbd "M-/") 'jedi:show-doc)
    (define-key python-mode-map (kbd "M-?") 'helm-jedi-related-names)
    ;; end python mode keybindings

    (eval-after-load "company"
        '(progn
            (unless (member 'company-jedi (car company-backends))
                (setq comp-back (car company-backends))
                (push 'company-jedi comp-back)
                (setq company-backends (list comp-back)))
            )))

(add-hook 'python-mode-hook 'my-python-hooks)
;; End Python mode

Для работы плагинов нужно установить пару пакетов через pip


pip install -U jedi virtualenv flake8

Устанавливаем настройки отступов и путь к интерпретатору, выставляем специфические сочетания клавиш, добавляем бекенд company-jedi и настраиваем imenu.


Про автодополнение уже было выше(company-jedi), поиск по файлу и структуре файла(именам классов, переменным, методам и тд.) происходит через imenu(F10), открытие и закрытие файлового менеджера NeoTree происходит при нажатии F7.


Теперь немного о используемых плагинах


auto-virtualenv — отлично работает, особенно в связке с projectile.


jedi-core — отдает company-jedi варианты автодополнения, переходит по определениям, показывает доки к функциям и классам и тд.


pip-requirements — как видно из названия — пакет для работы с requirements.


py-autopep8 — позволяет автоматически форматировать код в cоответствии с стандартом pep8.


py-isort — можно автоматически сортировать все импорты в файле


Python REPL


В хуках мы указали какую версию shell мы будем использовать


   (setq python-shell-interpreter "ipython"
       python-shell-interpreter-args "-i")

При нажатии C-c C-c — все содержимое текущего буфера передается в ipython, где его можно тут же протестировать.
Если нужно лиш часть кода просмотреть, выделяете ее и нажимаете C-c C-r


Также можно использовать встроенный в python-mode деббагер, выполнив команду M-x pdb RET(RET — в емаксе обозначает ентер/return, поначалу меня это сбивало с толку). Также есть более функциональная версия — realgud


В качестве примера, хочу продемонстрировать несколько скриншотов
image


image


Emacs для golang


Несколько плагинов используется при работе с go проектами.


go-mode — режим работы go-mode.
Позволяет смотреть документацию, переходить по определениям, использовать различные утилиты проверки и форматирования кода, типа gofmt, golint и тд. Очень удобный плагин.


flycheck-gometalinter — интеграция gometalinter c flycheck.


company-go — бекенд для company


image


Другие плагины


markdown-mode — в данном режиме я как раз и пишу данную статью. А с помощью livedown просматриваю результат сразу в браузере.


web-mode — позволяет работать с html, css, Django/Jinja2 templates.


restclient — плагин для работы с разнообразными апишками. Emacsrocks покажет больше в своем видео.


Заключение


Жаль что в одной статье невозможно расписать все особенности и тонкости настройки каждого плагина, но я надеюсь список с коротким описанием позволит читателям узнать что-то новое из моего опыта. Также хабрахабр славен тем, что действительно полезную информацию часто можно узнать из комментариев, поэтому прошу вас делится своими настройками и опытом, это будет полезно и мне и вам.


Традиционно, все ошибки и замечания прошу отправлять мне в личные сообщения.


Полезные ссылки


AdBlock has stolen the banner, but banners are not teeth — they will be back

More
Ads

Comments 70

    +16
    Астрологи объявили неделю консольных редакторов. Количество постов о emacs и vim удвоилось.
      0
      А ты пользуйся готовенькими рецептами — и развивайся.
        0
        Статья уже определенное время лежала в черновиках, и только сегодня появилось время выложить. Все остальное — просто совпадение
        +5

        Эдак вы в скором времени с такой цветовой схемой редактора слепым станете...

          0
          Распространенное заблуждение, мне очень комфортно работать, особенно на 2-х 24 дюймовых мониторах
            0

            А что конкретно в ней у вас вызывает опасения? Вроде бы наоборот все хвалят светлый текст на темном фоне, не?

              +1
              «Все» — это кто? Мне не удалось найти ни одного исследования, подтверждающего, что тёмная цветовая схема лучше светлой. Наоборот, все исследователи приходят к выводу, что тёмный текст на светлом фоне гораздо легче читается и меньше напрягает глаза во всех случаях, за одним-единственным исключением: когда яркость фонового света в комнате существенно меньше яркости монитора. Т.е. если вы работаете в темноте — ставьте тёмную схему, но не проще ли включить в комнате свет?
                +5

                А можно ссылки на результаты исследований? Я вот вообще ни одного официального исследования не встречал, а по личному опыту и опыту знакомых, темный фон не так долбит по глазам. Тут разве что соглашусь с коментарием товарища Antelle о том, что неплохо бы текст сделать более контрастным.

                  0

                  Кстати на эту тему, в emacs есть неплохая стандартная тема tango-dark, с более контрастным текстом.

                  • UFO just landed and posted this here
                      0

                      Раньше я пользовался Visual Studio и QtCreator со светлой темой и вполне нормально работалось, потом перешел на emacs, но в нем светлые темы дерьмовые и долбят по глазам, а вот темные очень приятны)

                      0
                      Лет 15 назад попадалась статья, где некие исследователи из военных отраслей пришли к заключению, что лучшая для восприятия\уставаемости глаз комбинация — темно-серый текст на светло-сером фоне.
                        +1
                        Вот, например. Там ещё в конце библиография есть.
                        Таких статей на самом деле много — исследовали всё. И для мониторов с электронно-лучевыми трубками, и для LCD, и для разных размеров экранов (в т.ч. для смартфонов), и с фоновым освещением экспериментировали. И практически всегда, кроме использования в полной темноте, светлая цветовая схема гораздо лучше тёмной.
                    • UFO just landed and posted this here
                        +2
                        Раза 3 пробовал перейти на светлую тему — ужасно уставали глаза в темноте. Мне так намного комфортнее
                        • UFO just landed and posted this here
                        0

                        Это не светлый, а тёмный текст на тёмном фоне. Всегда использую тёмную схему (darcula в idea), но это — боль: здесь всё, что надо внимательно читать, неконтрастно, в то время как всякие ненужные var и func — контрастно. Whitespace вообще рисовать надо еле заметно, а тут аж розовые. Бррр.

                          0
                          Не знаю почему, но на екране и на скриншоте очень большая разница, может при редактировании скриншота hotshots сжимает, с потерей качества.
                      +1
                      Новичкам, а так же любителям попробовать (а так же тем кто предпочитает vim стиль редактирования текста) — spacemacs.org
                      В spacemacs есть концепция слоев (https://github.com/syl20bnr/spacemacs/tree/master/layers), это те плагины которые упоминает автор статьи только сгруппированы и уже кем-то настроены, по «дефолту» так сказать, для большинства пользователей.
                        +1
                        А есть плагины для дебага пайтон программ?
                          0
                          Спасибо за уточнение, дополнил статью
                          +3
                          Вот тут про связку Emacs + Go подробнее.
                            0
                            С удовольствием прочитал бы еще про emacs for java, но с другой стороны — тут же набегут любители и ненавистники от vim и emacs и «да начнется битва!», что уже порядком поднадоело =)
                              0
                              Я пытался настроить, но джава создана специально для IDE, поэтому пришлось от нее отказаться.
                                0
                                Я использовал eclim-emacs и впечатления вполне положительные. Пришло оно изначально из vim, поэтому можно без битвы обойтись.
                                  +1
                                  Для Java на данный момент нет ничего лучше IntelliJ IDEA, эти средства рефакторинга и профилирования ничем не заменишь.
                                    0
                                    Да, я сам фанат продуктов JetBrains, но временами приходится и в консоли через ssh поработать (какой-нибудь hotifx или еще какая беда). Хотелось бы немного больше дружелюбия — хотя бы авто-импорты да какой-нибудь code completion.
                                      0

                                      Вы имеете ввиду visualvm profiler plugin или какое-то иное профилирование в идее?

                                    0
                                    Neotree? Неужто в нем есть что-то чего нет в Dired?
                                      0
                                      Или хотя бы в Dired+ :)
                                        0
                                        Не смог настроить древовидное отображение внутренних директорий и файлов в них, а также отображение измененных(и других видов) файлов в репозитории, если поделитесь конфигом, буду вам очень благодарен.
                                          +1
                                          Сделал сегодня через dired-tree, работает вполне сносно: https://www.youtube.com/watch?v=z26b8HKFsNE ставится через пакет dired-subtree, потом биндишь dired-subtree-toggle и собственоо все =)
                                      +1
                                      Большое спасибо за статью. Иногда использование консольного редактора это необходимость. Вимом пользуюсь с тех пор, как это принято считать, первый раз зашёл и не смог выйти. После этого прочтения, пожалуй, и начну знакомство с emac.
                                      А на холиварщиков не обращайте внимание. Конечно очень странно в профессиональном сообществе видеть тех, для кого важнее инструменты, а не задачи, которые решают люди, но что поделать.
                                        0

                                        Имхо, emacs в своей консольной ипостаси так себе… его с гуевиной пользовать надо, да и не все хоткеи работают в консоли.
                                        А для SSH'ных дел все равно Trump есть )

                                        0
                                        Чем сложнее структура тем легче маленькому багу вывести все из строя. Почему не тянутся к простоте и минимализму? Неужели все те функции используются на полную?
                                          0
                                          Изначально у меня был простой емакс «из-коробки», по мере изучения я добавлял только нужные мне функции и плагины. Не могу сказать, что прям уж на 100% использую все, но до 90% думаю дотягивает. Вся прелесть емакса — можно использовать только то, что нужно
                                            0

                                            Странно, кстати, что вы evil не используете, вроде бы многие ex-Vim'еры от него в восторге)

                                              0
                                              Не вижу в нем большой необходимости, наоборот я настроил так, как мне удобно, ужасно напрягало в виме переключение режимов, постоянно нужно было смотреть на статусную строку.
                                                0
                                                Встречал рекомендацию, чтобы не надо было следить за режимом, постоянно находиться в дефолтном. Надо ввести чуть-чуть текста — перешёл в insert, ввел и машинально переключаешься обратно в базовый режим. Насколько это помогает — не знаю, мне вим как-то, в целом, плохо зашёл…
                                                  0
                                                  Я знаю, но когда решаешь сложную задачу, трудно следить за рекомендациями, просто нужно работать и не думать, в каком ты режиме
                                                  0
                                                  Если вас в виме напрягало переключение режимов, что тогда сподвигло вас им пользоваться?
                                                    0

                                                    Я пробовал им пользоваться, но после года пользования так и не смог привыкнуть к различным режимам. После этого попробовал Емакс и он мне очень понравился, особенно возможность менять все под себя, используя elisp, простой и понятный язык программирования, в отличие от VimL. У вима безусловно множество достоинств, но мне он не подходит

                                                      0

                                                      Мой вопрос в том, как вы пользовались вимом год на постоянной основе, при этом испытывая неприязнь к режимам. Если нерегулярно, то более менее понятно.

                                                        +1

                                                        А пока не попробовал Емакс, не понимал, что постоянно вызывает неудобство при работе с вимом

                                                          0

                                                          Но вы же по какой-то причине выбрали не Notepad++, не nano, не Emeditor не Sublime Text, а именно vim. И при этом явно не из за режимов. Так из каких же соображений вы предпочли vim этим редакторам?

                                                            0

                                                            На работе сотрудники посоветовали

                                                        +1
                                                        Я когда выбирал редактор остановился на емаксе (деталей уже не помню, но думаю потому что там нет режимов и потому что редактор кода должен быть написан на высокоуровневом языке, а не на системном), но потом оказалось что вокруг вимеры, на серверах везде вим, пошёл путём непротивления и стал юзать вим, но недавно (после 10 лет использования вима) возникла задача по редактированию в которой у меня вим слишком часто всё портил и я вернулся на емакс, так я и не привык к идее многорежимности.
                                              0
                                              Спасибо, интересный обзор.
                                              А почему используете meld, а не встроенный ediff?
                                                0

                                                В meld есть отличная возможность перекидывать куски текста из одного файла в другой. Изначально использовал его как difftool для git

                                                  +1
                                                  Попробуйте емаксовский ediff. Там все это есть.
                                              • UFO just landed and posted this here
                                                  0
                                                  Емакс и гуи и туи, но в туи он немного урезан.
                                                    +1

                                                    Есть gvim — gtk версия вима, а емакс изначально gtk но есть возможность запустить в консоли через команду emacs -nw

                                                      0
                                                      Ну вы хоть гугл немного почитали бы, прежде чем утверждать что «emacs изначально gui». То что у вас стоит пакет emacs вместо emacs-nox ещё ничего не значит.
                                                      +1

                                                      Есть и гуи и консольный вариант. Вот, например, как у меня выглядит


                                                      GUI версия

                                                      консольный вариант

                                                      Из минусов: в консольной версии не работают комбинации кнопок начинающиеся на Alt


                                                      Для Vim тоже есть GUI-версия GVim

                                                        +1
                                                        > в консольной версии не работают комбинации кнопок начинающиеся на Alt

                                                        Например какие? у меня всё нужное работает, например переход по номеру строки Alt g g
                                                        Или вы путаете со случаем когда надо Shift добавлять — типа чтобы нажать подчёркивание надо прибавить Shift т.к. без этого это минус.
                                                        Или у вас что-то с консолью, как у меня было когда не работали Ctrl+End, перешёл на Konsole и стало гут.
                                                      –1
                                                      Как по мне, то если уж пользоваться vim/emacs, то следующем шагом должно быть использование аккордовой клавиатуры. По моему они созданы друг для друга. Сам пробовал симулятор такой клавиатуры — поначалу сложно, но в целом освоить не сложнее того же vim.
                                                        0
                                                        Чем делаются форматирование кода? В статье первый пример кода идут отступы до "#".
                                                          0

                                                          Обычный python-mode

                                                            0
                                                            Я не про питоновский под, я про elisp.
                                                            Много где можно выполнить «align-curent» для блока (но например в conf-mode это уже не работает).
                                                            Может автор нашел способ применять это в любом тексте?
                                                              0

                                                              ага, я понял вас, нет это я вручную делал, чтобы было легче воспринимать

                                                                +1
                                                                C-u M-x align — Тоже самое для региона.
                                                                  0

                                                                  Спасибо, пригодится

                                                          –1
                                                          Классно!
                                                          По-поводу Emacs vs vim. Их нельзя сравнивать вообще. Emacs это процессор, а вот vim редактор.
                                                            +1
                                                            Вообще-то нет. И emac, и vim — текстовые редакторы. Можете убедиться в этом на официальных сайтах.
                                                              +1
                                                              emacs это виртуальная машина emacs lisp (https://news.ycombinator.com/item?id=8485733). Внутри которой можно запустить например спортированный туда vim.
                                                                0
                                                                > emacs это виртуальная машина emacs lisp
                                                                Emacs VM — часть emacs, но одно не является другим.
                                                            –1
                                                            На что только не идут люди лишь бы пищщарм не покупать :)
                                                              0

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

                                                            Only users with full accounts can post comments. Log in, please.