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
|
PACKAGE=factory
TESTS_DIR=tests
DOC_DIR=docs
EXAMPLES_DIR=examples
SETUP_PY=setup.py
# Use current python binary instead of system default.
COVERAGE = python $(shell which coverage)
FLAKE8 = flake8
ISORT = isort
CTAGS = ctags
all: default
default:
# Package management
# ==================
# DOC: Remove temporary or compiled files
clean:
find . -type f -name '*.pyc' -delete
find . -type f -path '*/__pycache__/*' -delete
find . -type d -empty -delete
@rm -rf tmp_test/
# DOC: Install and/or upgrade dependencies
update:
pip install --upgrade pip setuptools
pip install --upgrade --editable .[dev,doc]
pip freeze
release:
fullrelease
.PHONY: clean update release
# Tests and quality
# =================
# DOC: Run tests for all supported versions (creates a set of virtualenvs)
testall:
tox
# DOC: Run tests for the currently installed version
# Remove cgi warning when dropping support for Django 3.2.
test:
mypy --ignore-missing-imports tests/test_typing.py
python \
-b \
-X dev \
-Werror \
-Wignore:::mongomock: \
-Wignore:::mongomock.__version__: \
-Wignore:::pkg_resources: \
-m unittest
# DOC: Test the examples
example-test:
$(MAKE) -C $(EXAMPLES_DIR) test
# Note: we run the linter in two runs, because our __init__.py files has specific warnings we want to exclude
# DOC: Perform code quality tasks
lint:
$(FLAKE8) --exclude $(PACKAGE)/__init__.py $(EXAMPLES_DIR) $(PACKAGE) $(SETUP_PY) $(TESTS_DIR)
$(FLAKE8) --ignore F401 $(PACKAGE)/__init__.py
$(ISORT) --check-only --diff $(EXAMPLES_DIR) $(PACKAGE) $(SETUP_PY) $(TESTS_DIR)
check-manifest
coverage:
$(COVERAGE) erase
$(COVERAGE) run --branch -m unittest
$(COVERAGE) report
$(COVERAGE) html
.PHONY: test testall example-test lint coverage
# Development
# ===========
# DOC: Generate a "tags" file
TAGS:
$(CTAGS) --recurse $(PACKAGE) $(TESTS_DIR)
.PHONY: TAGS
# Documentation
# =============
# DOC: Compile the documentation
doc:
$(MAKE) -C $(DOC_DIR) SPHINXOPTS="-n -W" html
linkcheck:
$(MAKE) -C $(DOC_DIR) linkcheck
spelling:
$(MAKE) -C $(DOC_DIR) SPHINXOPTS=-W spelling
# DOC: Show this help message
help:
@grep -A1 '^# DOC:' Makefile \
| awk ' \
BEGIN { FS="\n"; RS="--\n"; opt_len=0; } \
{ \
doc=$$1; name=$$2; \
sub("# DOC: ", "", doc); \
sub(":", "", name); \
if (length(name) > opt_len) { \
opt_len = length(name) \
} \
opts[NR] = name; \
docs[name] = doc; \
} \
END { \
pat="%-" (opt_len + 4) "s %s\n"; \
asort(opts); \
for (i in opts) { \
opt=opts[i]; \
printf pat, opt, docs[opt] \
} \
}'
.PHONY: doc linkcheck help
|
