28

I want to make the Django development server do something before it starts running. To do this, I created a new app, added it to the top of INSTALLED_APPS, and then created a management/commands/runserver.py file in the app with the following code:

from django.contrib.staticfiles.management.commands.runserver import Command as RunserverCommand
class Command(RunserverCommand):
    def run(self, *args, **options):
        self.stdout.write('About to start running on ' + self.addr)
        super(Command, self).run(*args, **options)

(The thing I actually want to do is more complicated than writing one line to stdout, of course, but this is the simplest example that demonstrates the problem. The reason I override run, rather than handle or some other method, is because I need self.addr to already be set when this code runs.)

When I run ./manage.py runserver, the line "About to start running on 127.0.0.1" appears not once, but twice before the server starts running. Why is this happening and what can be done about it?

Taymon
  • 24,950
  • 9
  • 62
  • 84
  • You most likely do not want to edit the run command, have a look at Django startup hook functionality mentioned in this answer. https://stackoverflow.com/a/16111968/742390 The auto-reloading feature of django runserver, will run things twice but it is harmless and only used in dev. You shouldnt be using runserver in production, in production the startup code will only run once. – Pykler Feb 22 '18 at 21:05
  • This was for local development only, actually. – Taymon Feb 28 '18 at 01:55
  • In that case you shouldn't worry much that it runs twice, since it is really just dev. You want to write your code in such a way that it works in production as well, editing the run command won't work when you finally deploy it under uwsgi or gunicorn. – Pykler Feb 28 '18 at 15:35

2 Answers2

39

The auto-reloader process turned out to be the culprit; turns out the autoreload process gets the same arguments, and goes through the same initialization process, as the original. The solution was to have the pre-server code execute only if it's not running in the process spawned by the autoreloader, which can be detected through an environment variable:

import os
from django.contrib.staticfiles.management.commands.runserver import Command as RunserverCommand
class Command(RunserverCommand):
    def run(self, *args, **options):
        if os.environ.get('RUN_MAIN') != 'true':
            self.stdout.write('About to start running on ' + self.addr)
        super(Command, self).run(*args, **options)
Taymon
  • 24,950
  • 9
  • 62
  • 84
27

The local development server runs a separate process for the auto-reloader. You can turn off the auto-reload process by passing the --noreload flag.

python manage.py runserver --noreload
Bhargav Rao
  • 50,140
  • 28
  • 121
  • 140