Pycharm todo как использовать
Перейти к содержимому

Pycharm todo как использовать

  • автор:

TODO tool window

This feature is not available in the Educational edition of PyCharm.

PyCharm constantly scans your project for comments in the source code that match specific TODO patterns and displays them in the TODO tool window.

The TODO tool window ( View | Tool Windows | TODO ) consists of the following tabs:

  • Project : Shows TODO items for the whole project.
  • Current File : Shows TODO items for the currently open file in the editor.
  • Scope Based : Shows TODO items for a certain scope, selected from the list.
  • Current Changelist : Shows TODO items in the active changelist (available only if version control integration is enabled).

Toolbar buttons

Tooltip and shortcut

Previous TODO Control+Alt+ArrowUp

Select the previous TODO item in the list.

Next TODO Control+Alt+ArrowDown

Select the next TODO item in the list.

Filter TODO Items

Select a filter or open the TODO dialog where you can edit the list of TODO patterns and filters as necessary.

Navigate with Single Click

When this toggle is selected, you can click items to open items in the editor. Otherwise, you can locate items in the editor by double-clicking them or pressing F4 .

Expand All Control+NumPad-+

Click this button to expand all nodes.

Collapse All Control+NumPad—

Click this button to collapse all nodes.

Group by Project

Use this toggle to group TODO items by containing projects. Not available for the Current File tab.

Show a preview pane with the source code of the selected item in the corresponding file.

Context menu

Jump to Source F4

Jump to the location of the relevant comment in the source code. Available only when you right-click a TODO item or a file.

Show the Local History submenu:

  • Show History : Open the Local History window for the relevant file.
  • Put Label : Add a label to the Local History.

TODO comments

When working on an application, you may want to mark some parts of your code for future reference: areas to optimize and improve, possible changes, questions to be discussed, and so on. In WebStorm, you can add special types of comments that are highlighted in the editor and listed in the TODO tool window.

Using default patterns

By default, WebStorm recognizes two patterns — the words TODO and FIXME both in the lower and in the upper case. These patterns can be used inside comments of any supported file type.

To create a TODO comment

  1. Place the caret where you want to create a TODO item and add a comment, for example, by pressing Control+/ , then type TODO or FIXME , and then type your note.
  2. View the list of TODO items in the TODO tool window. The tool window consists of four tabs where WebStorm shows TODO items for the whole project, for the file in the active editor tab, for the selected scope, or for the active changelist.
    • By default, when you select an item you automatically jump to the corresponding comment in the source code. To disable this automatic navigation, right-click the tool window title bar, click View Options , and then remove the tick next to Navigate with Single Click .
    • With Navigate with Single Click disabled, double-click the required TODO item to jump to the corresponding comment in the source code.

In JavaScript and TypeScript files, WebStorm by default also supports multiline TODO comments. Start the TODO comment with the usual TODO and add extra indents on the next lines to continue the TODO comment. If you remove the indentation, WebStorm will treat it as a normal comment.

To suppress multiline TODO comments

  1. In the Settings dialog ( Control+Alt+S ), click TODO under Editor .
  2. On the TODO page that opens, clear the Treat the indented text on the following lines as part of the same TODO checkbox.

Using custom patterns

You can modify the default patterns or add your own patterns and filter the list to show only TODO items that match certain patterns. For example, you may want to mark code fragments that require optimization with the OPTIMIZE pattern and ignore all other types of TODO items.

Create a custom pattern

  1. In the Settings dialog ( Control+Alt+S ), click TODO under Editor . The TODO page opens.
  2. To add a pattern for the OPTIMIZE items, click in the Patterns area and type the following pattern: \boptimize\b.*
  3. To add a filter with the new pattern, click in the Filters area, specify a name for the new filter, and select the new pattern to be included in this filter.

To apply a custom filter

  • In the TODO tool window, click and select the necessary filter.

Pycharm и git — кроссбранчевые TODO

Бывает, что я делаю какое-то изменение в коде и вижу какое-то другое место, в котором что-то нужно подправить. Если делать все по гайдлайнам гита, то то другое место надо править в другой ветке. Но как мне быстро и удобно отметить его как TODO? В pycharm TODO это комментарии в коде, а комментарии — они только на той ветке, на которой я их оставил. Из-за этого я ленюсь и часто какой-то небольшой фикс включаю в коммит с каким-то другим фиксом, и ничего про нигде не пишу.

hlebushek ★★
03.04.15 19:33:44 MSK

TODO вне кода называются ишью, и фигачаться на трекере.

А ещё есть stash.

pon4ik ★★★★★
( 03.04.15 19:36:21 MSK )
Ответ на: комментарий от pon4ik 03.04.15 19:36:21 MSK

Мне лень фигачить issue на исправление уровня «исправить опечатку в названии переменной». Git stash — знаю про такую штуку, но из cli гита это делать не очень удобно, тем более когда там несвязанные исправления рядом друг с другом. Да и про стэш надо потом еще вспомнить.

hlebushek ★★
( 03.04.15 19:38:37 MSK ) автор топика
Ответ на: комментарий от hlebushek 03.04.15 19:38:37 MSK

Не делай его из cli git’a.

Изменения уровня «переименовать переменную» не несут никагого вэлуе для фичи (если это не публичный интерфейс api), а значит заслуживают отдельного коммита, только в случае множественных изменений обозванных рефакторингом.

А если ты используешь гитфлоу или его упрощенную схему, то все твои TODO одна фигня рано или поздно окажуться в develop, откуда их можно массированно выпилить.

pon4ik ★★★★★
( 03.04.15 19:42:49 MSK )
Ответ на: комментарий от pon4ik 03.04.15 19:42:49 MSK

Я пытался использовать по ветке на фичу/проблему/задачу, но судя по всему это слишком большой оверхед создает для одиночного днищепроекта, так что наверное оставлю 2 ветки: master — там прога работает, possibly_broken — там прога не факт, что работает; и буду все во вторую фигачить и временами, когда все в ней работает, мерджить ее в master. А если уж к более-менее большому коммиту привязывается какое-то не связанное мелкое изменение — наверное да и фиг с ним, даже в описании не буду упомянать, лень мне.

hlebushek ★★
( 03.04.15 19:46:54 MSK ) автор топика
Ответ на: комментарий от hlebushek 03.04.15 19:46:54 MSK

Просто ты видимо не освоил хоткеи своей ide, или у неё там кривовато сделанна работа с vcs. В гите как только коде бейз вырос из 3-4 файлов, работа фича==ветка, несёт оверхед полторы секунды на фичу.

pon4ik ★★★★★
( 03.04.15 19:53:23 MSK )

А чего пилишь то кстати, опенсурц? Дай поглядеть, вдруг полезное чего 🙂

pon4ik ★★★★★
( 03.04.15 20:49:29 MSK )
Ответ на: комментарий от pon4ik 03.04.15 19:42:49 MSK

Изменения уровня «переименовать переменную» не несут никагого вэлуе для фичи

Ну как же. Правка сексистских каментов в коде — это очень важно. Из-за этого же срач и паралимпийские забеги 🙂

slackwarrior ★★★★★
( 03.04.15 21:09:09 MSK )
Ответ на: комментарий от pon4ik 03.04.15 20:49:29 MSK

Нет, пилю никому не нужную штуку, так что не дам.

JetBrains представила PyCharm 2018.3

В PyCharm 2018.3 появились многострочные комментарии формата TODO, отображение используемого типа отступов и инструмент для работы с pull-запросами.

Обложка поста JetBrains представила PyCharm 2018.3

Команда JetBrains представила третье и последнее на 2018 год мажорное обновление IDE для разработки на Python. PyCharm 2018.3 получила поддержку многострочных комментариев формата TODO для записи задач и идей по ходу работы, встроенный инструмент для работы с pull-запросами и возможность настройки интерпретатора Python для работы в Windows над Linux-приложением.

Новое в работе с Python

Пользователям платной версии IDE уровня Professional стала доступна WSL Interpreter — эта функция позволяет настраивать интерпретатор Python для запуска кода во внутреннем Linux-окружении. Нововведение направлено на разработчиков, которые пользуются Windows, но разрабатывают под Linux.

В PyCharm 2018.3 добавлены многострочные комментарии формата TODO. С их помощью можно прямо в коде делать пометки о том, что нужно добавить в проект или сделать позднее. Текст комментариев подсвечивается в редакторе, индексируется и доступен через поиск.

Другие изменения в работе с Python:

  • улучшена производительность при работе с f-строками;
  • новые настройки для оптимизации импорта кода;
  • автоматизация обновления в файлах проекта пометки о лицензии с указанием года (Settings —> Editor —> Copyright);
  • встроенная точка останова (стала доступна в Python 3.7) запустит вместо pdb внутренний отладчик PyCharm;
  • возможность указать свою команду для запуска в PyCharm инструмента управления контейнерами Docker Compose (только для версии Professional).

Новое в работе с IDE

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

Команда JetBrains отметила, что не принимает никакую сторону в войне за отступы, но добавила в статус-бар IDE отображение того типа, который используется в файле: табы или пробелы.

PyCharm 2018.3 научился запоминать расположение вкладок терминала, так что настройки теперь не сбрасываются с каждым запуском среды. Для пользователей версии Professional доступно отслеживание времени работы над тикетом.

Другие изменения

  • Появилось отдельное окно GitHub Pull Requests, в котором можно по одному из pull-запросов создать локальную ветку;
  • Для пользователей платной версии Professional доступны поддержка СУБД Cassandra, обновлённая поддержка Angular и онлайн-редактирование HTML и CSS кода без подключения дополнительного плагина.

Кроссплатформенная интегрированная среда разработки PyCharm «выросла» из другого проекта JetBrains — IntelliJ IDEA. Она помогает проводить статический анализ кода, предоставляет инструменты для отладки кода на Python, юнит-тестирования и разработки с использованием Django. Помимо текущей, в 2018 году команда JetBrains выпустила ещё две версии IDE: в марте вышла PyCharm 2018.1 с поддержкой Python 3.7, а в июле — PyCharm 2018.2 с полной интеграцией инструмента Pipenv для управления рабочим окружением.

Следите за новыми постами по любимым темам

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

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *