Opened 3 years ago
Closed 3 years ago
#34115 closed Cleanup/optimization (wontfix)
Document RUN_MAIN environment variable
| Reported by: | johnthagen | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 4.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
When doing some research into how to control how code should run in the ready function, I came across a reference to the RUN_MAIN environment variable that seems to only be set when the main server is executed (not when the reload server is executed, or other management commands are run).
When I searched for RUN_MAIN in the main Django documentation, I didn't find any hits. I was hoping there would be official documentation on when this environment variable is designed to be used / when it can be relied on.
The
RUN_MAINenvironment variable is a private API, not something that should be used or overwritten by users.