From c237f0529536e3c959f32e9fcd2d6e2be42a6c87 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Wed, 16 May 2018 13:46:32 -0400 Subject: [PATCH] Update tests to use basename --- docs/topics/release-notes.md | 13 +++++++++++++ tests/test_routers.py | 10 +++++----- tests/test_schemas.py | 10 +++++----- tests/test_viewsets.py | 6 +++--- 4 files changed, 26 insertions(+), 13 deletions(-) diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index 2acf55762..e9f8d5abc 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -38,6 +38,16 @@ You can determine your currently installed version using `pip show`: --- +## 3.9.x series + +### 3.9.0 + +**Date**: Unreleased + +* Deprecate the `Router.register` `base_name` argument in favor of `basename`. [#5990][gh5990] +* Deprecate the `Router.get_default_base_name` method in favor of `Router.get_default_basename`. [#5990][gh5990] + + ## 3.8.x series ### 3.8.2 @@ -1961,3 +1971,6 @@ For older release notes, [please see the version 2.x documentation][old-release- [gh5922]: https://github.com/encode/django-rest-framework/issues/5922 [gh5921]: https://github.com/encode/django-rest-framework/issues/5921 [gh5920]: https://github.com/encode/django-rest-framework/issues/5920 + + +[gh5990]: https://github.com/encode/django-rest-framework/issues/5990 diff --git a/tests/test_routers.py b/tests/test_routers.py index dc2625659..d760db603 100644 --- a/tests/test_routers.py +++ b/tests/test_routers.py @@ -87,13 +87,13 @@ kwarged_notes_router = SimpleRouter() kwarged_notes_router.register(r'notes', KWargedNoteViewSet) namespaced_router = DefaultRouter() -namespaced_router.register(r'example', MockViewSet, base_name='example') +namespaced_router.register(r'example', MockViewSet, basename='example') empty_prefix_router = SimpleRouter() -empty_prefix_router.register(r'', EmptyPrefixViewSet, base_name='empty_prefix') +empty_prefix_router.register(r'', EmptyPrefixViewSet, basename='empty_prefix') regex_url_path_router = SimpleRouter() -regex_url_path_router.register(r'', RegexUrlPathViewSet, base_name='regex') +regex_url_path_router.register(r'', RegexUrlPathViewSet, basename='regex') class BasicViewSet(viewsets.ViewSet): @@ -305,7 +305,7 @@ class TestActionKeywordArgs(TestCase): }) self.router = SimpleRouter() - self.router.register(r'test', TestViewSet, base_name='test') + self.router.register(r'test', TestViewSet, basename='test') self.view = self.router.urls[-1].callback def test_action_kwargs(self): @@ -330,7 +330,7 @@ class TestActionAppliedToExistingRoute(TestCase): }) self.router = SimpleRouter() - self.router.register(r'test', TestViewSet, base_name='test') + self.router.register(r'test', TestViewSet, basename='test') with pytest.raises(ImproperlyConfigured): self.router.urls diff --git a/tests/test_schemas.py b/tests/test_schemas.py index 47afe867d..55bc08437 100644 --- a/tests/test_schemas.py +++ b/tests/test_schemas.py @@ -112,7 +112,7 @@ else: pass router = DefaultRouter() -router.register('example', ExampleViewSet, base_name='example') +router.register('example', ExampleViewSet, basename='example') urlpatterns = [ url(r'^$', schema_view), url(r'^', include(router.urls)) @@ -491,7 +491,7 @@ class TestSchemaGeneratorNotAtRoot(TestCase): class TestSchemaGeneratorWithMethodLimitedViewSets(TestCase): def setUp(self): router = DefaultRouter() - router.register('example1', MethodLimitedViewSet, base_name='example1') + router.register('example1', MethodLimitedViewSet, basename='example1') self.patterns = [ url(r'^', include(router.urls)) ] @@ -547,8 +547,8 @@ class TestSchemaGeneratorWithMethodLimitedViewSets(TestCase): class TestSchemaGeneratorWithRestrictedViewSets(TestCase): def setUp(self): router = DefaultRouter() - router.register('example1', Http404ExampleViewSet, base_name='example1') - router.register('example2', PermissionDeniedExampleViewSet, base_name='example2') + router.register('example1', Http404ExampleViewSet, basename='example1') + router.register('example2', PermissionDeniedExampleViewSet, basename='example2') self.patterns = [ url('^example/?$', ExampleListView.as_view()), url(r'^', include(router.urls)) @@ -980,7 +980,7 @@ class NamingCollisionViewSet(GenericViewSet): naming_collisions_router = SimpleRouter() -naming_collisions_router.register(r'collision', NamingCollisionViewSet, base_name="collision") +naming_collisions_router.register(r'collision', NamingCollisionViewSet, basename="collision") class TestURLNamingCollisions(TestCase): diff --git a/tests/test_viewsets.py b/tests/test_viewsets.py index a4d0ffb69..223b46e4d 100644 --- a/tests/test_viewsets.py +++ b/tests/test_viewsets.py @@ -59,7 +59,7 @@ class ActionViewSet(GenericViewSet): router = SimpleRouter() router.register(r'actions', ActionViewSet) -router.register(r'actions-alt', ActionViewSet, base_name='actions-alt') +router.register(r'actions-alt', ActionViewSet, basename='actions-alt') urlpatterns = [ @@ -125,7 +125,7 @@ class GetExtraActionTests(TestCase): class ReverseActionTests(TestCase): def test_default_basename(self): view = ActionViewSet() - view.basename = router.get_default_base_name(ActionViewSet) + view.basename = router.get_default_basename(ActionViewSet) view.request = None assert view.reverse_action('list') == '/api/actions/' @@ -151,7 +151,7 @@ class ReverseActionTests(TestCase): def test_request_passing(self): view = ActionViewSet() - view.basename = router.get_default_base_name(ActionViewSet) + view.basename = router.get_default_basename(ActionViewSet) view.request = factory.get('/') # Passing the view's request object should result in an absolute URL.