Skip to content

Possibility to get removed config items #18066

@CyrilleB79

Description

@CyrilleB79

Steps to reproduce:

  • Open Python console
  • Type: config.conf["documentFormatting"]["reportFontAttributes"]
  • Press Enter
  • Then also try to set it to True

Actual behavior:

If you have this value in your config file it is returned. If not, the config spec's default is returned.
You can also set it without any warning.

Note that the value is still in the config spec.

Expected behavior:

There is no sense and is even confusing to keep this unused value in the config spec after 2025.1.
With a blank new config, fetching this value should raise an error as it is the case when fetching any value not used by NVDA and not in the config (.ini).
Since this value may remain in the .ini files of people and since reusing it could lead to unexpected results, I'd also recommend that this value be forbidden, i.e. fetching it should raise an error; this behaviour would be more restrictive than fetching any value unknown to the config spec, which can still be fetched if it is in the .ini (e.g. add-ons storing data without using a config spec).

Moreover, in 2024.4.2, although deprecated, setting this value was tolerated if you allowed deprecated code. If not, you hade an error. In 2025.1, it seems strange to have something more permissive, i.e. allow to set this value again without any warning nor error.

Notes

  1. Alternatively, if you feel we are too late in the beta dev cycle, you may choose to extend the deprecation period, e.g. target the removal for 2026.1 or even do not yet target any removal at all.
  2. It's worth noting that there was no deprecation warning/error when fetching this key, only when setting it.
  3. There are probably 2 config values impacted: ["documentFormatting"]["reportFontAttributes"] and ["speech"]["includeCLDR"]

NVDA logs, crash dumps and other attachments:

N/A

System configuration

NVDA installed/portable/running from source:

Installed

NVDA version:

2025.1beta4

Windows version:

Windows 10 22H2 (AMD64) build 19045.5737

Name and version of other software in use when reproducing the issue:

N/A

Other information about your system:

N/A

Other questions

Does the issue still occur after restarting your computer?

Yes

Have you tried any other versions of NVDA? If so, please report their behaviors.

N/A

If NVDA add-ons are disabled, is your problem still occurring?

Not tested, but should be yes

Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu?

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    api-breaking-changefeature/configurationMaking NVDA more configurable.p4https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.

    Type

    No fields configured for Bug.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions