forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpylint.mk
More file actions
233 lines (215 loc) · 6.35 KB
/
pylint.mk
File metadata and controls
233 lines (215 loc) · 6.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
#/
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/
# VARIABLES #
# Define the path to the [Pylint][1] executable.
#
# To install Pylint:
#
# ```bash
# $ pip install pylint
# ```
#
# [1]: https://github.com/PyCQA/pylint
PYLINT ?= pylint
# Define the path to the Pylint configuration file:
PYLINT_CONF ?= $(CONFIG_DIR)/pylint/.pylintrc
# Define the command-line options to use when invoking the Pylint executable:
PYLINT_FLAGS ?= \
--rcfile $(PYLINT_CONF) \
--reports n \
--output-format text
# RULES #
#/
# Checks whether [Pylint][1] is installed.
#
# [1]: https://github.com/PyCQA/pylint
#
# @private
#
# @example
# make check-pylint
#/
check-pylint:
ifeq (, $(shell command -v $(PYLINT) 2>/dev/null))
$(QUIET) echo ''
$(QUIET) echo 'Pylint is not installed. Please install Pylint and try again.'
$(QUIET) echo 'For install instructions, see https://github.com/PyCQA/pylint.'
$(QUIET) echo ''
$(QUIET) exit 1
else
$(QUIET) echo 'Pylint is installed.'
$(QUIET) exit 0
endif
.PHONY: check-pylint
#/
# Lints Python source code quality.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Python source files (e.g., lint all Python source files for a particular package).
#
# @private
# @param {string} [SOURCES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make pylint-src
#
# @example
# make pylint-src SOURCES_FILTER=".*/math/base/special/abs/.*"
#/
pylint-src:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_PYTHON_SOURCES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_PYTHON_SOURCES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: pylint-src
#/
# Lints Python test fixture code quality.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Python test fixture files (e.g., lint all Python test fixture files for a particular package).
#
# @private
# @param {string} [TESTS_FIXTURES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make pylint-tests-fixtures
#
# @example
# make pylint-tests-fixtures TESTS_FIXTURES_FILTER=".*/math/base/special/abs/.*"
#/
pylint-tests-fixtures:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_PYTHON_TESTS_FIXTURES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_PYTHON_TESTS_FIXTURES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: pylint-tests-fixtures
#/
# Lints Python examples code quality.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Python examples files (e.g., lint all Python examples files for a particular package).
#
# @private
# @param {string} [EXAMPLES_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make pylint-examples
#
# @example
# make pylint-examples EXAMPLES_FILTER=".*/math/base/special/abs/.*"
#/
pylint-examples:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_PYTHON_EXAMPLES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_PYTHON_EXAMPLES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: pylint-examples
#/
# Lints Python benchmark code quality.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Python benchmark files (e.g., lint all Python benchmark files for a particular package).
#
# @private
# @param {string} [BENCHMARKS_FILTER] - file path pattern (e.g., `.*/math/base/special/abs/.*`)
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make pylint-benchmarks
#
# @example
# make pylint-benchmarks BENCHMARKS_FILTER=".*/math/base/special/abs/.*"
#/
pylint-benchmarks:
ifeq ($(FAIL_FAST), true)
$(QUIET) $(FIND_PYTHON_BENCHMARKS_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || exit 1; \
done
else
$(QUIET) $(FIND_PYTHON_BENCHMARKS_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: pylint-benchmarks
#/
# Lints code quality for a specified list of Python files.
#
# ## Notes
#
# - This rule is useful when wanting to lint a list of Python files generated by some other command (e.g., a list of changed Python files obtained via `git diff`).
#
# @private
# @param {string} FILES - list of Python file paths
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make pylint-files FILES='/foo/file.py /bar/file.py'
#/
pylint-files:
ifeq ($(FAIL_FAST), true)
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || exit 1; \
done
else
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting file: $$file"; \
$(PYLINT) $(PYLINT_FLAGS) $$file || echo 'Linting failed.'; \
done
endif
.PHONY: pylint-files