Repository navigation
Expand file tree
/
Copy pathpyproject.toml
More file actions
172 lines (160 loc) · 7.63 KB
/
Copy pathpyproject.toml
File metadata and controls
172 lines (160 loc) · 7.63 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "dsoxlab"
version = "0.9.8"
description = "Turn declarative exercises into reproducible, runnable and verifiable lab environments"
readme = "README.md"
requires-python = ">=3.11"
license = "Apache-2.0"
license-files = ["LICENSE", "NOTICE"]
authors = [
{ name = "Stéphane Robert" },
]
keywords = ["education", "labs", "devops", "linux", "ansible", "kubernetes", "training"]
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Education",
"Intended Audience :: System Administrators",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Topic :: Education",
"Topic :: System :: Systems Administration",
"Typing :: Typed",
]
dependencies = [
"typer>=0.12",
"rich>=13",
"pyyaml>=6",
# ansible-runner pilote ansible-core programmatiquement (API officielle
# Red Hat utilisée par AAP et ansible-navigator).
#
# ansible-runner ne tire PAS ansible-core : sans lui, tout `run` sur un lab
# vm sortait en rc=127. Déclaré explicitement, environ 100 Mo assumés.
# Voir docs/decisions/0003-explicit-ansible-core.md
"ansible-runner>=2.4",
"ansible-core>=2.16",
# pytest + pytest-testinfra : dsoxlab check les invoque pour valider
# les labs. Embarqués dans le tool install pour que l'apprenant n'ait
# rien à installer localement (cohérent avec la philosophie "dsoxlab
# pilote tout").
"pytest>=8",
"pytest-testinfra>=10",
]
[project.scripts]
dsoxlab = "dsoxlab.cli:main"
[project.urls]
Homepage = "https://www.stephane-robert.info/"
Documentation = "https://github.com/stephrobert/dsoxlab/blob/main/docs/README.md"
Repository = "https://github.com/stephrobert/dsoxlab"
Issues = "https://github.com/stephrobert/dsoxlab/issues"
Changelog = "https://github.com/stephrobert/dsoxlab/blob/main/CHANGELOG.md"
[tool.hatch.build.targets.wheel]
# `packages` walks src/dsoxlab and includes every file under it — Python
# modules, the PEP 561 `py.typed` marker, and the provisioning templates
# (Terraform HCL + cloud-init) consumed via importlib.resources. No
# force-include is needed (and it would duplicate the templates package).
packages = ["src/dsoxlab"]
[dependency-groups]
dev = [
"pytest>=8",
"mypy>=1.9",
"ruff>=0.4",
"types-PyYAML>=6",
# Éprouve les schémas publiés sur des documents réels (tests/
# test_schemas_sur_documents.py). Volontairement hors runtime : le
# moteur a son propre parseur et ne lit jamais ses schémas.
"jsonschema>=4.20",
"pre-commit>=3.5",
]
# Kept out of `dev` on purpose: atheris builds a native libFuzzer extension and
# is not needed to lint, type-check or test. Only the fuzzing job installs it.
# uv run --group fuzz python fuzz/fuzz_lab_yaml.py -atheris_runs=50000
fuzz = [
"atheris>=2.3",
]
[tool.ruff]
src = ["src"]
line-length = 100
[tool.ruff.lint]
# Le jeu de règles est déclaré ICI, en entier : `select` remplace le défaut de
# ruff au lieu de l'étendre, pour qu'une montée de version ne change pas le
# périmètre à notre place (ruff 0.16 : de 0 à 123 erreurs le 2026-08-20).
# Voir docs/decisions/0008-explicit-ruff-rule-set.md
select = [
"F", # pyflakes : nom indéfini, import mort. Le socle non négociable.
"E", # pycodestyle (erreurs). E501 écarté plus bas, mesure à l'appui.
"W", # pycodestyle (avertissements) : espaces morts, fin de fichier.
"I", # isort : ordre d'import déterministe, donc pas de bruit de diff.
"UP", # pyupgrade : le plancher est py3.11, la syntaxe doit s'y tenir.
"B", # bugbear : classes de bugs réels (défaut mutable, zip inégal,
# `raise` qui perd sa cause dans un `except`).
"S", # bandit : le garde-fou sécurité d'un outil qui lance des process.
"SIM", # simplify : `if` imbriqués et `with` empilés qui cachent la logique.
"ISC", # concaténation implicite : ISC004 attrape la virgule oubliée dans
# une liste de chaînes, qui fusionne deux éléments en silence.
"RUF", # règles ruff, dont RUF100 : un `# noqa` qui ne sert plus est une
# exception qui survit à sa raison, et personne ne le voit.
"PLE", # pylint (erreurs) : ce qui casse à l'exécution.
"PLW", # pylint (avertissements), dont PLW1510 : un `subprocess.run` sans
# `check=` explicite. C'est LE défaut récurrent de ce dépôt
# (un échec avalé qui ressort en succès), il doit être décidé
# site par site, jamais par omission.
"BLE", # `except Exception:` nu : même famille de défaut, autre porte.
"DTZ", # datetime naïf : la base SQLite horodate, elle doit le faire en UTC.
"LOG", # usage correct du module logging.
"G", # formatage paresseux des logs (`%s`, pas de f-string).
"PTH", # pathlib : « `pathlib.Path` partout » est une règle écrite du dépôt,
# autant la faire tenir par l'outil.
"PYI", # conventions de typage (`__enter__` qui rend `self`…), sous mypy strict.
"EXE", # shebang et bit d'exécution cohérents.
"FURB", # refurb : tournures obsolètes que le typage ne voit pas.
]
# Familles délibérément ÉCARTÉES (TRY, PLR, PLC, N, INP, PERF, ANN, D, ARG, EM,
# FBT, TID, TC, SLF, T20, ERA, COM) : chacune avec sa mesure sur ce code dans
# docs/decisions/0008-explicit-ruff-rule-set.md
ignore = [
# Propre à un CLI qui orchestre des outils externes ; pas des vulnérabilités.
"S603", # subprocess appelé avec une liste d'arguments (sans shell) — la forme sûre
"S607", # chemin partiel — les outils (git, ssh, terraform…) sont résolus par le PATH
"S101", # assert utilisé pour restreindre un type dans du code typé
# Mesuré : 202 violations, dont 159 dans i18n/strings/{en,fr}.py. Les
# replier découperait des phrases affichées à l'apprenant en concaténations
# implicites, où une espace manquante à la jointure ne se voit pas — et le
# projet n'a pas de formateur pour le faire à notre place. `line-length`
# reste déclaré ci-dessus : c'est la cible, pas un couperet.
"E501", # ligne trop longue
# Ce code est francophone et sa sortie est typographiée : « – », « − »,
# « × », « ℹ » sont choisis, pas des coquilles. Les « corriger » dégraderait
# ce que lit l'apprenant.
"RUF001", "RUF002", "RUF003", # caractères unicode « ambigus »
]
[tool.ruff.lint.per-file-ignores]
"tests/**" = ["S101"] # assertions are the whole point of a test
"tests_e2e/**" = ["S101"] # même raison, pour la suite boîte noire
[tool.mypy]
strict = true
files = ["src/dsoxlab"]
# ansible-runner ne publie ni stubs ni marqueur py.typed. On neutralise
# l'erreur d'import ici plutôt que par des « type: ignore » dispersés
# dans infra/ansible.py : la dépendance est non typée en amont, ce n'est
# pas un défaut de notre code.
[[tool.mypy.overrides]]
module = ["ansible_runner.*"]
ignore_missing_imports = true
# typer.completion expose get_completion_script à l'exécution mais ne le
# ré-exporte pas explicitement ; sous --strict (no_implicit_reexport),
# mypy le refuse. Quirk d'empaquetage de typer, pas un défaut de notre
# code : on tolère le réexport implicite pour ce seul module.
[[tool.mypy.overrides]]
module = ["typer.completion"]
implicit_reexport = true
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-ra"