Makefile 2.4 KB
Newer Older
1
.PHONY: deps_table_update modified_only_fixup extra_quality_checks quality style fixup fix-copies test test-examples docs
2
3


4
check_dirs := examples tests src utils
5
6

modified_only_fixup:
7
8
	$(eval modified_py_files := $(shell python utils/get_modified_files.py $(check_dirs)))
	@if test -n "$(modified_py_files)"; then \
9
10
11
12
		echo "Checking/fixing $(modified_py_files)"; \
		black $(modified_py_files); \
		isort $(modified_py_files); \
		flake8 $(modified_py_files); \
13
	else \
14
		echo "No library .py files were modified"; \
15
	fi
16

17
18
19
20
21
# Update src/transformers/dependency_versions_table.py

deps_table_update:
	@python setup.py deps_table_update

22
23
24
25
26
# autogenerating code

autogenerate_code: deps_table_update
	python utils/class_mapping_update.py

27
28
# Check that source code meets quality standards

Sylvain Gugger's avatar
Sylvain Gugger committed
29
extra_quality_checks:
30
	python utils/check_copies.py
31
	python utils/check_table.py
32
	python utils/check_dummies.py
33
	python utils/check_repo.py
34

35
# this target runs checks on all files
36
quality:
37
38
	black --check $(check_dirs)
	isort --check-only $(check_dirs)
Sylvain Gugger's avatar
Sylvain Gugger committed
39
	python utils/custom_init_isort.py --check_only
40
41
	flake8 $(check_dirs)
	${MAKE} extra_quality_checks
42
43

# Format source code automatically and check is there are any problems left that need manual fixing
44

45
extra_style_checks:
Sylvain Gugger's avatar
Sylvain Gugger committed
46
47
48
	python utils/custom_init_isort.py
	python utils/style_doc.py src/transformers docs/source --max_len 119

49
# this target runs checks on all files and potentially modifies some of them
Sylvain Gugger's avatar
Sylvain Gugger committed
50
style:
51
52
	black $(check_dirs)
	isort $(check_dirs)
53
	${MAKE} autogenerate_code
Sylvain Gugger's avatar
Sylvain Gugger committed
54
	${MAKE} extra_style_checks
55
56

# Super fast fix and check target that only works on relevant modified files since the branch was made
57

58
fixup: modified_only_fixup extra_style_checks autogenerate_code extra_quality_checks
59

60
61
62
63
# Make marked copies of snippets of codes conform to the original

fix-copies:
	python utils/check_copies.py --fix_and_overwrite
64
	python utils/check_table.py --fix_and_overwrite
65
	python utils/check_dummies.py --fix_and_overwrite
66

67
68
69
70
71
72
73
74
75
# Run tests for the library

test:
	python -m pytest -n auto --dist=loadfile -s -v ./tests/

# Run tests for examples

test-examples:
	python -m pytest -n auto --dist=loadfile -s -v ./examples/
76
77
78
79

# Check that docs can build

docs:
80
	cd docs && make html SPHINXOPTS="-W -j 4"
Sylvain Gugger's avatar
Sylvain Gugger committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Release stuff

pre-release:
	python utils/release.py

pre-patch:
	python utils/release.py --patch

post-release:
	python utils/release.py --post_release

post-patch:
	python utils/release.py --post_release --patch