Приложение GitHub для автоматического просмотра стиля кода Python через запросы на вытягивание


pycodestyle или flake8 в качестве Linter. Бот может читать конфигурации для обоих.setup.cfg для разделов [flake8] и [pycodestyle] . Проверьте раздел Configuration ниже. Файл конфигурации не требуется для работы интеграции . Однако его можно настроить дополнительно, добавив файл .pep8speaks.yml в корне проекта. Вот пример:
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "Примечания:
.pep8speaks.yml переопределяет эти значения..pep8speaks.yml в base ветви (существующий). Если файл не найден, он затем ищет ветвь head (входящие изменения).scanner.linter в pycodestyle или flake8ignore или max-line-length ), PEP8Speaks будут искать и приоритетные конфигурации в следующем порядке:pycodestyle: или flake8: раздел .pep8speaks.yml .scanner.linter .[pycodestyle] или [flake8] раздел файла setup.cfg в корне проекта.scanner.linter . Итак, [flake8] раздел setup.cfg также будет работать в Pycodestyle.| Организация | Описание | |
|---|---|---|
| Панды | Мощные инструменты манипулирования данными для Python | |
| Салат | Открытый исходный код от Adobe | |
| OpenSUSE | Linux распределение | |
| Питорх Молния | Легкая обертка Pytorch для исследователей ML. | |
| NetworkX | Библиотека Python для теории графиков и сложных сетей | |
| Statsmodels | Статистическое моделирование и эконометрика в Python | |
| Ксаррей (Pydata) | Nd помеченные массивы и наборы данных в Python (Python для данных) | |
![]() | Солнечный | Python для физики солнечной энергии |
| Астропия | Астрономия в Python | |
| Scikit изучите вклад | Scikit-learn, совместимые с проектами | |
| Scikit Image | Обработка изображений в Python | |
| Spyder Ide | Учебная среда развития питона | |
![]() | Катализатор | Pytorch Framework для исследований и разработок глубокого обучения |
Смотрите полный список организаций и пользователей.
@pep8speaks suggest diff в комментарии PR, и он прокомментирует суть Diff, предлагая исправления для PR. Пример@pep8speaks pep8ify на PR, и он создаст запрос на притяжение с изменениями, предложенными autopep8 против отрасли автора PR. autopep8 исправляет большинство ошибок, сообщенных pycodestyle .[skip pep8] в любом месте сообщения о коммит, названии PR или PR описание, чтобы запретить PEP8Speaks комментировать запрос на вытягивание.Это приложение будет работать только для публичных хранилищ. Поэтому, если вы хотите развернуть вилку или использовать приложение для частных репозитории , вот инструкции.
pep8 ). Обновления в приложении объявляются с использованием функции выпуска GitHub здесь. Многие серьезные изменения вносятся по мере того, как сообщество становится больше. Нажмите Watch -> Releases only в верхней части страницы, чтобы получить уведомление о новых конфигурациях или обновлениях функций.
Обычно главная филиала развертывается, как только запросы на притяжение объединяются в репозитории. Однако в каждую пятницу я делаю релиз и убедитесь, что последний код развернут. Вам не нужно ничего делать, чтобы использовать последнюю версию. Если вы используете вилку PEP 8 Speaks, ознакомьтесь с пространством выпуска.
Станьте спонсором золота и получите свой логотип и имя со ссылкой на ваш сайт на нашем Readme и нашем веб -сайте.
Управление самагры | ![]() Самагракс |
Станьте спонсором золота и получите свой логотип и имя со ссылкой на ваш сайт на нашем Readme и нашем веб -сайте.
Python Software Foundation | Переплаться |
Станьте серебряным спонсором и получите свой логотип и имя по ссылке на ваш сайт на нашем Readme и нашем веб -сайте.
CCEXTRACTOR | Судханшу Мишра |
Вы можете поддержать проект, способствуя его разработке. Если у вас есть какие -либо предложения для новых функций или улучшений, пожалуйста, создайте проблему. Запросы на вытягивание наиболее приветствуются! Прочитайте Anploying Doc, чтобы понять, как работает проект и как вы можете внести изменения.
Проект требует размещения на сервере, и из -за которого он также нуждается в финансовой поддержке.
Пожалуйста, прочитайте дело о финансировании PEP 8 Speaks.
Если вы используете этот проект, и вам это нравится, пожалуйста, дайте мне знать. Спасибо!
❤
Этот проект не поддерживает все правила первоначального PEP 8 и, таким образом, верит в настройку Pycodestyle.
Полем