Інструмент для перетворення коду Python на сумісність з PEP8

Я знаю, що є інструменти, які підтверджують, чи відповідає ваш код Python PEP8, наприклад, є і онлайн-сервіс, і модуль python .

Однак я не можу знайти службу чи модуль, який може перетворити мій файл Python в автономний, PEP8-дійсний файл Python. Хтось знає, чи є такі?
Я припускаю, що це можливо, оскільки PEP8 стосується появи коду, правда?

На жаль, "штурм" pep8 "(весь проект) має кілька негативних побічних ефектів:

• багато конфліктів злиття
• зламати гіт вину
• ускладнити перегляд коду

В якості альтернативи (і завдяки @yp за ідею ) я написав невеликий пакет, в якому autopep8 містить лише ті рядки, над якими ви працювали з останнього комітету / гілки:

В основному залишити проект трохи краще, ніж ви його знайшли :

pip install pep8radius

Припустимо, ви закінчили свою роботу masterі готові здійснити:

# be somewhere in your project directory
# see the diff with pep, see the changes you've made since master
pep8radius master --diff
# make those changes
pep8radius master --diff --in-place

Або очистити нові рядки, які ви зробили з останнього зобов’язання:

pep8radius --diff
pep8radius --diff --in-place

# the lines which changed since a specific commit `git diff 98f51f`
pep8radius 98f51f --diff

В основному pep8radiusзастосовується autopep8 до рядків у висновку git / hg diff (від останнього спільного комітету ).

Цей сценарій зараз працює з git та hg, якщо ви використовуєте щось інше і хочете, щоб це працювало, будь ласка, опублікуйте коментар / проблему / PR !

Ви можете використовувати autopep8 ! Поки ви робите собі чашку кави, цей інструмент із задоволенням усуває всі ті прискіпливі порушення PEP8, які не змінюють значення коду.

Встановіть його через pip:

pip install autopep8

Застосуйте це до певного файлу:

autopep8 py_file --in-place

або до вашого проекту (рекурсивно), багатослівний варіант дає вам відгуки про те, як це відбувається :

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Примітка: Іноді за замовчуванням 100 пропусків недостатньо, я встановив його на 2000, оскільки він досить високий, і він буде захоплювати всі файли, крім найскладніших (він перестає проходити, як тільки не знайде вирішуваного порушення pep8) ...

На даний момент я пропоную повторно протестувати і виконувати завдання!

Якщо ви хочете "повного" дотримання PEP8: одна з тактик, яку я використовував, - це запустити autopep8, як зазначено вище, а потім запустіть PEP8, який друкує інші порушення (файл, номер рядка та що):

pep8 project_dir --ignore=E501

і вручну змінювати їх окремо (наприклад, E712s - порівняння з булевими).

Примітка: autopep8 пропонує --aggressiveаргумент (щоб нещадно "виправити" ці порушення, що змінюють значення), але будьте обережні, якщо ви використовуєте агресивні, можливо, доведеться налагоджувати ... (наприклад, у numpy / pandas, True == np.bool_(True)але ні True is np.bool_(True)!)

Ви можете перевірити, скільки порушень кожного типу (до і після):

pep8 --quiet --statistics .

Примітка. Я вважаю, що E501 (рядок занадто довгий) є окремим випадком, оскільки їх, мабуть, буде багато у вашому коді, а іноді вони не виправляються автопепі8.

Як приклад, я застосував цю методику до бази кодів панди .

@Andy Hayden дав хороший огляд autopep8. На додаток до цього є ще один пакет під назвою pep8ify, який також робить те ж саме.

Однак обидва пакети можуть видаляти лише помилки ворсу, але вони не можуть форматувати код.

little = more[3:   5]

Наведений вище код залишається таким же після pep8ifying також. Але код ще не виглядає добре. Ви можете використовувати формати форматів, таких як yapf , який буде форматувати код, навіть якщо код сумісний з PEP8. Вищий код буде відформатований в

little = more[3:5]

Деколи це навіть руйнує ваше ручне форматування. Наприклад

BAZ = {
    [1, 2, 3, 4],
    [5, 6, 7, 8],
    [9, 10, 11, 12]
}

буде перетворено на

BAZ = {[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]}

Але ви можете сказати це ігнорувати деякі частини.

BAZ = {
   [1, 2, 3, 4],
   [5, 6, 7, 8],
   [9, 10, 11, 12]
}  # yapf: disable

Взято з моєї старої публікації в блозі: Автоматично PEP8 та відформатуйте свій код Python!

Якщо ви використовуєте eclipse + PyDev, ви можете просто активувати autopep8 з налаштувань PyDev: Windows -> Налаштування -> введіть 'autopep8' у фільтр пошуку.

Поставте прапорець "використовувати autopep8.py для форматування коду?" -> Гаразд

Тепер у форматі CTRL-SHIFT-F eclipse слід відформатувати ваш код за допомогою autopep8 :)

Я провів широкі дослідження щодо різних інструментів для стилю пітона та коду. Існує два типи інструментів: лінери - аналізуючи свій код та дайте попередження про погано використовувані стилі коду та показуючи поради, як його виправити, та форматори коду - коли ви зберігаєте файл, він переформатує ваш документ за допомогою стилю PEP.

Оскільки переформатування повинно бути більш точним - якщо воно переформатує те, що ви не хочете, воно стане марним - вони охоплюють меншу частину PEP, лінери показують набагато більше.

Усі вони мають різні дозволи на конфігурування - наприклад, pylinter, що може бути налаштований у всіх його правилах (ви можете вмикати / вимикати кожен тип попереджень), чорний зовсім не налаштований.

Ось кілька корисних посилань та навчальних посібників:

Документація:

• Конвенції про докстринг PEP-257: https://www.python.org/dev/peps/pep-0257/
• Підказка типу PEP-484: https://www.python.org/dev/peps/pep-0484
• Посібник зі стилю хрому https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Стиль коду для автоматичного тестування https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Посібник зі стилю кодування Khan Academy https://github.com/Khan/style-guides/blob/master/style/python.md
• Посібник автостопом до Python https://docs.python-guide.org/
• Посібник зі стилів EdX Python https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• Стаття про стиль коду на RealPython https://realpython.com/python-pep8/

Підводки (в порядку популярності):

• mypy https://github.com/python/mypy вкладиш для перевірки типу (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - хороший за допомогою PEP-8, дуже популярний. Часто використовується поряд із пілінтом та лускою8 (одночасно)
• pylint https://github.com/PyCQA/pylint дуже настроюється, активно підтримується
• bandit https://github.com/PyCQA/bandit лінтер по безпеці
• проспектор https://github.com/PyCQA/prospector pylint + перевірка складності коду
• flake8 https://github.com/PyCQA/flake8 обгортка pycodestyle з можливістю вмикати плагіни. Дуже великий список різних настроюваних плагінів. Ось дивовижний flake8 repo: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - намагається поєднати багато різних ліній в одному проекті (насправді це плагін flake8, що поєднує стилі з кількох інших ліній)
• pylama https://github.com/klen/pylama намагаються поєднати ще 10 лінійок в один (mypy, pylint, pycodeestyle, pydocstyle та ін.). Тут я бачу єдину проблему - стару версію (жодних оновлень у github repo протягом 10 місяців немає).
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Форматори коду (у порядку популярності):

• чорний https://github.com/psf/black найбільш популярний формат, який використовується в декількох великих компаніях. Він був створений пізніше yapf, але вже має більше запусків у GitHub
• yapf https://github.com/google/yapf Форматор коду Google
• autopep8 https://github.com/hhatto/autopep8 будуйте на pycodestyle

Тут багато.

Зазвичай IDE мають вбудовану можливість форматування. IntelliJ Idea / PyCharm робить, те ж саме стосується і плагіна Python для Eclipse тощо.

Існують формати / лінтери, які можуть націлювати кілька мов. https://coala.io - хороший приклад цього.

Потім є інструменти єдиної мети, про які багато хто згадується в інших відповідях.

Одним із специфічних методів автоматичного переформатування є аналіз файлу в дереві AST (без відкидання коментарів), а потім повернення його назад до тексту (тобто нічого не зберігається в оригінальному форматуванні). Прикладом цього може бути https://github.com/python/black .