summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorchillaranand <anand21nanda@gmail.com>2017-01-22 12:27:14 +0530
committerTim Graham <timograham@gmail.com>2017-01-25 11:53:05 -0500
commitdc165ec8e5698ffc6dee6b510f1f92c9fd7467fe (patch)
treeebcd5f708528b2aec195f9a97d28bd85653aa7dc /docs/ref
parent2d96c027f5eb32c2c09bd57df2240ae1d343b98e (diff)
Refs #23919 -- Replaced super(ClassName, self) with super() in docs.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/class-based-views/base.txt4
-rw-r--r--docs/ref/class-based-views/generic-display.txt4
-rw-r--r--docs/ref/class-based-views/generic-editing.txt2
-rw-r--r--docs/ref/class-based-views/mixins-simple.txt2
-rw-r--r--docs/ref/contrib/admin/actions.txt2
-rw-r--r--docs/ref/contrib/admin/index.txt26
-rw-r--r--docs/ref/contrib/sitemaps.txt2
-rw-r--r--docs/ref/contrib/staticfiles.txt2
-rw-r--r--docs/ref/contrib/syndication.txt6
-rw-r--r--docs/ref/forms/fields.txt4
-rw-r--r--docs/ref/forms/validation.txt18
-rw-r--r--docs/ref/forms/widgets.txt2
-rw-r--r--docs/ref/models/expressions.txt6
-rw-r--r--docs/ref/models/instances.txt4
14 files changed, 42 insertions, 42 deletions
diff --git a/docs/ref/class-based-views/base.txt b/docs/ref/class-based-views/base.txt
index c6959ca9ef..2d0f472839 100644
--- a/docs/ref/class-based-views/base.txt
+++ b/docs/ref/class-based-views/base.txt
@@ -131,7 +131,7 @@ MRO is an acronym for Method Resolution Order.
template_name = "home.html"
def get_context_data(self, **kwargs):
- context = super(HomePageView, self).get_context_data(**kwargs)
+ context = super().get_context_data(**kwargs)
context['latest_articles'] = Article.objects.all()[:5]
return context
@@ -194,7 +194,7 @@ MRO is an acronym for Method Resolution Order.
def get_redirect_url(self, *args, **kwargs):
article = get_object_or_404(Article, pk=kwargs['pk'])
article.update_counter()
- return super(ArticleCounterRedirectView, self).get_redirect_url(*args, **kwargs)
+ return super().get_redirect_url(*args, **kwargs)
**Example urls.py**::
diff --git a/docs/ref/class-based-views/generic-display.txt b/docs/ref/class-based-views/generic-display.txt
index b97d3674cd..70da1803d6 100644
--- a/docs/ref/class-based-views/generic-display.txt
+++ b/docs/ref/class-based-views/generic-display.txt
@@ -48,7 +48,7 @@ many projects they are typically the most commonly used views.
model = Article
def get_context_data(self, **kwargs):
- context = super(ArticleDetailView, self).get_context_data(**kwargs)
+ context = super().get_context_data(**kwargs)
context['now'] = timezone.now()
return context
@@ -117,7 +117,7 @@ many projects they are typically the most commonly used views.
model = Article
def get_context_data(self, **kwargs):
- context = super(ArticleListView, self).get_context_data(**kwargs)
+ context = super().get_context_data(**kwargs)
context['now'] = timezone.now()
return context
diff --git a/docs/ref/class-based-views/generic-editing.txt b/docs/ref/class-based-views/generic-editing.txt
index 43dd349bff..65cd772536 100644
--- a/docs/ref/class-based-views/generic-editing.txt
+++ b/docs/ref/class-based-views/generic-editing.txt
@@ -68,7 +68,7 @@ editing content:
# This method is called when valid form data has been POSTed.
# It should return an HttpResponse.
form.send_email()
- return super(ContactView, self).form_valid(form)
+ return super().form_valid(form)
**Example myapp/contact.html**:
diff --git a/docs/ref/class-based-views/mixins-simple.txt b/docs/ref/class-based-views/mixins-simple.txt
index b039967c46..a2601a1b08 100644
--- a/docs/ref/class-based-views/mixins-simple.txt
+++ b/docs/ref/class-based-views/mixins-simple.txt
@@ -15,7 +15,7 @@ Simple mixins
arguments provided will make up the returned context. Example usage::
def get_context_data(self, **kwargs):
- context = super(RandomNumberView, self).get_context_data(**kwargs)
+ context = super().get_context_data(**kwargs)
context['number'] = random.randrange(1, 100)
return context
diff --git a/docs/ref/contrib/admin/actions.txt b/docs/ref/contrib/admin/actions.txt
index 039d8d37d6..c6f210b1de 100644
--- a/docs/ref/contrib/admin/actions.txt
+++ b/docs/ref/contrib/admin/actions.txt
@@ -351,7 +351,7 @@ Conditionally enabling or disabling actions
...
def get_actions(self, request):
- actions = super(MyModelAdmin, self).get_actions(request)
+ actions = super().get_actions(request)
if request.user.username[0].upper() != 'J':
if 'delete_selected' in actions:
del actions['delete_selected']
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 74faef6a75..d858a5741d 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -910,11 +910,11 @@ subclass::
def lookups(self, request, model_admin):
if request.user.is_superuser:
- return super(AuthDecadeBornListFilter, self).lookups(request, model_admin)
+ return super().lookups(request, model_admin)
def queryset(self, request, queryset):
if request.user.is_superuser:
- return super(AuthDecadeBornListFilter, self).queryset(request, queryset)
+ return super().queryset(request, queryset)
Also as a convenience, the ``ModelAdmin`` object is passed to
the ``lookups`` method, for example if you want to base the
@@ -1342,7 +1342,7 @@ templates used by the :class:`ModelAdmin` views:
class ArticleAdmin(admin.ModelAdmin):
def save_model(self, request, obj, form, change):
obj.user = request.user
- super(ArticleAdmin, self).save_model(request, obj, form, change)
+ super().save_model(request, obj, form, change)
.. method:: ModelAdmin.delete_model(request, obj)
@@ -1409,7 +1409,7 @@ templates used by the :class:`ModelAdmin` views:
search_fields = ('name',)
def get_search_results(self, request, queryset, search_term):
- queryset, use_distinct = super(PersonAdmin, self).get_search_results(request, queryset, search_term)
+ queryset, use_distinct = super().get_search_results(request, queryset, search_term)
try:
search_term_as_int = int(search_term)
except ValueError:
@@ -1526,7 +1526,7 @@ templates used by the :class:`ModelAdmin` views:
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
- urls = super(MyModelAdmin, self).get_urls()
+ urls = super().get_urls()
my_urls = [
url(r'^my_view/$', self.my_view),
]
@@ -1578,7 +1578,7 @@ templates used by the :class:`ModelAdmin` views:
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
- urls = super(MyModelAdmin, self).get_urls()
+ urls = super().get_urls()
my_urls = [
url(r'^my_view/$', self.admin_site.admin_view(self.my_view))
]
@@ -1615,7 +1615,7 @@ templates used by the :class:`ModelAdmin` views:
def get_form(self, request, obj=None, **kwargs):
if request.user.is_superuser:
kwargs['form'] = MySuperuserForm
- return super(MyModelAdmin, self).get_form(request, obj, **kwargs)
+ return super().get_form(request, obj, **kwargs)
You may also simply return a custom :class:`~django.forms.ModelForm` class
directly.
@@ -1648,7 +1648,7 @@ templates used by the :class:`ModelAdmin` views:
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "car":
kwargs["queryset"] = Car.objects.filter(owner=request.user)
- return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)
+ return super().formfield_for_foreignkey(db_field, request, **kwargs)
This uses the ``HttpRequest`` instance to filter the ``Car`` foreign key
field to only display the cars owned by the ``User`` instance.
@@ -1666,7 +1666,7 @@ templates used by the :class:`ModelAdmin` views:
def formfield_for_manytomany(self, db_field, request, **kwargs):
if db_field.name == "cars":
kwargs["queryset"] = Car.objects.filter(owner=request.user)
- return super(MyModelAdmin, self).formfield_for_manytomany(db_field, request, **kwargs)
+ return super().formfield_for_manytomany(db_field, request, **kwargs)
.. method:: ModelAdmin.formfield_for_choice_field(db_field, request, **kwargs)
@@ -1685,7 +1685,7 @@ templates used by the :class:`ModelAdmin` views:
)
if request.user.is_superuser:
kwargs['choices'] += (('ready', 'Ready for deployment'),)
- return super(MyModelAdmin, self).formfield_for_choice_field(db_field, request, **kwargs)
+ return super().formfield_for_choice_field(db_field, request, **kwargs)
.. admonition:: Note
@@ -1740,7 +1740,7 @@ templates used by the :class:`ModelAdmin` views:
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_formset(self, request, **kwargs):
kwargs['formset'] = MyAdminFormSet
- return super(MyModelAdmin, self).get_changelist_formset(request, **kwargs)
+ return super().get_changelist_formset(request, **kwargs)
.. method:: ModelAdmin.has_add_permission(request)
@@ -1783,7 +1783,7 @@ templates used by the :class:`ModelAdmin` views:
class MyModelAdmin(admin.ModelAdmin):
def get_queryset(self, request):
- qs = super(MyModelAdmin, self).get_queryset(request)
+ qs = super().get_queryset(request)
if request.user.is_superuser:
return qs
return qs.filter(author=request.user)
@@ -1902,7 +1902,7 @@ provided some extra mapping data that would not otherwise be available::
def change_view(self, request, object_id, form_url='', extra_context=None):
extra_context = extra_context or {}
extra_context['osm_data'] = self.get_osm_info()
- return super(MyModelAdmin, self).change_view(
+ return super().change_view(
request, object_id, form_url, extra_context=extra_context,
)
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt
index d3ce1cdb7f..b89a9a13b0 100644
--- a/docs/ref/contrib/sitemaps.txt
+++ b/docs/ref/contrib/sitemaps.txt
@@ -509,7 +509,7 @@ method::
class Entry(models.Model):
# ...
def save(self, force_insert=False, force_update=False):
- super(Entry, self).save(force_insert, force_update)
+ super().save(force_insert, force_update)
try:
ping_google()
except Exception:
diff --git a/docs/ref/contrib/staticfiles.txt b/docs/ref/contrib/staticfiles.txt
index 46f1ce54b1..2c2db21090 100644
--- a/docs/ref/contrib/staticfiles.txt
+++ b/docs/ref/contrib/staticfiles.txt
@@ -79,7 +79,7 @@ respectively. For example::
def __init__(self, *args, **kwargs):
kwargs['file_permissions_mode'] = 0o640
kwargs['directory_permissions_mode'] = 0o760
- super(MyStaticFilesStorage, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
Then set the :setting:`STATICFILES_STORAGE` setting to
``'path.to.MyStaticFilesStorage'``.
diff --git a/docs/ref/contrib/syndication.txt b/docs/ref/contrib/syndication.txt
index 3552f70f29..8c32cef191 100644
--- a/docs/ref/contrib/syndication.txt
+++ b/docs/ref/contrib/syndication.txt
@@ -155,7 +155,7 @@ into those elements.
return Article.objects.order_by('-pub_date')[:5]
def get_context_data(self, **kwargs):
- context = super(ArticlesFeed, self).get_context_data(**kwargs)
+ context = super().get_context_data(**kwargs)
context['foo'] = 'bar'
return context
@@ -1057,12 +1057,12 @@ For example, you might start implementing an iTunes RSS feed generator like so::
class iTunesFeed(Rss201rev2Feed):
def root_attributes(self):
- attrs = super(iTunesFeed, self).root_attributes()
+ attrs = super().root_attributes()
attrs['xmlns:itunes'] = 'http://www.itunes.com/dtds/podcast-1.0.dtd'
return attrs
def add_root_elements(self, handler):
- super(iTunesFeed, self).add_root_elements(handler)
+ super().add_root_elements(handler)
handler.addQuickElement('itunes:explicit', 'clean')
Obviously there's a lot more work to be done for a complete custom feed class,
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt
index b135532b2d..2949ad0a9b 100644
--- a/docs/ref/forms/fields.txt
+++ b/docs/ref/forms/fields.txt
@@ -1029,7 +1029,7 @@ Slightly complex built-in ``Field`` classes
required=False,
),
)
- super(PhoneField, self).__init__(
+ super().__init__(
error_messages=error_messages, fields=fields,
require_all_fields=False, *args, **kwargs
)
@@ -1100,7 +1100,7 @@ method::
foo_select = forms.ModelMultipleChoiceField(queryset=None)
def __init__(self, *args, **kwargs):
- super(FooMultipleChoiceForm, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
self.fields['foo_select'].queryset = ...
``ModelChoiceField``
diff --git a/docs/ref/forms/validation.txt b/docs/ref/forms/validation.txt
index b57f44cb6c..6d3edf93e3 100644
--- a/docs/ref/forms/validation.txt
+++ b/docs/ref/forms/validation.txt
@@ -272,7 +272,7 @@ containing comma-separated email addresses. The full class looks like this::
def validate(self, value):
"""Check if value consists only of valid emails."""
# Use the parent's handling of required fields, etc.
- super(MultiEmailField, self).validate(value)
+ super().validate(value)
for email in value:
validate_email(email)
@@ -352,7 +352,7 @@ example::
...
def clean(self):
- cleaned_data = super(ContactForm, self).clean()
+ cleaned_data = super().clean()
cc_myself = cleaned_data.get("cc_myself")
subject = cleaned_data.get("subject")
@@ -367,14 +367,14 @@ example::
In this code, if the validation error is raised, the form will display an
error message at the top of the form (normally) describing the problem.
-The call to ``super(ContactForm, self).clean()`` in the example code ensures
-that any validation logic in parent classes is maintained. If your form
-inherits another that doesn't return a ``cleaned_data`` dictionary in its
-``clean()`` method (doing so is optional), then don't assign ``cleaned_data``
-to the result of the ``super()`` call and use ``self.cleaned_data`` instead::
+The call to ``super().clean()`` in the example code ensures that any validation
+logic in parent classes is maintained. If your form inherits another that
+doesn't return a ``cleaned_data`` dictionary in its ``clean()`` method (doing
+so is optional), then don't assign ``cleaned_data`` to the result of the
+``super()`` call and use ``self.cleaned_data`` instead::
def clean(self):
- super(ContactForm, self).clean()
+ super().clean()
cc_myself = self.cleaned_data.get("cc_myself")
...
@@ -393,7 +393,7 @@ work out what works effectively in your particular situation. Our new code
...
def clean(self):
- cleaned_data = super(ContactForm, self).clean()
+ cleaned_data = super().clean()
cc_myself = cleaned_data.get("cc_myself")
subject = cleaned_data.get("subject")
diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt
index 210e5ce93c..9f3ea2840c 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -410,7 +410,7 @@ foundation for custom widgets.
widgets.Select(attrs=attrs, choices=months),
widgets.Select(attrs=attrs, choices=years),
)
- super(DateSelectorWidget, self).__init__(_widgets, attrs)
+ super().__init__(_widgets, attrs)
def decompress(self, value):
if value:
diff --git a/docs/ref/models/expressions.txt b/docs/ref/models/expressions.txt
index f53f791ffc..6947b18554 100644
--- a/docs/ref/models/expressions.txt
+++ b/docs/ref/models/expressions.txt
@@ -300,7 +300,7 @@ The ``Func`` API is as follows:
...
def as_mysql(self, compiler, connection):
- return super(ConcatPair, self).as_sql(
+ return super().as_sql(
compiler, connection,
function='CONCAT_WS',
template="%(function)s('', %(expressions)s)",
@@ -388,7 +388,7 @@ SQL that is generated. Here's a brief example::
template = '%(function)s(%(distinct)s%(expressions)s)'
def __init__(self, expression, distinct=False, **extra):
- super(Count, self).__init__(
+ super().__init__(
expression,
distinct='DISTINCT ' if distinct else '',
output_field=IntegerField(),
@@ -776,7 +776,7 @@ an ``__init__()`` method to set some attributes::
template = 'COALESCE( %(expressions)s )'
def __init__(self, expressions, output_field):
- super(Coalesce, self).__init__(output_field=output_field)
+ super().__init__(output_field=output_field)
if len(expressions) < 2:
raise ValueError('expressions must have at least 2 elements')
for expression in expressions:
diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt
index 058fd59512..5510105ccb 100644
--- a/docs/ref/models/instances.txt
+++ b/docs/ref/models/instances.txt
@@ -113,7 +113,7 @@ are loaded from the database::
if not self._state.adding and (
self.creator_id != self._loaded_values['creator_id']):
raise ValueError("Updating the value of creator isn't allowed")
- super(...).save(*args, **kwargs)
+ super().save(*args, **kwargs)
The example above shows a full ``from_db()`` implementation to clarify how that
is done. In this case it would of course be possible to just use ``super()`` call
@@ -184,7 +184,7 @@ all of the instance's fields when a deferred field is reloaded::
if fields.intersection(deferred_fields):
# then load all of them
fields = fields.union(deferred_fields)
- super(ExampleModel, self).refresh_from_db(using, fields, **kwargs)
+ super().refresh_from_db(using, fields, **kwargs)
.. method:: Model.get_deferred_fields()