/django/core/management/commands/runserver.py
Python | 189 lines | 185 code | 4 blank | 0 comment | 3 complexity | 982970fa02324bb752e647c474abc731 MD5 | raw file
- from __future__ import unicode_literals
- import errno
- import os
- import re
- import socket
- import sys
- from datetime import datetime
- from django.conf import settings
- from django.core.exceptions import ImproperlyConfigured
- from django.core.management.base import BaseCommand, CommandError
- from django.core.servers.basehttp import get_internal_wsgi_application, run
- from django.db import DEFAULT_DB_ALIAS, connections
- from django.db.migrations.exceptions import MigrationSchemaMissing
- from django.db.migrations.executor import MigrationExecutor
- from django.utils import autoreload, six
- from django.utils.encoding import force_text, get_system_encoding
- naiveip_re = re.compile(r"""^(?:
- (?P<addr>
- (?P<ipv4>\d{1,3}(?:\.\d{1,3}){3}) | # IPv4 address
- (?P<ipv6>\[[a-fA-F0-9:]+\]) | # IPv6 address
- (?P<fqdn>[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*) # FQDN
- ):)?(?P<port>\d+)$""", re.X)
- class Command(BaseCommand):
- help = "Starts a lightweight Web server for development."
- # Validation is called explicitly each time the server is reloaded.
- requires_system_checks = False
- leave_locale_alone = True
- default_port = '8000'
- def add_arguments(self, parser):
- parser.add_argument('addrport', nargs='?',
- help='Optional port number, or ipaddr:port')
- parser.add_argument('--ipv6', '-6', action='store_true', dest='use_ipv6', default=False,
- help='Tells Django to use an IPv6 address.')
- parser.add_argument('--nothreading', action='store_false', dest='use_threading', default=True,
- help='Tells Django to NOT use threading.')
- parser.add_argument('--noreload', action='store_false', dest='use_reloader', default=True,
- help='Tells Django to NOT use the auto-reloader.')
- def execute(self, *args, **options):
- if options.get('no_color'):
- # We rely on the environment because it's currently the only
- # way to reach WSGIRequestHandler. This seems an acceptable
- # compromise considering `runserver` runs indefinitely.
- os.environ[str("DJANGO_COLORS")] = str("nocolor")
- super(Command, self).execute(*args, **options)
- def get_handler(self, *args, **options):
- """
- Returns the default WSGI handler for the runner.
- """
- return get_internal_wsgi_application()
- def handle(self, *args, **options):
- from django.conf import settings
- if not settings.DEBUG and not settings.ALLOWED_HOSTS:
- raise CommandError('You must set settings.ALLOWED_HOSTS if DEBUG is False.')
- self.use_ipv6 = options.get('use_ipv6')
- if self.use_ipv6 and not socket.has_ipv6:
- raise CommandError('Your Python does not support IPv6.')
- self._raw_ipv6 = False
- if not options.get('addrport'):
- self.addr = ''
- self.port = self.default_port
- else:
- m = re.match(naiveip_re, options['addrport'])
- if m is None:
- raise CommandError('"%s" is not a valid port number '
- 'or address:port pair.' % options['addrport'])
- self.addr, _ipv4, _ipv6, _fqdn, self.port = m.groups()
- if not self.port.isdigit():
- raise CommandError("%r is not a valid port number." % self.port)
- if self.addr:
- if _ipv6:
- self.addr = self.addr[1:-1]
- self.use_ipv6 = True
- self._raw_ipv6 = True
- elif self.use_ipv6 and not _fqdn:
- raise CommandError('"%s" is not a valid IPv6 address.' % self.addr)
- if not self.addr:
- self.addr = '::1' if self.use_ipv6 else '127.0.0.1'
- self._raw_ipv6 = bool(self.use_ipv6)
- self.run(**options)
- def run(self, **options):
- """
- Runs the server, using the autoreloader if needed
- """
- use_reloader = options.get('use_reloader')
- if use_reloader:
- autoreload.main(self.inner_run, None, options)
- else:
- self.inner_run(None, **options)
- def inner_run(self, *args, **options):
- # If an exception was silenced in ManagementUtility.execute in order
- # to be raised in the child process, raise it now.
- autoreload.raise_last_exception()
- threading = options.get('use_threading')
- shutdown_message = options.get('shutdown_message', '')
- quit_command = 'CTRL-BREAK' if sys.platform == 'win32' else 'CONTROL-C'
- self.stdout.write("Performing system checks...\n\n")
- self.check(display_num_errors=True)
- self.check_migrations()
- now = datetime.now().strftime('%B %d, %Y - %X')
- if six.PY2:
- now = now.decode(get_system_encoding())
- self.stdout.write(now)
- self.stdout.write((
- "Django version %(version)s, using settings %(settings)r\n"
- "Starting development server at http://%(addr)s:%(port)s/\n"
- "Quit the server with %(quit_command)s.\n"
- ) % {
- "version": self.get_version(),
- "settings": settings.SETTINGS_MODULE,
- "addr": '[%s]' % self.addr if self._raw_ipv6 else self.addr,
- "port": self.port,
- "quit_command": quit_command,
- })
- try:
- handler = self.get_handler(*args, **options)
- run(self.addr, int(self.port), handler,
- ipv6=self.use_ipv6, threading=threading)
- except socket.error as e:
- # Use helpful error messages instead of ugly tracebacks.
- ERRORS = {
- errno.EACCES: "You don't have permission to access that port.",
- errno.EADDRINUSE: "That port is already in use.",
- errno.EADDRNOTAVAIL: "That IP address can't be assigned to.",
- }
- try:
- error_text = ERRORS[e.errno]
- except KeyError:
- error_text = force_text(e)
- self.stderr.write("Error: %s" % error_text)
- # Need to use an OS exit because sys.exit doesn't work in a thread
- os._exit(1)
- except KeyboardInterrupt:
- if shutdown_message:
- self.stdout.write(shutdown_message)
- sys.exit(0)
- def check_migrations(self):
- """
- Checks to see if the set of migrations on disk matches the
- migrations in the database. Prints a warning if they don't match.
- """
- try:
- executor = MigrationExecutor(connections[DEFAULT_DB_ALIAS])
- except ImproperlyConfigured:
- # No databases are configured (or the dummy one)
- return
- except MigrationSchemaMissing:
- self.stdout.write(self.style.NOTICE(
- "\nNot checking migrations as it is not possible to access/create the django_migrations table."
- ))
- return
- plan = executor.migration_plan(executor.loader.graph.leaf_nodes())
- if plan:
- apps_waiting_migration = sorted(set(migration.app_label for migration, backwards in plan))
- self.stdout.write(
- self.style.NOTICE(
- "\nYou have %(unpplied_migration_count)s unapplied migration(s). "
- "Your project may not work properly until you apply the "
- "migrations for app(s): %(apps_waiting_migration)s." % {
- "unpplied_migration_count": len(plan),
- "apps_waiting_migration": ", ".join(apps_waiting_migration),
- }
- )
- )
- self.stdout.write(self.style.NOTICE("Run 'python manage.py migrate' to apply them.\n"))
- # Kept for backward compatibility
- BaseRunserverCommand = Command