Skip to content

CI move non-standard-import checks over to pre-commit #37240

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

Merged
merged 7 commits into from
Oct 22, 2020
Merged

CI move non-standard-import checks over to pre-commit #37240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ba9c50
move non-standard-imports over to pre-commit
MarcoGorelli Oct 19, 2020
7ce873d
update to use verbose regular expression
Oct 20, 2020
fd1b359
missing or
Oct 20, 2020
d414d7b
add comments
Oct 21, 2020
e35d843
dedent
Oct 21, 2020
55a07c0
:art:
Oct 21, 2020
26e7c23
Merge remote-tracking branch 'upstream/master' into non-standard-imports
MarcoGorelli Oct 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,44 @@ repos:
- id: incorrect-sphinx-directives
name: Check for incorrect Sphinx directives
language: pygrep
entry: >-
\.\. (autosummary|contents|currentmodule|deprecated
|function|image|important|include|ipython|literalinclude
|math|module|note|raw|seealso|toctree|versionadded
|versionchanged|warning):[^:]
entry: |
(?x)
# Check for cases of e.g. .. warning: instead of .. warning::
\.\.\ (
autosummary|contents|currentmodule|deprecated|
function|image|important|include|ipython|literalinclude|
math|module|note|raw|seealso|toctree|versionadded|
versionchanged|warning
):[^:]
files: \.(py|pyx|rst)$
- id: non-standard-imports
name: Check for non-standard imports
language: pygrep
entry: |
(?x)
# Check for imports from pandas.core.common instead of `import pandas.core.common as com`
from\ pandas\.core\.common\ import|
from\ pandas\.core\ import\ common|

# Check for imports from collections.abc instead of `from collections import abc`
from\ collections\.abc\ import|

from\ numpy\ import\ nan
types: [python]
- id: non-standard-imports-in-tests
name: Check for non-standard imports in test suite
language: pygrep
entry: |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as a followup we might want to update the contributing docs to put a pointer to these types of checks here (e.g. rather than just mentioning code_checks.sh) esp as we are using these a lot more now

(?x)
# Check for imports from pandas._testing instead of `import pandas._testing as tm`
from\ pandas\._testing\ import|
from\ pandas\ import\ _testing\ as\ tm|

# No direct imports from conftest
conftest\ import|
import\ conftest
types: [python]
files: ^pandas/tests/
- id: incorrect-code-directives
name: Check for incorrect code block or IPython directives
language: pygrep
Expand Down
25 changes: 0 additions & 25 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,31 +110,6 @@ fi
### PATTERNS ###
if [[ -z "$CHECK" || "$CHECK" == "patterns" ]]; then

# Check for imports from pandas.core.common instead of `import pandas.core.common as com`
# Check for imports from collections.abc instead of `from collections import abc`
MSG='Check for non-standard imports' ; echo $MSG
invgrep -R --include="*.py*" -E "from pandas.core.common import" pandas
RET=$(($RET + $?)) ; echo $MSG "DONE"
invgrep -R --include="*.py*" -E "from pandas.core import common" pandas
RET=$(($RET + $?)) ; echo $MSG "DONE"
invgrep -R --include="*.py*" -E "from collections.abc import" pandas
RET=$(($RET + $?)) ; echo $MSG "DONE"
invgrep -R --include="*.py*" -E "from numpy import nan" pandas
RET=$(($RET + $?)) ; echo $MSG "DONE"

# Checks for test suite
# Check for imports from pandas._testing instead of `import pandas._testing as tm`
invgrep -R --include="*.py*" -E "from pandas._testing import" pandas/tests
RET=$(($RET + $?)) ; echo $MSG "DONE"
invgrep -R --include="*.py*" -E "from pandas import _testing as tm" pandas/tests
RET=$(($RET + $?)) ; echo $MSG "DONE"

# No direct imports from conftest
invgrep -R --include="*.py*" -E "conftest import" pandas/tests
RET=$(($RET + $?)) ; echo $MSG "DONE"
invgrep -R --include="*.py*" -E "import conftest" pandas/tests
RET=$(($RET + $?)) ; echo $MSG "DONE"

MSG='Check for use of exec' ; echo $MSG
invgrep -R --include="*.py*" -E "[^a-zA-Z0-9_]exec\(" pandas
RET=$(($RET + $?)) ; echo $MSG "DONE"
Expand Down