mirror of
https://github.com/django/django.git
synced 2025-07-04 09:49:12 +00:00
newforms-admin: Merged to [6094]
git-svn-id: http://code.djangoproject.com/svn/django/branches/newforms-admin@6095 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
52578a1d1d
commit
f892464d58
@ -2,7 +2,6 @@ import django
|
|||||||
from optparse import OptionParser
|
from optparse import OptionParser
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import textwrap
|
|
||||||
|
|
||||||
# For backwards compatibility: get_version() used to be in this module.
|
# For backwards compatibility: get_version() used to be in this module.
|
||||||
get_version = django.get_version
|
get_version = django.get_version
|
||||||
@ -36,7 +35,9 @@ class ManagementUtility(object):
|
|||||||
A ManagementUtility has a number of commands, which can be manipulated
|
A ManagementUtility has a number of commands, which can be manipulated
|
||||||
by editing the self.commands dictionary.
|
by editing the self.commands dictionary.
|
||||||
"""
|
"""
|
||||||
def __init__(self):
|
def __init__(self, argv=None):
|
||||||
|
self.argv = argv or sys.argv[:]
|
||||||
|
self.prog_name = os.path.basename(self.argv[0])
|
||||||
self.commands = self.default_commands()
|
self.commands = self.default_commands()
|
||||||
|
|
||||||
def default_commands(self):
|
def default_commands(self):
|
||||||
@ -52,22 +53,21 @@ class ManagementUtility(object):
|
|||||||
names = [f[:-3] for f in os.listdir(command_dir) if not f.startswith('_') and f.endswith('.py')]
|
names = [f[:-3] for f in os.listdir(command_dir) if not f.startswith('_') and f.endswith('.py')]
|
||||||
return dict([(name, load_command_class(name)) for name in names])
|
return dict([(name, load_command_class(name)) for name in names])
|
||||||
|
|
||||||
def print_help(self, argv):
|
def main_help_text(self):
|
||||||
"""
|
"""
|
||||||
Returns the help message, as a string.
|
Returns the script's main help text, as a string.
|
||||||
"""
|
"""
|
||||||
prog_name = os.path.basename(argv[0])
|
usage = ['%s <subcommand> [options] [args]' % self.prog_name]
|
||||||
usage = ['%s <subcommand> [options] [args]' % prog_name]
|
|
||||||
usage.append('Django command line tool, version %s' % django.get_version())
|
usage.append('Django command line tool, version %s' % django.get_version())
|
||||||
usage.append("Type '%s help <subcommand>' for help on a specific subcommand." % prog_name)
|
usage.append("Type '%s help <subcommand>' for help on a specific subcommand." % self.prog_name)
|
||||||
usage.append('Available subcommands:')
|
usage.append('Available subcommands:')
|
||||||
commands = self.commands.keys()
|
commands = self.commands.keys()
|
||||||
commands.sort()
|
commands.sort()
|
||||||
for cmd in commands:
|
for cmd in commands:
|
||||||
usage.append(' %s' % cmd)
|
usage.append(' %s' % cmd)
|
||||||
print '\n'.join(usage)
|
return '\n'.join(usage)
|
||||||
|
|
||||||
def fetch_command(self, subcommand, command_name):
|
def fetch_command(self, subcommand):
|
||||||
"""
|
"""
|
||||||
Tries to fetch the given subcommand, printing a message with the
|
Tries to fetch the given subcommand, printing a message with the
|
||||||
appropriate command called from the command line (usually
|
appropriate command called from the command line (usually
|
||||||
@ -76,35 +76,34 @@ class ManagementUtility(object):
|
|||||||
try:
|
try:
|
||||||
return self.commands[subcommand]
|
return self.commands[subcommand]
|
||||||
except KeyError:
|
except KeyError:
|
||||||
sys.stderr.write("Unknown command: %r\nType '%s help' for usage.\n" % (subcommand, command_name))
|
sys.stderr.write("Unknown command: %r\nType '%s help' for usage.\n" % (subcommand, self.prog_name))
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
def execute(self, argv=None):
|
def execute(self):
|
||||||
"""
|
"""
|
||||||
Figures out which command is being run (the first arg), creates a parser
|
Given the command-line arguments, this figures out which subcommand is
|
||||||
appropriate to that command, and runs it.
|
being run, creates a parser appropriate to that command, and runs it.
|
||||||
"""
|
"""
|
||||||
if argv is None:
|
|
||||||
argv = sys.argv
|
|
||||||
try:
|
try:
|
||||||
command_name = argv[1]
|
subcommand = self.argv[1]
|
||||||
except IndexError:
|
except IndexError:
|
||||||
sys.stderr.write("Type '%s help' for usage.\n" % os.path.basename(argv[0]))
|
sys.stderr.write("Type '%s help' for usage.\n" % self.prog_name)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
if command_name == 'help':
|
if subcommand == 'help':
|
||||||
if len(argv) > 2:
|
if len(self.argv) > 2:
|
||||||
self.fetch_command(argv[2], argv[0]).print_help(argv[2:])
|
self.fetch_command(self.argv[2]).print_help(self.prog_name, self.argv[2])
|
||||||
else:
|
else:
|
||||||
self.print_help(argv)
|
sys.stderr.write(self.main_help_text() + '\n')
|
||||||
|
sys.exit(1)
|
||||||
# Special-cases: We want 'django-admin.py --version' and
|
# Special-cases: We want 'django-admin.py --version' and
|
||||||
# 'django-admin.py --help' to work, for backwards compatibility.
|
# 'django-admin.py --help' to work, for backwards compatibility.
|
||||||
elif argv[1:] == ['--version']:
|
elif self.argv[1:] == ['--version']:
|
||||||
print django.get_version()
|
print django.get_version()
|
||||||
elif argv[1:] == ['--help']:
|
elif self.argv[1:] == ['--help']:
|
||||||
self.print_help(argv)
|
sys.stderr.write(self.main_help_text() + '\n')
|
||||||
else:
|
else:
|
||||||
self.fetch_command(command_name, argv[0]).run(argv[1:])
|
self.fetch_command(subcommand).run_from_argv(self.argv)
|
||||||
|
|
||||||
class ProjectManagementUtility(ManagementUtility):
|
class ProjectManagementUtility(ManagementUtility):
|
||||||
"""
|
"""
|
||||||
@ -115,8 +114,8 @@ class ProjectManagementUtility(ManagementUtility):
|
|||||||
In practice, this class represents manage.py, whereas ManagementUtility
|
In practice, this class represents manage.py, whereas ManagementUtility
|
||||||
represents django-admin.py.
|
represents django-admin.py.
|
||||||
"""
|
"""
|
||||||
def __init__(self, project_directory):
|
def __init__(self, argv, project_directory):
|
||||||
super(ProjectManagementUtility, self).__init__()
|
super(ProjectManagementUtility, self).__init__(argv)
|
||||||
|
|
||||||
# Remove the "startproject" command from self.commands, because
|
# Remove the "startproject" command from self.commands, because
|
||||||
# that's a django-admin.py command, not a manage.py command.
|
# that's a django-admin.py command, not a manage.py command.
|
||||||
@ -150,8 +149,8 @@ def execute_from_command_line(argv=None):
|
|||||||
"""
|
"""
|
||||||
A simple method that runs a ManagementUtility.
|
A simple method that runs a ManagementUtility.
|
||||||
"""
|
"""
|
||||||
utility = ManagementUtility()
|
utility = ManagementUtility(argv)
|
||||||
utility.execute(argv)
|
utility.execute()
|
||||||
|
|
||||||
def execute_manager(settings_mod, argv=None):
|
def execute_manager(settings_mod, argv=None):
|
||||||
"""
|
"""
|
||||||
@ -159,5 +158,5 @@ def execute_manager(settings_mod, argv=None):
|
|||||||
project-specific django-admin.py utility.
|
project-specific django-admin.py utility.
|
||||||
"""
|
"""
|
||||||
project_directory = setup_environ(settings_mod)
|
project_directory = setup_environ(settings_mod)
|
||||||
utility = ProjectManagementUtility(project_directory)
|
utility = ProjectManagementUtility(argv, project_directory)
|
||||||
utility.execute(argv)
|
utility.execute()
|
||||||
|
@ -5,7 +5,6 @@ import itertools
|
|||||||
from optparse import make_option, OptionParser
|
from optparse import make_option, OptionParser
|
||||||
import sys
|
import sys
|
||||||
import os
|
import os
|
||||||
from traceback import print_exc
|
|
||||||
|
|
||||||
class CommandError(Exception):
|
class CommandError(Exception):
|
||||||
pass
|
pass
|
||||||
@ -36,35 +35,31 @@ class BaseCommand(object):
|
|||||||
"""
|
"""
|
||||||
return django.get_version()
|
return django.get_version()
|
||||||
|
|
||||||
def usage(self):
|
def usage(self, subcommand):
|
||||||
usage = '%prog [options] ' + self.args
|
usage = '%%prog %s [options] %s' % (subcommand, self.args)
|
||||||
if self.help:
|
if self.help:
|
||||||
return '%s\n\n%s' % (usage, self.help)
|
return '%s\n\n%s' % (usage, self.help)
|
||||||
else:
|
else:
|
||||||
return usage
|
return usage
|
||||||
|
|
||||||
def create_parser(self, prog_name):
|
def create_parser(self, prog_name, subcommand):
|
||||||
return OptionParser(prog=prog_name,
|
return OptionParser(prog=prog_name,
|
||||||
usage=self.usage(),
|
usage=self.usage(subcommand),
|
||||||
version=self.get_version(),
|
version=self.get_version(),
|
||||||
option_list=self.option_list)
|
option_list=self.option_list)
|
||||||
|
|
||||||
def print_help(self, args):
|
def print_help(self, prog_name, subcommand):
|
||||||
parser = self.create_parser(args[0])
|
parser = self.create_parser(prog_name, subcommand)
|
||||||
parser.print_help()
|
parser.print_help()
|
||||||
|
|
||||||
def run(self, args):
|
def run_from_argv(self, argv):
|
||||||
parser = self.create_parser(args[0])
|
parser = self.create_parser(argv[0], argv[1])
|
||||||
(options, args) = parser.parse_args(args[1:])
|
options, args = parser.parse_args(argv[2:])
|
||||||
if options.settings:
|
if options.settings:
|
||||||
os.environ['DJANGO_SETTINGS_MODULE'] = options.settings
|
os.environ['DJANGO_SETTINGS_MODULE'] = options.settings
|
||||||
if options.pythonpath:
|
if options.pythonpath:
|
||||||
sys.path.insert(0, options.pythonpath)
|
sys.path.insert(0, options.pythonpath)
|
||||||
try:
|
self.execute(*args, **options.__dict__)
|
||||||
self.execute(*args, **options.__dict__)
|
|
||||||
except Exception, e:
|
|
||||||
print_exc()
|
|
||||||
parser.print_usage()
|
|
||||||
|
|
||||||
def execute(self, *args, **options):
|
def execute(self, *args, **options):
|
||||||
# Switch to English, because django-admin.py creates database content
|
# Switch to English, because django-admin.py creates database content
|
||||||
|
@ -15,6 +15,6 @@ class Command(BaseCommand):
|
|||||||
from django.core.servers.fastcgi import runfastcgi
|
from django.core.servers.fastcgi import runfastcgi
|
||||||
runfastcgi(args)
|
runfastcgi(args)
|
||||||
|
|
||||||
def usage(self):
|
def usage(self, subcommand):
|
||||||
from django.core.servers.fastcgi import FASTCGI_HELP
|
from django.core.servers.fastcgi import FASTCGI_HELP
|
||||||
return FASTCGI_HELP
|
return FASTCGI_HELP
|
||||||
|
@ -52,11 +52,7 @@ class AppCache(object):
|
|||||||
for app_name in settings.INSTALLED_APPS:
|
for app_name in settings.INSTALLED_APPS:
|
||||||
if app_name in self.handled:
|
if app_name in self.handled:
|
||||||
continue
|
continue
|
||||||
try:
|
self.load_app(app_name, True)
|
||||||
self.load_app(app_name, True)
|
|
||||||
except Exception, e:
|
|
||||||
# Problem importing the app
|
|
||||||
self.app_errors[app_name] = e
|
|
||||||
if not self.nesting_level:
|
if not self.nesting_level:
|
||||||
for app_name in self.postponed:
|
for app_name in self.postponed:
|
||||||
self.load_app(app_name)
|
self.load_app(app_name)
|
||||||
|
@ -417,6 +417,44 @@ Documentation style
|
|||||||
We place a high importance on consistency and readability of documentation.
|
We place a high importance on consistency and readability of documentation.
|
||||||
(After all, Django was created in a journalism environment!)
|
(After all, Django was created in a journalism environment!)
|
||||||
|
|
||||||
|
How to document new features
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
We treat our documentation like we treat our code: we aim to improve it as
|
||||||
|
often as possible. This section explains how writers can craft their
|
||||||
|
documentation changes in the most useful and least error-prone ways.
|
||||||
|
|
||||||
|
Documentation changes come in two forms:
|
||||||
|
|
||||||
|
* General improvements -- Typo corrections, error fixes and better
|
||||||
|
explanations through clearer writing and more examples.
|
||||||
|
|
||||||
|
* New features -- Documentation of features that have been added to the
|
||||||
|
framework since the last release.
|
||||||
|
|
||||||
|
Our philosophy is that "general improvements" are something that *all* current
|
||||||
|
Django users should benefit from, including users of trunk *and* users of the
|
||||||
|
latest release. Hence, the documentation section on djangoproject.com points
|
||||||
|
people by default to the newest versions of the docs, because they have the
|
||||||
|
latest and greatest content. (In fact, the Web site pulls directly from the
|
||||||
|
Subversion repository, converting to HTML on the fly.)
|
||||||
|
|
||||||
|
But this decision to feature bleeding-edge documentation has one large caveat:
|
||||||
|
any documentation of *new* features will be seen by Django users who don't
|
||||||
|
necessarily have access to those features yet, because they're only using the
|
||||||
|
latest release. Thus, our policy is:
|
||||||
|
|
||||||
|
**All documentation of new features should be written in a way that clearly
|
||||||
|
designates the features are only available in the Django development
|
||||||
|
version. Assume documentation readers are using the latest release, not the
|
||||||
|
development version.**
|
||||||
|
|
||||||
|
Our traditional way of marking new features is by prefacing the features'
|
||||||
|
documentation with: "New in Django development version." Changes aren't
|
||||||
|
*required* to include this exact text, but all documentation of new features
|
||||||
|
should include the phrase "development version," so we can find and remove
|
||||||
|
those phrases for the next release.
|
||||||
|
|
||||||
Guidelines for ReST files
|
Guidelines for ReST files
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
|
@ -64,20 +64,6 @@ u'<ul class="errorlist"><li>\u041e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u04
|
|||||||
# Miscellaneous Tests #
|
# Miscellaneous Tests #
|
||||||
#######################
|
#######################
|
||||||
|
|
||||||
There once was a problem with Form fields called "data". Let's make sure that
|
|
||||||
doesn't come back.
|
|
||||||
>>> class DataForm(Form):
|
|
||||||
... data = CharField(max_length=10)
|
|
||||||
>>> f = DataForm({'data': 'xyzzy'})
|
|
||||||
>>> f.is_valid()
|
|
||||||
True
|
|
||||||
>>> f.cleaned_data
|
|
||||||
{'data': u'xyzzy'}
|
|
||||||
|
|
||||||
#######################
|
|
||||||
# Miscellaneous Tests #
|
|
||||||
#######################
|
|
||||||
|
|
||||||
There once was a problem with Form fields called "data". Let's make sure that
|
There once was a problem with Form fields called "data". Let's make sure that
|
||||||
doesn't come back.
|
doesn't come back.
|
||||||
>>> class DataForm(Form):
|
>>> class DataForm(Form):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user