Removed penfield's reliance on the Titled model and marked it as deprecated.

[philo.git] / philo / models / nodes.py

diff --git a/philo/models/nodes.py b/philo/models/nodes.py
index 0765f8c..58adb6e 100644 (file)
--- a/philo/models/nodes.py
+++ b/philo/models/nodes.py
@@ -8,17 +8,19 @@ from django.core.servers.basehttp import FileWrapper
 from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch
 from django.db import models
 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404
 from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch
 from django.db import models
 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404

-from django.template import add_to_builtins as register_templatetags

 from django.utils.encoding import smart_str
 
 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED, ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths
 from django.utils.encoding import smart_str
 
 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED, ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths

-from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model
+from philo.models.base import TreeEntity, Entity, register_value_model

 from philo.models.fields import JSONField
 from philo.utils import ContentTypeSubclassLimiter
 from philo.models.fields import JSONField
 from philo.utils import ContentTypeSubclassLimiter

-from philo.validators import RedirectValidator
+from philo.utils.entities import LazyPassthroughAttributeMapper

 from philo.signals import view_about_to_render, view_finished_rendering
 
 
 from philo.signals import view_about_to_render, view_finished_rendering
 
 

+__all__ = ('Node', 'View', 'MultiView', 'Redirect', 'File')
+
+

 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
 
 
 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
 
 


@@ -122,7 +124,7 @@ class View(Entity):
        accepts_subpath = False
        
        def handles_subpath(self, subpath):
        accepts_subpath = False
        
        def handles_subpath(self, subpath):

-               """Returns True if the the :class:`View` handles the given subpath, and False otherwise."""
+               """Returns True if the :class:`View` handles the given subpath, and False otherwise."""

                if not self.accepts_subpath and subpath != "/":
                        return False
                return True
                if not self.accepts_subpath and subpath != "/":
                        return False
                return True


@@ -133,17 +135,14 @@ class View(Entity):
                
                If ``obj`` is provided, :meth:`get_reverse_params` will be called and the results will be combined with any ``view_name``, ``args``, and ``kwargs`` that may have been passed in.
                
                
                If ``obj`` is provided, :meth:`get_reverse_params` will be called and the results will be combined with any ``view_name``, ``args``, and ``kwargs`` that may have been passed in.
                

-               This method will raise the following exceptions:
-               
-               - :class:`~philo.exceptions.ViewDoesNotProvideSubpaths` if :attr:`accepts_subpath` is False.
-               - :class:`~philo.exceptions.ViewCanNotProvideSubpath` if a reversal is not possible.
-               

                :param view_name: The name of the view to be reversed.
                :param args: Extra args for reversing the view.
                :param kwargs: A dictionary of arguments for reversing the view.
                :param node: The node whose subpath this is.
                :param obj: An object to be passed to :meth:`get_reverse_params` to generate a view_name, args, and kwargs for reversal.
                :returns: A subpath beyond the node that reverses the view, or an absolute url that reverses the view if a node was passed in.
                :param view_name: The name of the view to be reversed.
                :param args: Extra args for reversing the view.
                :param kwargs: A dictionary of arguments for reversing the view.
                :param node: The node whose subpath this is.
                :param obj: An object to be passed to :meth:`get_reverse_params` to generate a view_name, args, and kwargs for reversal.
                :returns: A subpath beyond the node that reverses the view, or an absolute url that reverses the view if a node was passed in.

+               :except philo.exceptions.ViewDoesNotProvideSubpaths: if :attr:`accepts_subpath` is False
+               :except philo.exceptions.ViewCanNotProvideSubpath: if a reversal is not possible.

                
                """
                if not self.accepts_subpath:
                
                """
                if not self.accepts_subpath:


@@ -174,10 +173,20 @@ class View(Entity):
                """
                raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
        
                """
                raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
        

-       def attributes_with_node(self, node):
-               return QuerySetMapper(self.attribute_set, passthrough=node.attributes)
+       def attributes_with_node(self, node, mapper=LazyPassthroughAttributeMapper):
+               """
+               Returns a :class:`LazyPassthroughAttributeMapper` which can be used to directly retrieve the values of :class:`Attribute`\ s related to the :class:`View`, falling back on the :class:`Attribute`\ s of the passed-in :class:`Node` and its ancestors.
+               
+               """
+               return mapper((self, node))

        
        def render_to_response(self, request, extra_context=None):
        
        def render_to_response(self, request, extra_context=None):

+               """
+               Renders the :class:`View` as an :class:`HttpResponse`. This will raise :const:`~philo.exceptions.MIDDLEWARE_NOT_CONFIGURED` if the `request` doesn't have an attached :class:`Node`. This can happen if the :class:`~philo.middleware.RequestNodeMiddleware` is not in :setting:`settings.MIDDLEWARE_CLASSES` or if it is not functioning correctly.
+               
+               :meth:`render_to_response` will send the :data:`~philo.signals.view_about_to_render` signal, then call :meth:`actually_render_to_response`, and finally send the :data:`~philo.signals.view_finished_rendering` signal before returning the ``response``.
+
+               """

                if not hasattr(request, 'node'):
                        raise MIDDLEWARE_NOT_CONFIGURED
                
                if not hasattr(request, 'node'):
                        raise MIDDLEWARE_NOT_CONFIGURED
                


@@ -188,6 +197,7 @@ class View(Entity):
                return response
        
        def actually_render_to_response(self, request, extra_context=None):
                return response
        
        def actually_render_to_response(self, request, extra_context=None):

+               """Concrete subclasses must override this method to provide the business logic for turning a ``request`` and ``extra_context`` into an :class:`HttpResponse`."""

                raise NotImplementedError('View subclasses must implement actually_render_to_response.')
        
        class Meta:
                raise NotImplementedError('View subclasses must implement actually_render_to_response.')
        
        class Meta:


@@ -198,10 +208,16 @@ _view_content_type_limiter.cls = View
 
 
 class MultiView(View):
 
 
 class MultiView(View):

+       """
+       :class:`MultiView` is an abstract model which represents a section of related pages - for example, a :class:`~philo.contrib.penfield.BlogView` might have a foreign key to :class:`Page`\ s for an index, an entry detail, an entry archive by day, and so on. :class:`!MultiView` subclasses :class:`View`, and defines the following additional methods and attributes:
+       
+       """
+       #: Same as :attr:`View.accepts_subpath`. Default: ``True``

        accepts_subpath = True
        
        @property
        def urlpatterns(self):
        accepts_subpath = True
        
        @property
        def urlpatterns(self):

+               """Returns urlpatterns that point to views (generally methods on the class). :class:`MultiView`\ s can be thought of as "managing" these subpaths."""

                raise NotImplementedError("MultiView subclasses must implement urlpatterns.")
        
        def handles_subpath(self, subpath):
                raise NotImplementedError("MultiView subclasses must implement urlpatterns.")
        
        def handles_subpath(self, subpath):


@@ -214,6 +230,10 @@ class MultiView(View):
                return True
        
        def actually_render_to_response(self, request, extra_context=None):
                return True
        
        def actually_render_to_response(self, request, extra_context=None):

+               """
+               Resolves the remaining subpath left after finding this :class:`View`'s node using :attr:`self.urlpatterns <urlpatterns>` and renders the view function (or method) found with the appropriate args and kwargs.
+               
+               """

                clear_url_caches()
                subpath = request.node.subpath
                view, args, kwargs = resolve(subpath, urlconf=self)
                clear_url_caches()
                subpath = request.node.subpath
                view, args, kwargs = resolve(subpath, urlconf=self)


@@ -225,17 +245,33 @@ class MultiView(View):
                return view(request, *args, **kwargs)
        
        def get_context(self):
                return view(request, *args, **kwargs)
        
        def get_context(self):

-               """Hook for providing instance-specific context - such as the value of a Field - to all views."""
+               """Hook for providing instance-specific context - such as the value of a Field - to any view methods on the instance."""

                return {}
        
        def basic_view(self, field_name):
                """
                return {}
        
        def basic_view(self, field_name):
                """

-               Given the name of a field on ``self``, accesses the value of
+               Given the name of a field on the class, accesses the value of

                that field and treats it as a ``View`` instance. Creates a
                basic context based on self.get_context() and any extra_context
                that was passed in, then calls the ``View`` instance's
                render_to_response() method. This method is meant to be called
                to return a view function appropriate for urlpatterns.
                that field and treats it as a ``View`` instance. Creates a
                basic context based on self.get_context() and any extra_context
                that was passed in, then calls the ``View`` instance's
                render_to_response() method. This method is meant to be called
                to return a view function appropriate for urlpatterns.

+               
+               :param field_name: The name of a field on the instance which contains a :class:`View` subclass instance.
+               :returns: A simple view function.
+               
+               Example::
+                       
+                       class Foo(Multiview):
+                               page = models.ForeignKey(Page)
+                               
+                               @property
+                               def urlpatterns(self):
+                                       urlpatterns = patterns('',
+                                               url(r'^$', self.basic_view('page'))
+                                       )
+                                       return urlpatterns
+               

                """
                field = self._meta.get_field(field_name)
                view = getattr(self, field.name, None)
                """
                field = self._meta.get_field(field_name)
                view = getattr(self, field.name, None)


@@ -254,8 +290,12 @@ class MultiView(View):
 
 
 class TargetURLModel(models.Model):
 
 
 class TargetURLModel(models.Model):

+       """An abstract parent class for models which deal in targeting a url."""
+       #: An optional :class:`ForeignKey` to a :class:`Node`. If provided, that node will be used as the basis for the redirect.

        target_node = models.ForeignKey(Node, blank=True, null=True, related_name="%(app_label)s_%(class)s_related")
        target_node = models.ForeignKey(Node, blank=True, null=True, related_name="%(app_label)s_%(class)s_related")

-       url_or_subpath = models.CharField(max_length=200, validators=[RedirectValidator()], blank=True, help_text="Point to this url or, if a node is defined and accepts subpaths, this subpath of the node.")
+       #: A :class:`CharField` which may contain an absolute or relative URL, or the name of a node's subpath.
+       url_or_subpath = models.CharField(max_length=200, blank=True, help_text="Point to this url or, if a node is defined and accepts subpaths, this subpath of the node.")
+       #: A :class:`~philo.models.fields.JSONField` instance. If the value of :attr:`reversing_parameters` is not None, the :attr:`url_or_subpath` will be treated as the name of a view to be reversed. The value of :attr:`reversing_parameters` will be passed into the reversal as args if it is a list or as kwargs if it is a dictionary. Otherwise it will be ignored.

        reversing_parameters = JSONField(blank=True, help_text="If reversing parameters are defined, url_or_subpath will instead be interpreted as the view name to be reversed.")
        
        def clean(self):
        reversing_parameters = JSONField(blank=True, help_text="If reversing parameters are defined, url_or_subpath will instead be interpreted as the view name to be reversed.")
        
        def clean(self):


@@ -284,6 +324,7 @@ class TargetURLModel(models.Model):
                return self.url_or_subpath, args, kwargs
        
        def get_target_url(self):
                return self.url_or_subpath, args, kwargs
        
        def get_target_url(self):

+               """Calculates and returns the target url based on the :attr:`target_node`, :attr:`url_or_subpath`, and :attr:`reversing_parameters`."""

                node = self.target_node
                if node is not None and node.accepts_subpath and self.url_or_subpath:
                        if self.reversing_parameters is not None:
                node = self.target_node
                if node is not None and node.accepts_subpath and self.url_or_subpath:
                        if self.reversing_parameters is not None:


@@ -308,13 +349,17 @@ class TargetURLModel(models.Model):
 
 
 class Redirect(TargetURLModel, View):
 
 
 class Redirect(TargetURLModel, View):

+       """Represents a 301 or 302 redirect to a different url on an absolute or relative path."""
+       #: A choices tuple of redirect status codes (temporary or permanent).

        STATUS_CODES = (
                (302, 'Temporary'),
                (301, 'Permanent'),
        )
        STATUS_CODES = (
                (302, 'Temporary'),
                (301, 'Permanent'),
        )

+       #: An :class:`IntegerField` which uses :attr:`STATUS_CODES` as its choices. Determines whether the redirect is considered temporary or permanent.

        status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
        
        def actually_render_to_response(self, request, extra_context=None):
        status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
        
        def actually_render_to_response(self, request, extra_context=None):

+               """Returns an :class:`HttpResponseRedirect` to :attr:`self.target_url`."""

                response = HttpResponseRedirect(self.target_url)
                response.status_code = self.status_code
                return response
                response = HttpResponseRedirect(self.target_url)
                response.status_code = self.status_code
                return response


@@ -324,9 +369,10 @@ class Redirect(TargetURLModel, View):
 
 
 class File(View):
 
 
 class File(View):

-       """ For storing arbitrary files """
-       
+       """Stores an arbitrary file."""
+       #: Defines the mimetype of the uploaded file. This will not be validated.

        mimetype = models.CharField(max_length=255)
        mimetype = models.CharField(max_length=255)

+       #: Contains the uploaded file. Files are uploaded to ``philo/files/%Y/%m/%d``.

        file = models.FileField(upload_to='philo/files/%Y/%m/%d')
        
        def actually_render_to_response(self, request, extra_context=None):
        file = models.FileField(upload_to='philo/files/%Y/%m/%d')
        
        def actually_render_to_response(self, request, extra_context=None):


@@ -339,8 +385,8 @@ class File(View):
                app_label = 'philo'
        
        def __unicode__(self):
                app_label = 'philo'
        
        def __unicode__(self):

+               """Returns the path of the uploaded file."""

                return self.file.name
 
 
                return self.file.name
 
 

-register_templatetags('philo.templatetags.nodes')

 register_value_model(Node)
\ No newline at end of file
 register_value_model(Node)
\ No newline at end of file