summaryrefslogtreecommitdiff
path: root/django/views
diff options
context:
space:
mode:
authorAdrian Holovaty <adrian@holovaty.com>2005-10-18 04:40:47 +0000
committerAdrian Holovaty <adrian@holovaty.com>2005-10-18 04:40:47 +0000
commitaed1930133ad4e7970c8a7909283a59fb2e3fef2 (patch)
tree251c5ae8a3258fcfd07ded73d2791ab674b7fb30 /django/views
parent1dc6d4b26506fe3d8c5e72aa958b8e82ea9975be (diff)
Moved django.views.admin.template and django.views.admin.doc to django.contrib.admin.views. Refs #627
git-svn-id: http://code.djangoproject.com/svn/django/trunk@923 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'django/views')
-rw-r--r--django/views/admin/doc.py315
-rw-r--r--django/views/admin/template.py68
2 files changed, 0 insertions, 383 deletions
diff --git a/django/views/admin/doc.py b/django/views/admin/doc.py
deleted file mode 100644
index e7e791b2e4..0000000000
--- a/django/views/admin/doc.py
+++ /dev/null
@@ -1,315 +0,0 @@
-from django.core import meta
-from django import templatetags
-from django.conf import settings
-from django.models.core import sites
-from django.core.extensions import DjangoContext, render_to_response
-from django.core.exceptions import Http404, ViewDoesNotExist
-from django.core import template, urlresolvers
-from django.core.template import defaulttags, defaultfilters, loader
-try:
- from django.parts.admin import doc
-except ImportError:
- doc = None
-import inspect, os, re
-
-# Exclude methods starting with these strings from documentation
-MODEL_METHODS_EXCLUDE = ('_', 'add_', 'delete', 'save', 'set_')
-
-def doc_index(request):
- if not doc:
- return missing_docutils_page(request)
- return render_to_response('doc/index', context_instance=DjangoContext(request))
-
-def bookmarklets(request):
- return render_to_response('doc/bookmarklets', {
- 'admin_url' : "%s://%s" % (os.environ.get('HTTPS') == 'on' and 'https' or 'http', request.META['HTTP_HOST']),
- }, context_instance=DjangoContext(request))
-
-def template_tag_index(request):
- import sys
-
- if not doc:
- return missing_docutils_page(request)
-
- # We have to jump through some hoops with registered_tags to make sure
- # they don't get messed up by loading outside tagsets
- saved_tagset = template.registered_tags.copy(), template.registered_filters.copy()
- load_all_installed_template_libraries()
-
- # Gather docs
- tags = []
- for tagname in template.registered_tags:
- title, body, metadata = doc.parse_docstring(template.registered_tags[tagname].__doc__)
- if title:
- title = doc.parse_rst(title, 'tag', 'tag:' + tagname)
- if body:
- body = doc.parse_rst(body, 'tag', 'tag:' + tagname)
- for key in metadata:
- metadata[key] = doc.parse_rst(metadata[key], 'tag', 'tag:' + tagname)
- library = template.registered_tags[tagname].__module__.split('.')[-1]
- if library == 'template_loader' or library == 'defaulttags':
- library = None
- tags.append({
- 'name' : tagname,
- 'title' : title,
- 'body' : body,
- 'meta' : metadata,
- 'library' : library,
- })
-
- # Fix registered_tags
- template.registered_tags, template.registered_filters = saved_tagset
-
- return render_to_response('doc/template_tag_index', {'tags': tags}, context_instance=DjangoContext(request))
-
-def template_filter_index(request):
- if not doc:
- return missing_docutils_page(request)
-
- saved_tagset = template.registered_tags.copy(), template.registered_filters.copy()
- load_all_installed_template_libraries()
-
- filters = []
- for filtername in template.registered_filters:
- title, body, metadata = doc.parse_docstring(template.registered_filters[filtername][0].__doc__)
- if title:
- title = doc.parse_rst(title, 'filter', 'filter:' + filtername)
- if body:
- body = doc.parse_rst(body, 'filter', 'filter:' + filtername)
- for key in metadata:
- metadata[key] = doc.parse_rst(metadata[key], 'filter', 'filter:' + filtername)
- metadata['AcceptsArgument'] = template.registered_filters[filtername][1]
- library = template.registered_filters[filtername][0].__module__.split('.')[-1]
- if library == 'template_loader' or library == 'defaultfilters':
- library = None
- filters.append({
- 'name' : filtername,
- 'title' : title,
- 'body' : body,
- 'meta' : metadata,
- 'library' : library,
- })
-
- template.registered_tags, template.registered_filters = saved_tagset
-
- return render_to_response('doc/template_filter_index', {'filters': filters}, context_instance=DjangoContext(request))
-
-def view_index(request):
- if not doc:
- return missing_docutils_page(request)
-
- views = []
- for site_settings_module in settings.ADMIN_FOR:
- settings_mod = __import__(site_settings_module, '', '', [''])
- urlconf = __import__(settings_mod.ROOT_URLCONF, '', '', [''])
- view_functions = extract_views_from_urlpatterns(urlconf.urlpatterns)
- for (func, regex) in view_functions:
- views.append({
- 'name' : func.__name__,
- 'module' : func.__module__,
- 'site_id': settings_mod.SITE_ID,
- 'site' : sites.get_object(pk=settings_mod.SITE_ID),
- 'url' : simplify_regex(regex),
- })
- return render_to_response('doc/view_index', {'views': views}, context_instance=DjangoContext(request))
-
-def view_detail(request, view):
- if not doc:
- return missing_docutils_page(request)
-
- mod, func = urlresolvers.get_mod_func(view)
- try:
- view_func = getattr(__import__(mod, '', '', ['']), func)
- except (ImportError, AttributeError):
- raise Http404
- title, body, metadata = doc.parse_docstring(view_func.__doc__)
- if title:
- title = doc.parse_rst(title, 'view', 'view:' + view)
- if body:
- body = doc.parse_rst(body, 'view', 'view:' + view)
- for key in metadata:
- metadata[key] = doc.parse_rst(metadata[key], 'model', 'view:' + view)
- return render_to_response('doc/view_detail', {
- 'name': view,
- 'summary': title,
- 'body': body,
- 'meta': metadata,
- }, context_instance=DjangoContext(request))
-
-def model_index(request):
- if not doc:
- return missing_docutils_page(request)
-
- models = []
- for app in meta.get_installed_model_modules():
- for model in app._MODELS:
- opts = model._meta
- models.append({
- 'name' : '%s.%s' % (opts.app_label, opts.module_name),
- 'module' : opts.app_label,
- 'class' : opts.module_name,
- })
- return render_to_response('doc/model_index', {'models': models}, context_instance=DjangoContext(request))
-
-def model_detail(request, model):
- if not doc:
- return missing_docutils_page(request)
-
- try:
- model = meta.get_app(model)
- except ImportError:
- raise Http404
- opts = model.Klass._meta
-
- # Gather fields/field descriptions
- fields = []
- for field in opts.fields:
- fields.append({
- 'name' : field.name,
- 'data_type': get_readable_field_data_type(field),
- 'verbose' : field.verbose_name,
- 'help' : field.help_text,
- })
- for func_name, func in model.Klass.__dict__.items():
- if callable(func) and len(inspect.getargspec(func)[0]) == 0:
- try:
- for exclude in MODEL_METHODS_EXCLUDE:
- if func_name.startswith(exclude):
- raise StopIteration
- except StopIteration:
- continue
- verbose = func.__doc__
- if verbose:
- verbose = doc.parse_rst(doc.trim_docstring(verbose), 'model', 'model:' + opts.module_name)
- fields.append({
- 'name' : func_name,
- 'data_type' : get_return_data_type(func_name),
- 'verbose' : verbose,
- })
- return render_to_response('doc/model_detail', {
- 'name': '%s.%s' % (opts.app_label, opts.module_name),
- 'summary': "Fields on %s objects" % opts.verbose_name,
- 'fields': fields,
- }, context_instance=DjangoContext(request))
-
-def template_detail(request, template):
- templates = []
- for site_settings_module in settings.ADMIN_FOR:
- settings_mod = __import__(site_settings_module, '', '', [''])
- for dir in settings_mod.TEMPLATE_DIRS:
- template_file = os.path.join(dir, "%s.html" % template)
- templates.append({
- 'file' : template_file,
- 'exists' : os.path.exists(template_file),
- 'contents' : lambda: os.path.exists(template_file) and open(template_file).read() or '',
- 'site_id' : settings_mod.SITE_ID,
- 'site' : sites.get_object(pk=settings_mod.SITE_ID),
- 'order' : list(settings_mod.TEMPLATE_DIRS).index(dir),
- })
- return render_to_response('doc/template_detail', {
- 'name': template,
- 'templates': templates,
- }, context_instance=DjangoContext(request))
-
-####################
-# Helper functions #
-####################
-
-def missing_docutils_page(request):
- """Display an error message for people without docutils"""
- return render_to_response('doc/missing_docutils')
-
-def load_all_installed_template_libraries():
- # Clear out and reload default tags
- template.registered_tags.clear()
- reload(defaulttags)
- reload(loader) # loader defines the block/extends tags
-
- # Load any template tag libraries from installed apps
- for e in templatetags.__path__:
- libraries = [os.path.splitext(p)[0] for p in os.listdir(e) if p.endswith('.py') and p[0].isalpha()]
- for lib in libraries:
- try:
- mod = defaulttags.LoadNode.load_taglib(lib)
- reload(mod)
- except ImportError:
- pass
-
-def get_return_data_type(func_name):
- """Return a somewhat-helpful data type given a function name"""
- if func_name.startswith('get_'):
- if func_name.endswith('_list'):
- return 'List'
- elif func_name.endswith('_count'):
- return 'Integer'
- return ''
-
-# Maps Field objects to their human-readable data types, as strings.
-# Column-type strings can contain format strings; they'll be interpolated
-# against the values of Field.__dict__ before being output.
-# If a column type is set to None, it won't be included in the output.
-DATA_TYPE_MAPPING = {
- 'AutoField' : 'Integer',
- 'BooleanField' : 'Boolean (Either True or False)',
- 'CharField' : 'String (up to %(maxlength)s)',
- 'CommaSeparatedIntegerField': 'Comma-separated integers',
- 'DateField' : 'Date (without time)',
- 'DateTimeField' : 'Date (with time)',
- 'EmailField' : 'E-mail address',
- 'FileField' : 'File path',
- 'FloatField' : 'Decimal number',
- 'ForeignKey' : 'Integer',
- 'ImageField' : 'File path',
- 'IntegerField' : 'Integer',
- 'IPAddressField' : 'IP address',
- 'ManyToManyField' : '',
- 'NullBooleanField' : 'Boolean (Either True, False or None)',
- 'PhoneNumberField' : 'Phone number',
- 'PositiveIntegerField' : 'Integer',
- 'PositiveSmallIntegerField' : 'Integer',
- 'SlugField' : 'String (up to 50)',
- 'SmallIntegerField' : 'Integer',
- 'TextField' : 'Text',
- 'TimeField' : 'Time',
- 'URLField' : 'URL',
- 'USStateField' : 'U.S. state (two uppercase letters)',
- 'XMLField' : 'XML text',
-}
-
-def get_readable_field_data_type(field):
- # ForeignKey is a special case. Use the field type of the relation.
- if field.__class__.__name__ == 'ForeignKey':
- field = field.rel.get_related_field()
- return DATA_TYPE_MAPPING[field.__class__.__name__] % field.__dict__
-
-def extract_views_from_urlpatterns(urlpatterns, base=''):
- """
- Return a list of views from a list of urlpatterns.
-
- Each object in the returned list is a two-tuple: (view_func, regex)
- """
- views = []
- for p in urlpatterns:
- if hasattr(p, 'get_callback'):
- try:
- views.append((p.get_callback(), base + p.regex.pattern))
- except ViewDoesNotExist:
- continue
- elif hasattr(p, '_get_url_patterns'):
- views.extend(extract_views_from_urlpatterns(p.url_patterns, base + p.regex.pattern))
- else:
- raise TypeError, "%s does not appear to be a urlpattern object" % p
- return views
-
-# Clean up urlpattern regexes into something somewhat readable by Mere Humans:
-# turns something like "^(?P<sport_slug>\w+)/athletes/(?P<athlete_slug>\w+)/$"
-# into "<sport_slug>/athletes/<athlete_slug>/"
-
-named_group_matcher = re.compile(r'\(\?P(<\w+>).+?\)')
-
-def simplify_regex(pattern):
- pattern = named_group_matcher.sub(lambda m: m.group(1), pattern)
- pattern = pattern.replace('^', '').replace('$', '').replace('?', '').replace('//', '/')
- if not pattern.startswith('/'):
- pattern = '/' + pattern
- return pattern
diff --git a/django/views/admin/template.py b/django/views/admin/template.py
deleted file mode 100644
index c35770178e..0000000000
--- a/django/views/admin/template.py
+++ /dev/null
@@ -1,68 +0,0 @@
-from django.core import formfields, validators
-from django.core import template
-from django.core.template import loader
-from django.core.extensions import DjangoContext, render_to_response
-from django.models.core import sites
-from django.conf import settings
-
-def template_validator(request):
- """
- Displays the template validator form, which finds and displays template
- syntax errors.
- """
- # get a dict of {site_id : settings_module} for the validator
- settings_modules = {}
- for mod in settings.ADMIN_FOR:
- settings_module = __import__(mod, '', '', [''])
- settings_modules[settings_module.SITE_ID] = settings_module
- manipulator = TemplateValidator(settings_modules)
- new_data, errors = {}, {}
- if request.POST:
- new_data = request.POST.copy()
- errors = manipulator.get_validation_errors(new_data)
- if not errors:
- request.user.add_message('The template is valid.')
- return render_to_response('template_validator', {
- 'title': 'Template validator',
- 'form': formfields.FormWrapper(manipulator, new_data, errors),
- }, context_instance=DjangoContext(request))
-
-class TemplateValidator(formfields.Manipulator):
- def __init__(self, settings_modules):
- self.settings_modules = settings_modules
- site_list = sites.get_in_bulk(settings_modules.keys()).values()
- self.fields = (
- formfields.SelectField('site', is_required=True, choices=[(s.id, s.name) for s in site_list]),
- formfields.LargeTextField('template', is_required=True, rows=25, validator_list=[self.isValidTemplate]),
- )
-
- def isValidTemplate(self, field_data, all_data):
- # get the settings module
- # if the site isn't set, we don't raise an error since the site field will
- try:
- site_id = int(all_data.get('site', None))
- except (ValueError, TypeError):
- return
- settings_module = self.settings_modules.get(site_id, None)
- if settings_module is None:
- return
-
- # so that inheritance works in the site's context, register a new function
- # for "extends" that uses the site's TEMPLATE_DIR instead
- def new_do_extends(parser, token):
- node = loader.do_extends(parser, token)
- node.template_dirs = settings_module.TEMPLATE_DIRS
- return node
- template.register_tag('extends', new_do_extends)
-
- # now validate the template using the new template dirs
- # making sure to reset the extends function in any case
- error = None
- try:
- tmpl = loader.get_template_from_string(field_data)
- tmpl.render(template.Context({}))
- except template.TemplateSyntaxError, e:
- error = e
- template.register_tag('extends', loader.do_extends)
- if error:
- raise validators.ValidationError, e.args