File: .justfile

package info (click to toggle)
python-msgspec 0.20.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,416 kB
  • sloc: javascript: 23,944; ansic: 20,940; python: 19,752; makefile: 26; sh: 23
file content (312 lines) | stat: -rw-r--r-- 7,377 bytes parent folder | download
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
# Disable showing recipe lines before execution.
set quiet

# Enable unstable features.
set unstable

# Configure the shell for Windows.
set windows-shell := ["pwsh.exe", "-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-Command"]

# Provide a consistent experience across Docker-compatible CLIs.
export DOCKER_CLI_HINTS := "0"

# We don't want to install any dev dependencies by default.
export UV_NO_DEV := "true"

# We don't want activated virtual environments to interfere with environment management.
unexport VIRTUAL_ENV

# We apply a unique label to each dev container that is used to find the container ID.
# The devcontainer CLI automatically adds the `devcontainer.local_folder` label but on
# Windows the drive letter is lowercased.
repo_id := sha256(lowercase(justfile_directory()))

# This is the parent directory for virtual environments.
env_base := join(data_local_directory(), "msgspec", "dev", repo_id, "venvs")

# This determines the version of Python with which to use in environments rather than
# the default behavior of using the highest version compatible with the project.
python := ""

# This determines whether to rebuild the C extension for recipes that depend on the project.
rebuild := "false"

# This determines whether to build a debug version of the C extension.
debug := "false"

# List all targets.
[private]
default:
  just --list

# Invoke the Git hook manager.
[group: "Static Analysis"]
prek arg="--help" *args: (
  env-run "hooks"
  "prek" arg args
)
alias pre-commit := prek

# Run the hooks.
[group: "Static Analysis"]
hooks-fix *args: (
  env-run "hooks"
  "prek run --all-files"
  args
)
alias hooks := hooks-fix

# Run the hooks without applying fixes.
[group: "Static Analysis"]
hooks-check *args: (
  env-run "hooks"
  "prek run --all-files --hook-stage manual"
  args
)
alias check := hooks-check

# Run all tests.
[group: "Testing"]
test-all *args: (
  env-run "test" "pytest" args
) (
  test-doc args
)

# Run unit tests.
[group: "Testing"]
test-unit *args: (
  env-run "test"
  "pytest -o testpaths=tests/unit"
  args
)
alias test := test-unit

# Run type checker compatibility tests.
[group: "Testing"]
test-typing *args: (
  env-run "test"
  "pytest -o testpaths=tests/typing"
  args
)

# Run doctests.
[group: "Testing"]
test-doc *args: (
  env-run "test"
  "pytest --doctest-modules --pyargs msgspec"
  args
)

# Build the documentation.
[group: "Documentation"]
doc-build: (
  env-run "doc"
  "sphinx-build -b html docs site --fail-on-warning"
)

# Serve the documentation.
[group: "Documentation"]
doc-serve: (
  env-run "doc"
  "python -c \"import pathlib,webbrowser;webbrowser.open_new_tab(pathlib.Path('site/index.html').absolute().as_uri())\""
)

# Run performance tests.
[group: "Profiling"]
test-perf name="" *args: (
  env-run "prof"
  (
    if name == "" {
      "python -c \"import os;print('Available tests:', os.linesep.join(['', *sorted(e[5:].split('.')[0] for e in os.listdir('tests/prof/perf') if e.startswith('test_')), 'all (run everything)']))\""
    } else {
      (
        if name =~ "^-" {
          error(
            "Invalid test name: " + name
          )
        } else if name == "all" {
          "pytest -o testpaths=tests/prof/perf"
        } else {
          "pytest tests/prof/perf/test_" + name + ".py"
        }
      )
      + " --benchmark-name short --benchmark-disable-gc"
    }
  )
  args
)

# Run benchmarks.
[group: "Benchmarking"]
bench-run name="" *args: (
  env-run "bench"
  (
    if name == "" {
      "python -c \"import os;print('Available benchmarks:', os.linesep.join(['', *sorted(e[6:].split('.')[0] for e in os.listdir('benchmarks') if e.startswith('bench_')), 'all (run everything)']))\""
    } else {
      "python -m benchmarks.bench_" + name
    }
  )
  args
)
alias bench := bench-run

# Run a command within an environment.
[group: "Environment Management"]
env-run env +cmd: (
  _with_env env "run" "--" cmd
)
alias env := env-run

# Sync an environment's dependencies.
[group: "Environment Management"]
env-sync env="test": (
  _with_env (
    if env == "all" { "none" } else { env }
  ) (
    if env == "all" { "run" } else { "sync" }
  ) (
    if env == "all" { "just _env_sync_all" } else { "" }
  )
)
alias sync := env-sync

# Display the path to an environment.
[group: "Environment Management"]
env-path env="":
  echo {{ \
    if env == "" { \
      quote(env_base) \
    } else { \
      quote(join(env_base, env)) \
    } \
  }}

# Start the dev container.
[group: "Dev Container"]
dev-start:
  devcontainer up --workspace-folder . --id-label repo.id={{ repo_id }}

# Run a command within the dev container.
[group: "Dev Container"]
dev-run +cmd: (
  _with_dev_container_id
  "docker exec --user vscode -it $id zsh -lc " + quote(cmd)
)
alias run := dev-run

# Open a shell in the dev container.
[group: "Dev Container"]
dev-shell cmd="zsh -l": (
  _with_dev_container_id
  "docker exec --user vscode -it $id " + cmd
)
alias shell := dev-shell

# Stop the dev container.
[group: "Dev Container"]
dev-stop: (
  _with_dev_container_id
  "docker stop $id"
)

# Remove the dev container.
[group: "Dev Container"]
dev-remove: (
  _with_dev_container_id
  "docker rm $id"
)

[private]
_with_dev_container_id cmd:
  {{ \
    if os() == "windows" { \
      "$id = docker ps --all --format '{{.ID}}' --filter 'label=repo.id=" + repo_id + "'; " + \
      "if ($id) { " + cmd + " } else { Write-Host 'No devcontainer running' }" \
    } else { \
      "id=$(docker ps --all --format '{{.ID}}' --filter 'label=repo.id=" + repo_id + "'); " + \
      "if [ -n \"$id\" ]; then " + cmd + "; else echo 'No devcontainer running'; fi" \
    } \
  }}

[private]
_env_sync_all: (
  _with_env "test" "sync"
) (
  _with_env "doc" "sync"
) (
  _with_env "bench" "sync"
) (
  _with_env "prof" "sync"
)

[private]
[no-exit-message]
[no-cd]
_with_env env action *args:
  {{ \
    if env == "none" { \
      "" \
    } else { \
      if os() == "windows" { \
        "$env:UV_PROJECT_ENVIRONMENT=" + quote(join(env_base, env)) + "; " \
      } else { \
        "UV_PROJECT_ENVIRONMENT=" + quote(join(env_base, env)) + " " \
      } \
    } \
  }}{{ \
    if python == "" { \
      "" \
    } else { \
      if os() == "windows" { \
        "$env:UV_PYTHON=" + quote(python) + "; " \
      } else { \
        "UV_PYTHON=" + quote(python) + " " \
      } \
    } \
  }}{{ \
    if debug =~ "^(true|1)$" { \
      if os() == "windows" { \
        "$env:MSGSPEC_DEBUG='1'; " \
      } else { \
        "MSGSPEC_DEBUG='1' " \
      } \
    } else { \
      "" \
    } \
  }}uv {{ \
    if action == "run" { \
      "run" \
    } else if action == "sync" { \
      "sync" \
    } else { \
      error( \
        "Unknown action: " + action \
      ) \
    } \
  }}{{ \
    if rebuild =~ "^(true|1)$" { \
      " --reinstall-package msgspec" \
    } else { \
      "" \
    } \
  }} {{ \
    if env == "test" { \
      "--group test-unit --group test-typing" \
    } else if env == "doc" { \
      "--group doc" \
    } else if env == "prof" { \
      "--group test-prof" \
    } else if env == "bench" { \
      "--group bench" \
    } else if env == "hooks" { \
      "--only-group hooks" \
    } else if env == "none" { \
      "--isolated --no-sync --no-config" \
    } else { \
      error( \
        "Unknown environment: " + env \
      ) \
    } \
  }} {{ args }}