Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-rest-framework
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
django-rest-framework
Commits
a9df917d
Commit
a9df917d
authored
Apr 11, 2011
by
Tom Christie
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Lots of validator tests passing after refactor
parent
136c9b52
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
99 additions
and
56 deletions
+99
-56
djangorestframework/emitters.py
+9
-14
djangorestframework/modelresource.py
+5
-3
djangorestframework/request.py
+23
-0
djangorestframework/resource.py
+6
-4
djangorestframework/tests/validators.py
+0
-0
djangorestframework/validators.py
+56
-35
No files found.
djangorestframework/emitters.py
View file @
a9df917d
...
@@ -9,7 +9,6 @@ from django.template import RequestContext, loader
...
@@ -9,7 +9,6 @@ from django.template import RequestContext, loader
from
django
import
forms
from
django
import
forms
from
djangorestframework.response
import
NoContent
,
ResponseException
from
djangorestframework.response
import
NoContent
,
ResponseException
from
djangorestframework.validators
import
FormValidatorMixin
from
djangorestframework.utils
import
dict2xml
,
url_resolves
from
djangorestframework.utils
import
dict2xml
,
url_resolves
from
djangorestframework.markdownwrapper
import
apply_markdown
from
djangorestframework.markdownwrapper
import
apply_markdown
from
djangorestframework.breadcrumbs
import
get_breadcrumbs
from
djangorestframework.breadcrumbs
import
get_breadcrumbs
...
@@ -217,15 +216,11 @@ class DocumentingTemplateEmitter(BaseEmitter):
...
@@ -217,15 +216,11 @@ class DocumentingTemplateEmitter(BaseEmitter):
#form_instance = resource.form_instance
#form_instance = resource.form_instance
# TODO! Reinstate this
# TODO! Reinstate this
form_instance
=
None
form_instance
=
getattr
(
resource
,
'bound_form_instance'
,
None
)
if
isinstance
(
resource
,
FormValidatorMixin
):
if
not
form_instance
and
hasattr
(
resource
,
'get_bound_form'
):
# If we already have a bound form instance (IE provided by the input parser, then use that)
if
resource
.
bound_form_instance
is
not
None
:
form_instance
=
resource
.
bound_form_instance
# Otherwise if we have a response that is valid against the form then use that
# Otherwise if we have a response that is valid against the form then use that
if
not
form_instance
and
resource
.
response
.
has_content_body
:
if
resource
.
response
.
has_content_body
:
try
:
try
:
form_instance
=
resource
.
get_bound_form
(
resource
.
response
.
cleaned_content
)
form_instance
=
resource
.
get_bound_form
(
resource
.
response
.
cleaned_content
)
if
form_instance
and
not
form_instance
.
is_valid
():
if
form_instance
and
not
form_instance
.
is_valid
():
...
@@ -233,12 +228,12 @@ class DocumentingTemplateEmitter(BaseEmitter):
...
@@ -233,12 +228,12 @@ class DocumentingTemplateEmitter(BaseEmitter):
except
:
except
:
form_instance
=
None
form_instance
=
None
# If we still don't have a form instance then try to get an unbound form
# If we still don't have a form instance then try to get an unbound form
if
not
form_instance
:
if
not
form_instance
:
try
:
try
:
form_instance
=
resource
.
get_bound_form
()
form_instance
=
resource
.
get_bound_form
()
except
:
except
:
pass
pass
# If we still don't have a form instance then try to get an unbound form which can tunnel arbitrary content types
# If we still don't have a form instance then try to get an unbound form which can tunnel arbitrary content types
if
not
form_instance
:
if
not
form_instance
:
...
...
djangorestframework/modelresource.py
View file @
a9df917d
...
@@ -5,15 +5,14 @@ from django.db.models.fields.related import RelatedField
...
@@ -5,15 +5,14 @@ from django.db.models.fields.related import RelatedField
from
djangorestframework.response
import
Response
,
ResponseException
from
djangorestframework.response
import
Response
,
ResponseException
from
djangorestframework.resource
import
Resource
from
djangorestframework.resource
import
Resource
from
djangorestframework.validators
import
ModelFormValidatorMixin
from
djangorestframework
import
status
,
validators
from
djangorestframework
import
status
import
decimal
import
decimal
import
inspect
import
inspect
import
re
import
re
class
ModelResource
(
Resource
,
ModelFormValidatorMixin
):
class
ModelResource
(
Resource
):
"""A specialized type of Resource, for resources that map directly to a Django Model.
"""A specialized type of Resource, for resources that map directly to a Django Model.
Useful things this provides:
Useful things this provides:
...
@@ -21,6 +20,9 @@ class ModelResource(Resource, ModelFormValidatorMixin):
...
@@ -21,6 +20,9 @@ class ModelResource(Resource, ModelFormValidatorMixin):
1. Nice serialization of returned Models and QuerySets.
1. Nice serialization of returned Models and QuerySets.
2. A default set of create/read/update/delete operations."""
2. A default set of create/read/update/delete operations."""
# List of validators to validate, cleanup and type-ify the request content
validators
=
(
validators
.
ModelFormValidator
,)
# The model attribute refers to the Django Model which this Resource maps to.
# The model attribute refers to the Django Model which this Resource maps to.
# (The Model's class, rather than an instance of the Model)
# (The Model's class, rather than an instance of the Model)
model
=
None
model
=
None
...
...
djangorestframework/request.py
View file @
a9df917d
...
@@ -196,6 +196,29 @@ class RequestMixin(object):
...
@@ -196,6 +196,29 @@ class RequestMixin(object):
return
parser
.
parse
(
stream
)
return
parser
.
parse
(
stream
)
def
validate
(
self
,
content
):
"""
Validate, cleanup, and type-ify the request content.
"""
for
validator_cls
in
self
.
validators
:
validator
=
validator_cls
(
self
)
content
=
validator
.
validate
(
content
)
return
content
def
get_bound_form
(
self
,
content
=
None
):
"""
Return a bound form instance for the given content,
if there is an appropriate form validator attached to the view.
"""
for
validator_cls
in
self
.
validators
:
if
hasattr
(
validator_cls
,
'get_bound_form'
):
validator
=
validator_cls
(
self
)
return
validator
.
get_bound_form
(
content
)
return
None
@property
@property
def
parsed_media_types
(
self
):
def
parsed_media_types
(
self
):
"""Return an list of all the media types that this view can parse."""
"""Return an list of all the media types that this view can parse."""
...
...
djangorestframework/resource.py
View file @
a9df917d
...
@@ -3,10 +3,9 @@ from django.views.decorators.csrf import csrf_exempt
...
@@ -3,10 +3,9 @@ from django.views.decorators.csrf import csrf_exempt
from
djangorestframework.compat
import
View
from
djangorestframework.compat
import
View
from
djangorestframework.emitters
import
EmitterMixin
from
djangorestframework.emitters
import
EmitterMixin
from
djangorestframework.validators
import
FormValidatorMixin
from
djangorestframework.response
import
Response
,
ResponseException
from
djangorestframework.response
import
Response
,
ResponseException
from
djangorestframework.request
import
RequestMixin
,
AuthMixin
from
djangorestframework.request
import
RequestMixin
,
AuthMixin
from
djangorestframework
import
emitters
,
parsers
,
authenticators
,
status
from
djangorestframework
import
emitters
,
parsers
,
authenticators
,
validators
,
status
# TODO: Figure how out references and named urls need to work nicely
# TODO: Figure how out references and named urls need to work nicely
...
@@ -17,7 +16,7 @@ from djangorestframework import emitters, parsers, authenticators, status
...
@@ -17,7 +16,7 @@ from djangorestframework import emitters, parsers, authenticators, status
__all__
=
[
'Resource'
]
__all__
=
[
'Resource'
]
class
Resource
(
EmitterMixin
,
AuthMixin
,
FormValidatorMixin
,
RequestMixin
,
View
):
class
Resource
(
EmitterMixin
,
AuthMixin
,
RequestMixin
,
View
):
"""Handles incoming requests and maps them to REST operations,
"""Handles incoming requests and maps them to REST operations,
performing authentication, input deserialization, input validation, output serialization."""
performing authentication, input deserialization, input validation, output serialization."""
...
@@ -38,7 +37,10 @@ class Resource(EmitterMixin, AuthMixin, FormValidatorMixin, RequestMixin, View):
...
@@ -38,7 +37,10 @@ class Resource(EmitterMixin, AuthMixin, FormValidatorMixin, RequestMixin, View):
parsers
=
(
parsers
.
JSONParser
,
parsers
=
(
parsers
.
JSONParser
,
parsers
.
FormParser
,
parsers
.
FormParser
,
parsers
.
MultipartParser
)
parsers
.
MultipartParser
)
# List of validators to validate, cleanup and type-ify the request content
validators
=
(
validators
.
FormValidator
,)
# List of all authenticating methods to attempt.
# List of all authenticating methods to attempt.
authenticators
=
(
authenticators
.
UserLoggedInAuthenticator
,
authenticators
=
(
authenticators
.
UserLoggedInAuthenticator
,
authenticators
.
BasicAuthenticator
)
authenticators
.
BasicAuthenticator
)
...
...
djangorestframework/tests/validators.py
View file @
a9df917d
This diff is collapsed.
Click to expand it.
djangorestframework/validators.py
View file @
a9df917d
...
@@ -4,25 +4,31 @@ from django.db import models
...
@@ -4,25 +4,31 @@ from django.db import models
from
djangorestframework.response
import
ResponseException
from
djangorestframework.response
import
ResponseException
from
djangorestframework.utils
import
as_tuple
from
djangorestframework.utils
import
as_tuple
class
ValidatorMixin
(
object
):
"""Base class for all ValidatorMixin classes, which simply defines the interface they provide."""
class
BaseValidator
(
object
):
"""Base class for all Validator classes, which simply defines the interface they provide."""
def
__init__
(
self
,
view
):
self
.
view
=
view
def
validate
(
self
,
content
):
def
validate
(
self
,
content
):
"""Given some content as input return some cleaned, validated content.
"""Given some content as input return some cleaned, validated content.
R
aises a ResponseException with status code 400 (Bad Request) on failure.
Typically r
aises a ResponseException with status code 400 (Bad Request) on failure.
Must be overridden to be implemented."""
Must be overridden to be implemented."""
raise
NotImplementedError
()
raise
NotImplementedError
()
class
FormValidatorMixin
(
ValidatorMixin
):
class
FormValidator
(
BaseValidator
):
"""Validator Mixin that uses forms for validation.
"""Validator class that uses forms for validation.
Extends the ValidatorMixin interface to also provide a get_bound_form() method.
Also provides a get_bound_form() method which may be used by some renderers.
(Which may be used by some emitters.)"""
"""The form class that should be used for validation, or None to turn off form validation."""
The view class should provide `.form` attribute which specifies the form classmethod
form
=
None
to be used for validation.
bound_form_instance
=
None
On calling validate() this validator may set a `.bound_form_instance` attribute on the
view, which may be used by some renderers."""
def
validate
(
self
,
content
):
def
validate
(
self
,
content
):
"""Given some content as input return some cleaned, validated content.
"""Given some content as input return some cleaned, validated content.
...
@@ -44,7 +50,7 @@ class FormValidatorMixin(ValidatorMixin):
...
@@ -44,7 +50,7 @@ class FormValidatorMixin(ValidatorMixin):
if
bound_form
is
None
:
if
bound_form
is
None
:
return
content
return
content
self
.
bound_form_instance
=
bound_form
self
.
view
.
bound_form_instance
=
bound_form
seen_fields_set
=
set
(
content
.
keys
())
seen_fields_set
=
set
(
content
.
keys
())
form_fields_set
=
set
(
bound_form
.
fields
.
keys
())
form_fields_set
=
set
(
bound_form
.
fields
.
keys
())
...
@@ -78,7 +84,10 @@ class FormValidatorMixin(ValidatorMixin):
...
@@ -78,7 +84,10 @@ class FormValidatorMixin(ValidatorMixin):
detail
[
u'errors'
]
=
bound_form
.
non_field_errors
()
detail
[
u'errors'
]
=
bound_form
.
non_field_errors
()
# Add standard field errors
# Add standard field errors
field_errors
=
dict
((
key
,
map
(
unicode
,
val
))
for
(
key
,
val
)
in
bound_form
.
errors
.
iteritems
()
if
not
key
.
startswith
(
'__'
))
field_errors
=
dict
((
key
,
map
(
unicode
,
val
))
for
(
key
,
val
)
in
bound_form
.
errors
.
iteritems
()
if
not
key
.
startswith
(
'__'
))
# Add any unknown field errors
# Add any unknown field errors
for
key
in
unknown_fields
:
for
key
in
unknown_fields
:
...
@@ -94,20 +103,21 @@ class FormValidatorMixin(ValidatorMixin):
...
@@ -94,20 +103,21 @@ class FormValidatorMixin(ValidatorMixin):
def
get_bound_form
(
self
,
content
=
None
):
def
get_bound_form
(
self
,
content
=
None
):
"""Given some content return a Django form bound to that content.
"""Given some content return a Django form bound to that content.
If form validation is turned off (form class attribute is None) then returns None."""
If form validation is turned off (form class attribute is None) then returns None."""
if
not
self
.
form
:
form_cls
=
getattr
(
self
.
view
,
'form'
,
None
)
if
not
form_cls
:
return
None
return
None
if
not
content
is
None
:
if
content
is
not
None
:
if
hasattr
(
content
,
'FILES'
):
if
hasattr
(
content
,
'FILES'
):
return
self
.
form
(
content
,
content
.
FILES
)
return
form_cls
(
content
,
content
.
FILES
)
return
self
.
form
(
content
)
return
form_cls
(
content
)
return
self
.
form
()
return
form_cls
()
class
ModelFormValidatorMixin
(
FormValidatorMixin
):
class
ModelFormValidator
(
FormValidator
):
"""Validator Mixin that uses forms for validation and falls back to a model form if no form is set.
"""Validator class that uses forms for validation and otherwise falls back to a model form if no form is set.
Extends the ValidatorMixin interface to also provide a get_bound_form() method.
Also provides a get_bound_form() method which may be used by some renderers."""
(Which may be used by some emitters.)"""
"""The form class that should be used for validation, or None to use model form validation."""
"""The form class that should be used for validation, or None to use model form validation."""
form
=
None
form
=
None
...
@@ -148,15 +158,18 @@ class ModelFormValidatorMixin(FormValidatorMixin):
...
@@ -148,15 +158,18 @@ class ModelFormValidatorMixin(FormValidatorMixin):
If the form class attribute has been explicitly set then use that class to create a Form,
If the form class attribute has been explicitly set then use that class to create a Form,
otherwise if model is set use that class to create a ModelForm, otherwise return None."""
otherwise if model is set use that class to create a ModelForm, otherwise return None."""
if
self
.
form
:
form_cls
=
getattr
(
self
.
view
,
'form'
,
None
)
model_cls
=
getattr
(
self
.
view
,
'model'
,
None
)
if
form_cls
:
# Use explict Form
# Use explict Form
return
super
(
ModelFormValidator
Mixin
,
self
)
.
get_bound_form
(
content
)
return
super
(
ModelFormValidator
,
self
)
.
get_bound_form
(
content
)
elif
self
.
model
:
elif
model_cls
:
# Fall back to ModelForm which we create on the fly
# Fall back to ModelForm which we create on the fly
class
OnTheFlyModelForm
(
forms
.
ModelForm
):
class
OnTheFlyModelForm
(
forms
.
ModelForm
):
class
Meta
:
class
Meta
:
model
=
self
.
model
model
=
model_cls
#fields = tuple(self._model_fields_set)
#fields = tuple(self._model_fields_set)
# Instantiate the ModelForm as appropriate
# Instantiate the ModelForm as appropriate
...
@@ -176,24 +189,32 @@ class ModelFormValidatorMixin(FormValidatorMixin):
...
@@ -176,24 +189,32 @@ class ModelFormValidatorMixin(FormValidatorMixin):
@property
@property
def
_model_fields_set
(
self
):
def
_model_fields_set
(
self
):
"""Return a set containing the names of validated fields on the model."""
"""Return a set containing the names of validated fields on the model."""
model_fields
=
set
(
field
.
name
for
field
in
self
.
model
.
_meta
.
fields
)
model
=
getattr
(
self
.
view
,
'model'
,
None
)
fields
=
getattr
(
self
.
view
,
'fields'
,
self
.
fields
)
exclude_fields
=
getattr
(
self
.
view
,
'exclude_fields'
,
self
.
exclude_fields
)
model_fields
=
set
(
field
.
name
for
field
in
model
.
_meta
.
fields
)
if
self
.
fields
:
if
fields
:
return
model_fields
&
set
(
as_tuple
(
self
.
fields
))
return
model_fields
&
set
(
as_tuple
(
fields
))
return
model_fields
-
set
(
as_tuple
(
self
.
exclude_fields
))
return
model_fields
-
set
(
as_tuple
(
exclude_fields
))
@property
@property
def
_property_fields_set
(
self
):
def
_property_fields_set
(
self
):
"""Returns a set containing the names of validated properties on the model."""
"""Returns a set containing the names of validated properties on the model."""
property_fields
=
set
(
attr
for
attr
in
dir
(
self
.
model
)
if
model
=
getattr
(
self
.
view
,
'model'
,
None
)
isinstance
(
getattr
(
self
.
model
,
attr
,
None
),
property
)
fields
=
getattr
(
self
.
view
,
'fields'
,
self
.
fields
)
exclude_fields
=
getattr
(
self
.
view
,
'exclude_fields'
,
self
.
exclude_fields
)
property_fields
=
set
(
attr
for
attr
in
dir
(
model
)
if
isinstance
(
getattr
(
model
,
attr
,
None
),
property
)
and
not
attr
.
startswith
(
'_'
))
and
not
attr
.
startswith
(
'_'
))
if
self
.
fields
:
if
fields
:
return
property_fields
&
set
(
as_tuple
(
self
.
fields
))
return
property_fields
&
set
(
as_tuple
(
fields
))
return
property_fields
-
set
(
as_tuple
(
self
.
exclude_fields
))
return
property_fields
-
set
(
as_tuple
(
exclude_fields
))
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment