pythonのフォーマットチェックCIとリンタCIをいれる #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

meltingrabbit merged 20 commits into develop from feature/add_python_formatter_linter

Jan 19, 2022

Collaborator

meltingrabbit commented Jan 17, 2022 •

edited

Loading

概要

pythonのフォーマットチェックCIとリンタCIをいれる

Issue

pythonで書かれたツール類に，フォーマッタ，リンタを入れる #89

詳細

以下を入れた
- formatter: https://github.com/reviewdog/action-black
- linter: https://github.com/reviewdog/action-flake8
１行最大文字数はとりあえず100
flake8 で ignore = E203,W503,W504 としてるのは，blackと競合するから
flake8 で ignore = E402 としているのは python の linter である flake8 の E402 を ignore から解除する #195 で対応
blackは

c2a-core/.github/workflows/python_check_format.yml

Lines 22 to 23 in 9e2faa9

# reporter: github-pr-review # TODO: いい感じになったら直す

reporter: github-pr-check

としてる

flake8 は

c2a-core/pyproject.toml

Lines 6 to 8 in 9e2faa9

    
           # TODO: .flake8 を消してこちらに移植する 
        
           # [tool.flake8] 
        
           # max-line-length = 100

としている．

検証結果

CIと既存のテストがすべて通ればOK

影響範囲

今後，このCIの通過が必須になる

meltingrabbit added enhancement priority::medium tools labels

meltingrabbit requested review from sksat and yngyu

January 17, 2022 06:55

meltingrabbit self-assigned this

Collaborator Author

meltingrabbit commented Jan 17, 2022

あ～，diff出ない部分はこのスレッドにはreviewdog出てくれないのね． Unchanged files with check annotations にはでてる．

Collaborator Author

meltingrabbit commented Jan 17, 2022

あと， black もreview dogあるな

https://github.com/reviewdog/action-black

こっちにするか．

This comment has been minimized.

Sign in to view

Collaborator Author

meltingrabbit commented Jan 17, 2022 •

edited

Loading

ん？ blackはそもそも，「would reformat」しか言わないから， reviewdogを指定しても，Unchanged files with check annotations にはでない？

github-actions bot reviewed

View reviewed changes

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

meltingrabbit force-pushed the feature/add_python_formatter_linter branch from cafd59e to 9f45051 Compare

January 17, 2022 11:13

github-actions bot reviewed

View reviewed changes

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

meltingrabbit force-pushed the feature/add_python_formatter_linter branch 3 times, most recently from ba8ab9a to 7aaa59d Compare

January 17, 2022 11:23

github-actions bot reviewed

View reviewed changes

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

meltingrabbit force-pushed the feature/add_python_formatter_linter branch from 7aaa59d to 09d7a96 Compare

January 17, 2022 13:44

Collaborator Author

meltingrabbit commented Jan 17, 2022 •

edited

Loading

flake8 で pyproject.toml を使うには， pflake8 を使わないといけない，だと！？

reviewdogあるかな．．．

↓

なかった

Collaborator Author

meltingrabbit commented Jan 17, 2022

@yngyu と雑に話して， line-length = 100 あたりで良いのでは？となった．

88 だと，テレメ名やコマンド名が長いのでしんどい．

github-actions bot reviewed

View reviewed changes

github-actions bot left a comment

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

flake8

Script/CI/check_coding_rule.py|599 col 20| invalid escape sequence '\w'
Script/CI/check_coding_rule.py|603 col 40| invalid escape sequence '\w'
Script/CI/check_coding_rule.py|603 col 76| invalid escape sequence '\w'
Script/CI/check_coding_rule.py|625 col 28| invalid escape sequence '\d'
Script/CI/check_coding_rule.py|683 col 32| invalid escape sequence '\w'
Script/CI/check_coding_rule.py|689 col 32| invalid escape sequence '\d'
Script/CI/check_coding_rule.py|817 col 39| whitespace before ':'
Script/CI/check_coding_rule.py|828 col 5| local variable 'target_len' is assigned to but never used
Script/CI/check_coding_rule.py|906 col 9| local variable 'after' is assigned to but never used
Script/CI/check_coding_rule.py|906 col 29| whitespace before ':'

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Outdated Show resolved Hide resolved

...inimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_logger.py Outdated Show resolved Hide resolved

...inimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_logger.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Collaborator Author

meltingrabbit commented Jan 17, 2022

black，通るようになったな．（なお flake8）

github-actions bot reviewed

View reviewed changes

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

github-actions bot reviewed

View reviewed changes

github-actions bot left a comment

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

flake8

Script/CI/check_coding_rule.py|588 col 13| line break before binary operator
Script/CI/check_coding_rule.py|589 col 13| line break before binary operator
Script/CI/check_coding_rule.py|590 col 13| line break before binary operator
Script/CI/check_coding_rule.py|591 col 13| line break before binary operator
Script/CI/check_coding_rule.py|592 col 13| line break before binary operator
Script/CI/check_coding_rule.py|593 col 13| line break before binary operator
Script/CI/check_coding_rule.py|598 col 13| line break before binary operator
Script/CI/check_coding_rule.py|599 col 13| line break before binary operator
Script/CI/check_coding_rule.py|600 col 13| line break before binary operator
Script/CI/check_coding_rule.py|601 col 13| line break before binary operator
Script/CI/check_coding_rule.py|602 col 13| line break before binary operator
Script/CI/check_coding_rule.py|603 col 13| line break before binary operator
Script/CI/check_coding_rule.py|604 col 13| line break before binary operator
Script/CI/check_coding_rule.py|647 col 21| line break before binary operator
Script/CI/check_coding_rule.py|648 col 21| line break before binary operator
Script/CI/check_coding_rule.py|649 col 21| line break before binary operator
Script/CI/check_coding_rule.py|706 col 21| line break before binary operator
Script/CI/check_coding_rule.py|707 col 21| line break before binary operator
Script/CI/check_coding_rule.py|708 col 21| line break before binary operator

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

...nimum_user_for_s2e/src/src_user/Test/test/src_core/System/EventManager/test_event_handler.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

Script/CI/check_coding_rule.py Show resolved Hide resolved

github-actions bot reviewed

View reviewed changes

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

meltingrabbit force-pushed the feature/add_python_formatter_linter branch from c6569c0 to 83460b7 Compare

January 17, 2022 15:13

github-actions bot reviewed

View reviewed changes

Script/CI/check_coding_rule.py Outdated Show resolved Hide resolved

meltingrabbit force-pushed the feature/add_python_formatter_linter branch 2 times, most recently from a940c3d to bc3744f Compare

January 17, 2022 15:21

meltingrabbit changed the title ~~WIP: pythonのフォーマットチェックCIとリンタCIをいれる~~ pythonのフォーマットチェックCIとリンタCIをいれる

meltingrabbit added 18 commits

January 19, 2022 19:10


          add python format check and lint workflow

74b9a2f


          Update python_check_format.yml

4e7498c


          fix reviewdog settings

1069e46


          Create pyproject.toml

ce41b4f


          add .flake8

a5fc1bb


          fix line-length

f1b7e74


          apply black

392e6ce


          fix for flake8

b10b1a3


          add ignore of flake8


          fix .flake8 ignore

ee19b27


          fix for flake8

124f29e


          apply black

1c189f1


          fix for flake8

29fa258

fix

636dd8e


          fix .flake8 ignore

eb9fa52


          fix readme of test

596a5cf


          fix flake8 E501

8763ba4


          fix flake8 E714

fd1c11e

meltingrabbit force-pushed the feature/add_python_formatter_linter branch from fd1099b to fd1c11e Compare

January 19, 2022 10:12

Collaborator Author

meltingrabbit commented Jan 19, 2022

他でtestがマージされたのでrebase

test_time_manager.py がやり直し


          apply black

90ac5c0

sksat reviewed

View reviewed changes

.flake8 Outdated Show resolved Hide resolved


          add comment in .flake8

932a67e

sksat approved these changes

View reviewed changes

meltingrabbit merged commit 7eaa41a into develop

meltingrabbit deleted the feature/add_python_formatter_linter branch

January 19, 2022 11:04

This was referenced Jan 19, 2022

Add formatter (black) and linter (flake8) ut-issl/c2a-tlm-cmd-code-generator#14

Merged

Add formatter (black) and linter (flake8) ut-issl/c2a-enum-loader#9

Merged

Add formatter (black) and linter (flake8) ut-issl/python-wings-interface#7

Merged

meltingrabbit mentioned this pull request

Update main (v3.5.0) on 2022-02-08 #243

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement priority::medium tools