Add flake8 and isort checks on python files in cpp folder
#2838
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garth-wells
reviewed
Oct 30, 2023
cpp/.flake8
Outdated
There was a problem hiding this comment.
Could we move this file to the top level directory and remove python/.flake8?
There was a problem hiding this comment.
python/.flake8 is not there yet, it will be once #2707 is merged.
| @@ -69,13 +69,21 @@ jobs: | |||
| run: pip3 install matplotlib | |||
| - name: Flake8 checks | |||
| run: | | |||
| cd cpp/ | |||
There was a problem hiding this comment.
Could we just do python3 -m flake8 cpp/?
There was a problem hiding this comment.
It depends: do you want cpp/doc/source/conf.py to be tested too?
There was a problem hiding this comment.
I have a vague recollection that the order of the imports in cpp/doc/source/conf.py is important.
There was a problem hiding this comment.
I am not sure if that is a yes or a no to my question 😄
- if you want
cpp/doc/source/conf.pyto be tested, then we could move topython3 -m flake8 cpp/, but then it stands to reason thatpython/doc/source/conf.pyshould be tested too, and thus we should try to move topython3 -m flake8 python/too. - if you do not want
cpp/doc/source/conf.pyto be tested, then we cannot just dopython3 -m flake8 cpp/.
There was a problem hiding this comment.
Answer is do not use isort on cpp/doc/source/conf.py without testing.
garth-wells
approved these changes
Oct 30, 2023
francesco-ballarin
force-pushed
the
francesco/cpp-flake8
branch
from
01919e9
to
6b2edf6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are some python files in the
cppfolder, but they were not passed throughflake8orisorton CI. For the time being there is no point in runningmypyon them becauseuflis not typed.