From 259ebcdeeac9929b173cae8bbc5f7dd4ee102cb8 Mon Sep 17 00:00:00 2001 From: Julien Phalip Date: Mon, 19 Dec 2011 13:52:40 +0000 Subject: [PATCH] Fixed #17408 -- Cleaned up some namings in `contrib.formtools`. Thanks, Stephan Jaekel. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17236 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- .../formtools/tests/wizard/__init__.py | 4 ++-- .../tests/wizard/namedwizardtests/tests.py | 12 +++++------ .../formtools/wizard/storage/cookie.py | 2 +- django/contrib/formtools/wizard/views.py | 20 +++++++++---------- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/django/contrib/formtools/tests/wizard/__init__.py b/django/contrib/formtools/tests/wizard/__init__.py index 7b15fb5059..732c02f940 100644 --- a/django/contrib/formtools/tests/wizard/__init__.py +++ b/django/contrib/formtools/tests/wizard/__init__.py @@ -4,8 +4,8 @@ from django.contrib.formtools.tests.wizard.loadstorage import TestLoadStorage from django.contrib.formtools.tests.wizard.namedwizardtests.tests import ( NamedSessionWizardTests, NamedCookieWizardTests, - TestNamedUrlSessionFormWizard, - TestNamedUrlCookieFormWizard, + TestNamedUrlSessionWizardView, + TestNamedUrlCookieWizardView, NamedSessionFormTests, NamedCookieFormTests, ) diff --git a/django/contrib/formtools/tests/wizard/namedwizardtests/tests.py b/django/contrib/formtools/tests/wizard/namedwizardtests/tests.py index 87bb5f6e5e..1238c3e618 100644 --- a/django/contrib/formtools/tests/wizard/namedwizardtests/tests.py +++ b/django/contrib/formtools/tests/wizard/namedwizardtests/tests.py @@ -321,24 +321,24 @@ class NamedFormTests(object): instance.render_done(None) self.assertEqual(instance.storage.current_step, 'start') -class TestNamedUrlSessionFormWizard(NamedUrlSessionWizardView): +class TestNamedUrlSessionWizardView(NamedUrlSessionWizardView): def dispatch(self, request, *args, **kwargs): - response = super(TestNamedUrlSessionFormWizard, self).dispatch(request, *args, **kwargs) + response = super(TestNamedUrlSessionWizardView, self).dispatch(request, *args, **kwargs) return response, self -class TestNamedUrlCookieFormWizard(NamedUrlCookieWizardView): +class TestNamedUrlCookieWizardView(NamedUrlCookieWizardView): def dispatch(self, request, *args, **kwargs): - response = super(TestNamedUrlCookieFormWizard, self).dispatch(request, *args, **kwargs) + response = super(TestNamedUrlCookieWizardView, self).dispatch(request, *args, **kwargs) return response, self class NamedSessionFormTests(NamedFormTests, TestCase): - formwizard_class = TestNamedUrlSessionFormWizard + formwizard_class = TestNamedUrlSessionWizardView wizard_urlname = 'nwiz_session' class NamedCookieFormTests(NamedFormTests, TestCase): - formwizard_class = TestNamedUrlCookieFormWizard + formwizard_class = TestNamedUrlCookieWizardView wizard_urlname = 'nwiz_cookie' diff --git a/django/contrib/formtools/wizard/storage/cookie.py b/django/contrib/formtools/wizard/storage/cookie.py index af26e01337..d1776de89b 100644 --- a/django/contrib/formtools/wizard/storage/cookie.py +++ b/django/contrib/formtools/wizard/storage/cookie.py @@ -20,7 +20,7 @@ class CookieStorage(storage.BaseStorage): except KeyError: data = None except BadSignature: - raise SuspiciousOperation('FormWizard cookie manipulated') + raise SuspiciousOperation('WizardView cookie manipulated') if data is None: return None return json.loads(data, cls=json.JSONDecoder) diff --git a/django/contrib/formtools/wizard/views.py b/django/contrib/formtools/wizard/views.py index aac29bf6ab..4104eaf50b 100644 --- a/django/contrib/formtools/wizard/views.py +++ b/django/contrib/formtools/wizard/views.py @@ -111,9 +111,9 @@ class WizardView(TemplateView): @classonlymethod def as_view(cls, *args, **kwargs): """ - This method is used within urls.py to create unique formwizard + This method is used within urls.py to create unique wizardview instances for every request. We need to override this method because - we add some kwargs which are needed to make the formwizard usable. + we add some kwargs which are needed to make the wizardview usable. """ initkwargs = cls.get_initkwargs(*args, **kwargs) return super(WizardView, cls).as_view(**initkwargs) @@ -126,7 +126,7 @@ class WizardView(TemplateView): * `form_list` - is a list of forms. The list entries can be single form classes or tuples of (`step_name`, `form_class`). If you pass a list - of forms, the formwizard will convert the class list to + of forms, the wizardview will convert the class list to (`zero_based_counter`, `form_class`). This is needed to access the form for a specific step. * `initial_dict` - contains a dictionary of initial data dictionaries. @@ -139,7 +139,7 @@ class WizardView(TemplateView): apply. * `condition_dict` - contains a dictionary of boolean values or callables. If the value of for a specific `step_name` is callable it - will be called with the formwizard instance as the only argument. + will be called with the wizardview instance as the only argument. If the return value is true, the step's form will be used. """ kwargs.update({ @@ -168,13 +168,13 @@ class WizardView(TemplateView): # we need to override the form variable. form = form.form # check if any form contains a FileField, if yes, we need a - # file_storage added to the formwizard (by subclassing). + # file_storage added to the wizardview (by subclassing). for field in form.base_fields.itervalues(): if (isinstance(field, forms.FileField) and not hasattr(cls, 'file_storage')): raise NoFileStorageConfigured - # build the kwargs for the formwizard instances + # build the kwargs for the wizardview instances kwargs['form_list'] = init_form_list return kwargs @@ -215,7 +215,7 @@ class WizardView(TemplateView): After processing the request using the `dispatch` method, the response gets updated by the storage engine (for example add cookies). """ - # add the storage engine to the current formwizard instance + # add the storage engine to the current wizardview instance self.prefix = self.get_prefix(*args, **kwargs) self.storage = get_storage(self.storage_name, self.prefix, request, getattr(self, 'file_storage', None)) @@ -517,7 +517,7 @@ class WizardView(TemplateView): .. code-block:: python - class MyWizard(FormWizard): + class MyWizard(WizardView): def get_context_data(self, form, **kwargs): context = super(MyWizard, self).get_context_data(form=form, **kwargs) if self.steps.current == 'my_step_name': @@ -642,7 +642,7 @@ class NamedUrlWizardView(WizardView): def post(self, *args, **kwargs): """ Do a redirect if user presses the prev. step button. The rest of this - is super'd from FormWizard. + is super'd from WizardView. """ wizard_goto_step = self.request.POST.get('wizard_goto_step', None) if wizard_goto_step and wizard_goto_step in self.get_form_list(): @@ -661,7 +661,7 @@ class NamedUrlWizardView(WizardView): def render_next_step(self, form, **kwargs): """ - When using the NamedUrlFormWizard, we have to redirect to update the + When using the NamedUrlWizardView, we have to redirect to update the browser's URL to match the shown step. """ next_step = self.get_next_step()