Deprecate settings.yml, and document usage #1692
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1524.
The outcome of our discussion in the ticket was this:
tinypilot.db
) should be the default place for new settings, whereas the YAML file (settings.yml
) should only be used in exceptional cases, and obviously for legacy reasons.settings.yml
separately.This PR adds a comment in
settings.py
, marking its usage as quasi-deprecated. It also adds some historical context, references the SQlite DB as default storage, and lists sample exceptional cases.I realized that we probably don’t need to add any documentation to the SQlite DB, since there is not really an alternative to it any longer. So by deprecating
settings.yml
, the SQlite DB is the only storage option anyway, and there shouldn’t be any ambiguity left. Contrary to my initial proposal, I also don’t think we should movesettings.py
up to theapp
package, as that might mistakenly promote its usage.