FEniCS / ffcx / 39140552981

88%

main: 89%

push

github

Reject unknown keys in form compiler options (#913)

`get_options` merged any unrecognised key into the returned dict without
complaint. An unknown key has no effect on the generated code, but it
does change the JIT cache signature, so the form is recompiled and the
option appears to have been applied. `quadrature_degree` is the case
that bites, since it was a form compiler parameter in legacy FFC but is
now set through integral metadata:

    fem.form(J, form_compiler_options={"quadrature_degree": 4})

was accepted and did nothing, with no way for the caller to tell.

Raise `ValueError` for any key not in `FFCX_DEFAULT_OPTIONS`, naming the
source, so that keys from `$PWD/ffcx_options.json` and
`$XDG_CONFIG_HOME/ffcx/ffcx_options.json` are covered as well.

`ffcx.main` passed its whole parsed argument namespace as priority
options, so `dir`, `outfile`, `profile`, `ufl_file` and friends were
treated as option values and recorded in the generated code header.
Forward only the keys that are actually FFCx options; the generated
header no longer embeds the output directory or input paths.

Option *values* are not validated. `FFCX_DEFAULT_OPTIONS` records a type
and allowed values for each option, but `scalar_type` is legitimately
passed as a dtype-like object rather than one of the listed strings
(DOLFINx passes `np.float64`), so checking values needs a normalisation
step and is left for a follow-up.

Fixes #898.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

10 of 10 new or added lines in 2 files covered. (100.0%)

4798 of 5449 relevant lines covered (88.05%)

0.88 hits per line