Skip to content

Fix blank lines around docstrings #4002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion rest_framework/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@


def api_view(http_method_names=None):

"""
Decorator that converts a function-based view into an APIView subclass.
Takes a list of allowed methods for the view as an argument.
Expand Down
3 changes: 0 additions & 3 deletions rest_framework/generics.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ def get_paginated_response(self, data):

class CreateAPIView(mixins.CreateModelMixin,
GenericAPIView):

"""
Concrete view for creating a model instance.
"""
Expand Down Expand Up @@ -212,7 +211,6 @@ def get(self, request, *args, **kwargs):

class DestroyAPIView(mixins.DestroyModelMixin,
GenericAPIView):

"""
Concrete view for deleting a model instance.
"""
Expand All @@ -222,7 +220,6 @@ def delete(self, request, *args, **kwargs):

class UpdateAPIView(mixins.UpdateModelMixin,
GenericAPIView):

"""
Concrete view for updating a model instance.
"""
Expand Down
5 changes: 0 additions & 5 deletions rest_framework/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ class BaseParser(object):
All parsers should extend `BaseParser`, specifying a `media_type`
attribute, and overriding the `.parse()` method.
"""

media_type = None

def parse(self, stream, media_type=None, parser_context=None):
Expand All @@ -51,7 +50,6 @@ class JSONParser(BaseParser):
"""
Parses JSON-serialized data.
"""

media_type = 'application/json'
renderer_class = renderers.JSONRenderer

Expand All @@ -73,7 +71,6 @@ class FormParser(BaseParser):
"""
Parser for form data.
"""

media_type = 'application/x-www-form-urlencoded'

def parse(self, stream, media_type=None, parser_context=None):
Expand All @@ -91,7 +88,6 @@ class MultiPartParser(BaseParser):
"""
Parser for multipart form data, which may include file data.
"""

media_type = 'multipart/form-data'

def parse(self, stream, media_type=None, parser_context=None):
Expand Down Expand Up @@ -131,7 +127,6 @@ def parse(self, stream, media_type=None, parser_context=None):
`.data` will be None (we expect request body to be a file content).
`.files` will be a `QueryDict` containing one 'file' element.
"""

parser_context = parser_context or {}
request = parser_context['request']
encoding = parser_context.get('encoding', settings.DEFAULT_CHARSET)
Expand Down
2 changes: 1 addition & 1 deletion rest_framework/permissions.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class AllowAny(BasePermission):
permission_classes list, but it's useful because it makes the intention
more explicit.
"""

def has_permission(self, request, view):
return True

Expand Down Expand Up @@ -150,7 +151,6 @@ class DjangoObjectPermissions(DjangoModelPermissions):
This permission can only be applied against view classes that
provide a `.queryset` attribute.
"""

perms_map = {
'GET': [],
'OPTIONS': [],
Expand Down
1 change: 0 additions & 1 deletion rest_framework/relations.py
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,6 @@ class SlugRelatedField(RelatedField):
A read-write field that represents the target of the relationship
by a unique 'slug' attribute.
"""

default_error_messages = {
'does_not_exist': _('Object with {slug_name}={value} does not exist.'),
'invalid': _('Invalid value.'),
Expand Down
3 changes: 0 additions & 3 deletions rest_framework/renderers.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ class BaseRenderer(object):
All renderers should extend this class, setting the `media_type`
and `format` attributes, and override the `.render()` method.
"""

media_type = None
format = None
charset = 'utf-8'
Expand All @@ -54,7 +53,6 @@ class JSONRenderer(BaseRenderer):
"""
Renderer which serializes to JSON.
"""

media_type = 'application/json'
format = 'json'
encoder_class = encoders.JSONEncoder
Expand Down Expand Up @@ -136,7 +134,6 @@ class TemplateHTMLRenderer(BaseRenderer):

For pre-rendered HTML, see StaticHTMLRenderer.
"""

media_type = 'text/html'
format = 'html'
template_name = None
Expand Down
2 changes: 2 additions & 0 deletions rest_framework/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class override_method(object):
with override_method(view, request, 'POST') as request:
... # Do stuff with `view` and `request`
"""

def __init__(self, view, request, method):
self.view = view
self.request = request
Expand Down Expand Up @@ -129,6 +130,7 @@ class Request(object):
- authentication_classes(list/tuple). The authentications used to try
authenticating the request's user.
"""

def __init__(self, request, parsers=None, authenticators=None,
negotiator=None, parser_context=None):
self._request = request
Expand Down
1 change: 0 additions & 1 deletion rest_framework/routers.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ def get_routes(self, viewset):

Returns a list of the Route namedtuple.
"""

known_actions = flatten([route.mapping.values() for route in self.routes if isinstance(route, Route)])

# Determine any `@detail_route` or `@list_route` decorated methods on the viewset
Expand Down
2 changes: 1 addition & 1 deletion rest_framework/throttling.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class BaseThrottle(object):
"""
Rate throttling of requests.
"""

def allow_request(self, request, view):
"""
Return `True` if the request should be allowed, `False` otherwise.
Expand Down Expand Up @@ -60,7 +61,6 @@ class SimpleRateThrottle(BaseThrottle):

Previous request information used for throttling is stored in the cache.
"""

cache = default_cache
timer = time.time
cache_format = 'throttle_%(scope)s_%(ident)s'
Expand Down
1 change: 0 additions & 1 deletion rest_framework/utils/breadcrumbs.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ def breadcrumbs_recursive(url, breadcrumbs_list, prefix, seen):
Add tuples of (name, url) to the breadcrumbs list,
progressively chomping off parts of the url.
"""

try:
(view, unused_args, unused_kwargs) = resolve(url)
except Exception:
Expand Down