Skip to content

docs(settings): correct the config-precedence docstring #1542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dimitri-yatsenko wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −4
Open

docs(settings): correct the config-precedence docstring #1542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/datajoint/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@
This module provides strongly-typed configuration with automatic loading
from environment variables, secrets directories, and JSON config files.

Configuration sources (in priority order):
Configuration sources (highest precedence first):

1. Environment variables (``DJ_*``)
2. Secrets directories (``.secrets/`` in project, ``/run/secrets/datajoint/``)
1. Runtime assignment (``dj.config[...] = ...``)
2. Environment variables (``DJ_*``)
3. Project config file (``datajoint.json``, searched recursively up to ``.git/.hg``)
4. Secrets directories (``.secrets/`` in project, ``/run/secrets/datajoint/``)
5. Built-in defaults

A value set by a higher source is not overridden by a lower one. In particular
``datajoint.json`` takes precedence over ``.secrets/``: the secrets directory
only supplies values the config file and environment leave unset.

Examples
--------
Expand All @@ -30,7 +36,7 @@
├── datajoint.json # Project config (commit this)
├── .secrets/ # Local secrets (gitignore this)
│ ├── database.password
│ └── aws.secret_access_key
│ └── stores.main.secret_key # one file per setting: database.* or stores.<name>.<attr>
└── src/
└── analysis.py # Config found via parent search
"""
Expand Down
Loading