summaryrefslogtreecommitdiff
path: root/python-pylint-airflow.spec
blob: e8213f891375ccd3c60b51a34f0ee73cbffedb7a (plain)
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
%global _empty_manifest_terminate_build 0
Name:		python-pylint-airflow
Version:	0.1.0a1
Release:	1
Summary:	A Pylint plugin to lint Apache Airflow code.
License:	MIT License
URL:		https://github.com/BasPH/pylint-airflow
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ff/55/619e9e6b5710eee8439c725ab18e10ca6da47d1c6b90c7a43770debd1915/pylint-airflow-0.1.0a1.tar.gz
BuildArch:	noarch

Requires:	python3-pylint

%description
##############
Pylint-Airflow
##############

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :alt: Code style: Black
  :target: https://github.com/ambv/black

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
  :alt: License: MIT
  :target: https://github.com/BasPH/airflow-examples/blob/master/LICENSE

.. image:: https://img.shields.io/circleci/project/github/BasPH/pylint-airflow/master.svg
  :target: https://circleci.com/gh/BasPH/workflows/pylint-airflow/tree/master

.. image:: images/pylint-airflow.png
   :align: right

Pylint plugin for static code analysis on Airflow code.

*****
Usage
*****

Installation:

.. code-block:: bash

  pip install pylint-airflow

Usage:

.. code-block:: bash

  pylint --load-plugins=pylint_airflow [your_file]

This plugin runs on Python 3.6 and higher.

***********
Error codes
***********

The Pylint-Airflow codes follow the structure ``{I,C,R,W,E,F}83{0-9}{0-9}``, where:

- The characters show:

  - ``I`` = Info
  - ``C`` = Convention
  - ``R`` = Refactor
  - ``W`` = Warning
  - ``E`` = Error
  - ``F`` = Fatal

- ``83`` is the base id (see all here https://github.com/PyCQA/pylint/blob/master/pylint/checkers/__init__.py)
- ``{0-9}{0-9}`` is any number 00-99

The current codes are:

+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Code  | Symbol                            | Description                                                                                                                                                     |
+=======+===================================+=================================================================================================================================================================+
| C8300 | different-operator-varname-taskid | For consistency assign the same variable name and task_id to operators.                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8301 | match-callable-taskid             | For consistency name the callable function '_[task_id]', e.g. PythonOperator(task_id='mytask', python_callable=_mytask).                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8302 | mixed-dependency-directions       | For consistency don't mix directions in a single statement, instead split over multiple statements.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8303 | task-no-dependencies              | Sometimes a task without any dependency is desired, however often it is the result of a forgotten dependency.                                                   |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8304 | task-context-argname              | Indicate you expect Airflow task context variables in the \*\*kwargs argument by renaming to \*\*context.                                                       |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8305 | task-context-separate-arg         | To avoid unpacking kwargs from the Airflow task context in a function, you can set the needed variables as arguments in the function.                           |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8306 | match-dagid-filename              | For consistency match the DAG filename with the dag_id.                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| R8300 | unused-xcom                       | Return values from a python_callable function or execute() method are automatically pushed as XCom.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| W8300 | basehook-top-level                | Airflow executes DAG scripts periodically and anything at the top level of a script is executed. Therefore, move BaseHook calls into functions/hooks/operators. |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8300 | duplicate-dag-name                | DAG name should be unique.                                                                                                                                      |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8301 | duplicate-task-name               | Task name within a DAG should be unique.                                                                                                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8302 | duplicate-dependency              | Task dependencies can be defined only once.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8303 | dag-with-cycles                   | A DAG is acyclic and cannot contain cycles.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8304 | task-no-dag                       | A task must know a DAG instance to run.                                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+

*************
Documentation
*************

Documentation is available on `Read the Docs <https://pylint-airflow.readthedocs.io>`_.

************
Contributing
************

Suggestions for more checks are always welcome, please create an issue on GitHub. Read `CONTRIBUTING.rst <https://github.com/BasPH/pylint-airflow/blob/master/CONTRIBUTING.rst>`_  for more details.




%package -n python3-pylint-airflow
Summary:	A Pylint plugin to lint Apache Airflow code.
Provides:	python-pylint-airflow
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-pylint-airflow
##############
Pylint-Airflow
##############

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :alt: Code style: Black
  :target: https://github.com/ambv/black

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
  :alt: License: MIT
  :target: https://github.com/BasPH/airflow-examples/blob/master/LICENSE

.. image:: https://img.shields.io/circleci/project/github/BasPH/pylint-airflow/master.svg
  :target: https://circleci.com/gh/BasPH/workflows/pylint-airflow/tree/master

.. image:: images/pylint-airflow.png
   :align: right

Pylint plugin for static code analysis on Airflow code.

*****
Usage
*****

Installation:

.. code-block:: bash

  pip install pylint-airflow

Usage:

.. code-block:: bash

  pylint --load-plugins=pylint_airflow [your_file]

This plugin runs on Python 3.6 and higher.

***********
Error codes
***********

The Pylint-Airflow codes follow the structure ``{I,C,R,W,E,F}83{0-9}{0-9}``, where:

- The characters show:

  - ``I`` = Info
  - ``C`` = Convention
  - ``R`` = Refactor
  - ``W`` = Warning
  - ``E`` = Error
  - ``F`` = Fatal

- ``83`` is the base id (see all here https://github.com/PyCQA/pylint/blob/master/pylint/checkers/__init__.py)
- ``{0-9}{0-9}`` is any number 00-99

The current codes are:

+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Code  | Symbol                            | Description                                                                                                                                                     |
+=======+===================================+=================================================================================================================================================================+
| C8300 | different-operator-varname-taskid | For consistency assign the same variable name and task_id to operators.                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8301 | match-callable-taskid             | For consistency name the callable function '_[task_id]', e.g. PythonOperator(task_id='mytask', python_callable=_mytask).                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8302 | mixed-dependency-directions       | For consistency don't mix directions in a single statement, instead split over multiple statements.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8303 | task-no-dependencies              | Sometimes a task without any dependency is desired, however often it is the result of a forgotten dependency.                                                   |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8304 | task-context-argname              | Indicate you expect Airflow task context variables in the \*\*kwargs argument by renaming to \*\*context.                                                       |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8305 | task-context-separate-arg         | To avoid unpacking kwargs from the Airflow task context in a function, you can set the needed variables as arguments in the function.                           |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8306 | match-dagid-filename              | For consistency match the DAG filename with the dag_id.                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| R8300 | unused-xcom                       | Return values from a python_callable function or execute() method are automatically pushed as XCom.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| W8300 | basehook-top-level                | Airflow executes DAG scripts periodically and anything at the top level of a script is executed. Therefore, move BaseHook calls into functions/hooks/operators. |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8300 | duplicate-dag-name                | DAG name should be unique.                                                                                                                                      |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8301 | duplicate-task-name               | Task name within a DAG should be unique.                                                                                                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8302 | duplicate-dependency              | Task dependencies can be defined only once.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8303 | dag-with-cycles                   | A DAG is acyclic and cannot contain cycles.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8304 | task-no-dag                       | A task must know a DAG instance to run.                                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+

*************
Documentation
*************

Documentation is available on `Read the Docs <https://pylint-airflow.readthedocs.io>`_.

************
Contributing
************

Suggestions for more checks are always welcome, please create an issue on GitHub. Read `CONTRIBUTING.rst <https://github.com/BasPH/pylint-airflow/blob/master/CONTRIBUTING.rst>`_  for more details.




%package help
Summary:	Development documents and examples for pylint-airflow
Provides:	python3-pylint-airflow-doc
%description help
##############
Pylint-Airflow
##############

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :alt: Code style: Black
  :target: https://github.com/ambv/black

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
  :alt: License: MIT
  :target: https://github.com/BasPH/airflow-examples/blob/master/LICENSE

.. image:: https://img.shields.io/circleci/project/github/BasPH/pylint-airflow/master.svg
  :target: https://circleci.com/gh/BasPH/workflows/pylint-airflow/tree/master

.. image:: images/pylint-airflow.png
   :align: right

Pylint plugin for static code analysis on Airflow code.

*****
Usage
*****

Installation:

.. code-block:: bash

  pip install pylint-airflow

Usage:

.. code-block:: bash

  pylint --load-plugins=pylint_airflow [your_file]

This plugin runs on Python 3.6 and higher.

***********
Error codes
***********

The Pylint-Airflow codes follow the structure ``{I,C,R,W,E,F}83{0-9}{0-9}``, where:

- The characters show:

  - ``I`` = Info
  - ``C`` = Convention
  - ``R`` = Refactor
  - ``W`` = Warning
  - ``E`` = Error
  - ``F`` = Fatal

- ``83`` is the base id (see all here https://github.com/PyCQA/pylint/blob/master/pylint/checkers/__init__.py)
- ``{0-9}{0-9}`` is any number 00-99

The current codes are:

+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Code  | Symbol                            | Description                                                                                                                                                     |
+=======+===================================+=================================================================================================================================================================+
| C8300 | different-operator-varname-taskid | For consistency assign the same variable name and task_id to operators.                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8301 | match-callable-taskid             | For consistency name the callable function '_[task_id]', e.g. PythonOperator(task_id='mytask', python_callable=_mytask).                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8302 | mixed-dependency-directions       | For consistency don't mix directions in a single statement, instead split over multiple statements.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8303 | task-no-dependencies              | Sometimes a task without any dependency is desired, however often it is the result of a forgotten dependency.                                                   |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8304 | task-context-argname              | Indicate you expect Airflow task context variables in the \*\*kwargs argument by renaming to \*\*context.                                                       |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8305 | task-context-separate-arg         | To avoid unpacking kwargs from the Airflow task context in a function, you can set the needed variables as arguments in the function.                           |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| C8306 | match-dagid-filename              | For consistency match the DAG filename with the dag_id.                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| R8300 | unused-xcom                       | Return values from a python_callable function or execute() method are automatically pushed as XCom.                                                             |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| W8300 | basehook-top-level                | Airflow executes DAG scripts periodically and anything at the top level of a script is executed. Therefore, move BaseHook calls into functions/hooks/operators. |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8300 | duplicate-dag-name                | DAG name should be unique.                                                                                                                                      |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8301 | duplicate-task-name               | Task name within a DAG should be unique.                                                                                                                        |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8302 | duplicate-dependency              | Task dependencies can be defined only once.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8303 | dag-with-cycles                   | A DAG is acyclic and cannot contain cycles.                                                                                                                     |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| E8304 | task-no-dag                       | A task must know a DAG instance to run.                                                                                                                         |
+-------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+

*************
Documentation
*************

Documentation is available on `Read the Docs <https://pylint-airflow.readthedocs.io>`_.

************
Contributing
************

Suggestions for more checks are always welcome, please create an issue on GitHub. Read `CONTRIBUTING.rst <https://github.com/BasPH/pylint-airflow/blob/master/CONTRIBUTING.rst>`_  for more details.




%prep
%autosetup -n pylint-airflow-0.1.0a1

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-pylint-airflow -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.0a1-1
- Package Spec generated