Entities and Attributes
=======================
-.. module:: philo.models.base
+.. automodule:: philo.models.base
One of the core concepts in Philo is the relationship between the :class:`Entity` and :class:`Attribute` classes. :class:`Attribute`\ s represent an arbitrary key/value pair by having one :class:`GenericForeignKey` to an :class:`Entity` and another to an :class:`AttributeValue`.
:show-inheritance:
.. automodule:: philo.models.base
+ :noindex:
:members: value_content_type_limiter
.. autofunction:: register_value_model(model)
entities
nodes-and-views
collections
+ miscellaneous
-.. :module: philo.models
+.. automodule:: philo.models
--- /dev/null
+Miscellaneous Support Classes
+=============================
+.. autoclass:: philo.models.nodes.TargetURLModel
+ :members:
+ :exclude-members: get_target_url
\ No newline at end of file
:members:
:exclude-members: attribute_set
-.. class:: MultiView
-
- :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:
-
- .. attribute:: accepts_subpath
-
- Same as :attr:`View.accepts_subpath`. Default: ``True``
-
- .. attribute:: urlpatterns
-
- Returns urlpatterns that point to views (generally methods on the class). :class:`!MultiView`\ s can be thought of as "managing" these subpaths.
-
- .. method:: actually_render_to_response(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.
-
- .. method:: get_context()
-
- Hook for providing instance-specific context - such as the value of a Field - to all views.
-
- .. method:: basic_view(field_name)
-
- Given the name of a field on ``self``, accesses the value of that field and treats it as a :class:`View` instance. Creates a basic context based on :meth:`get_context` and any extra_context that was passed in, then calls the :class:`View` instance's :meth:`~View.render_to_response` method. This method is meant to be called to return a view function appropriate for :attr:`urlpatterns`.
+.. autoclass:: MultiView
+ :show-inheritance:
+ :members:
+ :exclude-members: attribute_set
Concrete View Subclasses
++++++++++++++++++++++++
-.. class:: Redirect
-
- A :class:`View` subclass. Defines a 301 or 302 redirect to a different url on an absolute or relative path.
-
- .. attribute:: STATUS_CODES
-
- A choices tuple of redirect status codes (temporary or permanent).
-
- .. attribute:: status_code
-
- An :class:`IntegerField` which uses :attr:`STATUS_CODES` as its choices. Determines whether the redirect is considered temporary or permanent.
-
- .. attribute:: target_node
-
- An optional :class:`ForeignKey` to a :class:`Node`. If provided, that node will be used as the basis for the redirect.
-
- .. attribute:: url_or_subpath
-
- A :class:`CharField` which may contain an absolute or relative URL. This will be validated with :class:`philo.validators.RedirectValidator`.
-
- .. attribute:: reversing_parameters
-
- 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.
-
- .. attribute:: target_url
-
- Calculates and returns the target url based on the :attr:`target_node`, :attr:`url_or_subpath`, and :attr:`reversing_parameters`.
-
- .. method:: actually_render_to_response(request[, extra_context=None])
-
- Returns an :class:`HttpResponseRedirect` to :attr:`self.target`.
-
-.. class:: File
-
- A :class:`View` subclass. Stores an arbitrary file.
-
- .. attribute:: mimetype
-
- Defines the mimetype of the uploaded file. This will not be validated.
-
- .. attribute:: file
-
- Contains the uploaded file. Files are uploaded to ``philo/files/%Y/%m/%d``.
-
- .. method:: __unicode__()
+.. autoclass:: Redirect
+ :show-inheritance:
+ :members:
+ :exclude-members: attribute_set
- Returns the name of :attr:`self.file <file>`.
+.. autoclass:: File
+ :show-inheritance:
+ :members:
+ :exclude-members: attribute_set
Pages
*****
-:class:`Page`\ s are the most frequently used :class:`View` subclass. They define a basic HTML page and its associated content. Each :class:`Page` renders itself according to a :class:`Template`. The :class:`Template` may contain :ttag:`container` tags, which define related :class:`Contentlet`\ s and :class:`ContentReference`\ s for any page using that :class:`Template`.
-
-.. class:: Page
-
- A :class:`View` subclass. Represents a page - something which is rendered according to a template. The page will have a number of related Contentlets depending on the template selected - but these will appear only after the page has been saved with that template.
-
- .. attribute:: template
-
- A :class:`ForeignKey` to the :class:`Template` used to render this :class:`Page`.
-
- .. attribute:: title
+.. automodule:: philo.models.pages
- The name of this page. Chances are this will be used for organization - i.e. finding the page in a list of pages - rather than for display.
-
- .. attribute:: containers
-
- Returns :attr:`self.template.containers <Template.containers>` - a tuple containing the specs of all :ttag:`container`\ s defined in the :class:`Template`. The value will be cached on the instance so that multiple accesses will be less expensive.
-
- .. method:: render_to_string([request=None, extra_context=None])
-
- In addition to rendering as an :class:`HttpResponse`, a :class:`Page` can also render as a string. This means, for example, that :class:`Page`\ s can be used to render emails or other non-HTML-related content with the same :ttag:`container`-based functionality as is used for HTML.
-
- .. method:: actually_render_to_response(request[, extra_context=None])
-
- Returns an :class:`HttpResponse` with the content of the :meth:`render_to_string` method and the mimetype set to :attr:`self.template.mimetype <Template.mimetype>`.
-
- .. clean_fields(self[, exclude=None)
-
- This is an override of the default model clean_fields method. Essentially, in addition to validating the fields, this method validates the :class:`Template` instance that is used to render this :class:`Page`. This is useful for catching template errors before they show up as 500 errors on a live site.
-
- .. method:: __unicode__()
-
- Returns :meth:`self.title <title>`
-
-.. class:: Template
-
- Subclasses :class:`TreeModel`. Represents a database-driven django template. Defines the following additional methods and attributes:
-
- .. attribute:: name
-
- The name of the template. Used for organization and debugging.
-
- .. attribute:: documentation
-
- Can be used to let users know what the template is meant to be used for.
-
- .. attribute:: mimetype
-
- Defines the mimetype of the template. This is not validated. Default: ``text/html``.
-
- .. attribute:: code
-
- An insecure :class:`~philo.models.fields.TemplateField` containing the django template code for this template.
-
- .. attribute:: containers
-
- Returns a tuple where the first item is a list of names of contentlets referenced by containers, and the second item is a list of tuples of names and contenttypes of contentreferences referenced by containers. This will break if there is a recursive extends or includes in the template code. Due to the use of an empty Context, any extends or include tags with dynamic arguments probably won't work.
-
- .. method:: __unicode__()
-
- Returns the results of the :meth:`~TreeModel.get_path` method, using the "name" field and a chevron joiner.
-
-.. class:: Contentlet
-
- Defines a piece of content on a page. This content is treated as a secure :class:`~philo.models.fields.TemplateField`.
-
- .. attribute:: page
-
- The page which this :class:`Contentlet` is related to.
-
- .. attribute:: name
-
- This represents the name of the container as defined by a :ttag:`container` tag.
-
- .. attribute:: content
-
- A secure :class:`~philo.models.fields.TemplateField` holding the content for this :class:`Contentlet`. Note that actually using this field as a template requires use of the :ttag:`include_string` template tag.
-
- .. method:: __unicode__()
-
- Returns :attr:`self.name <name>`
-
-.. class:: ContentReference
-
- Defines a model instance related to a page.
-
- .. attribute:: page
-
- The page which this :class:`ContentReference` is related to.
-
- .. attribute:: name
-
- This represents the name of the container as defined by a :ttag:`container` tag.
-
- .. attribute:: content
+.. autoclass:: Page
+ :members:
+ :exclude-members: attribute_set
+ :show-inheritance:
- A :class:`GenericForeignKey` to a model instance. The content type of this instance is defined by the :ttag:`container` tag which defines this :class:`ContentReference`.
+.. autoclass:: Template
+ :members:
+ :show-inheritance:
- .. method:: __unicode__()
+.. autoclass:: Contentlet
+ :members:
- Returns :attr:`self.name <name>`
\ No newline at end of file
+.. autoclass:: ContentReference
+ :members:
\ No newline at end of file
abstract = True
-#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by ForeignKeyValues and ManyToManyValues.
+#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by :class:`ForeignKeyValue`\ s and :class:`ManyToManyValue`\ s.
value_content_type_limiter = ContentTypeRegistryLimiter()
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
raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
def attributes_with_node(self, node):
+ """
+ Returns a :class:`~philo.models.base.QuerySetMapper` using the :class:`Node`'s attributes as a passthrough.
+
+ """
return QuerySetMapper(self.attribute_set, passthrough=node.attributes)
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
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:
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):
+ """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):
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)
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):
"""
- 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.
+
+ :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)
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")
+ #: A :class:`CharField` which may contain an absolute or relative URL. This will be validated with :class:`philo.validators.RedirectValidator`.
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:`~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):
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:
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'),
)
+ #: 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):
+ """Returns an :class:`HttpResponseRedirect` to :attr:`self.target_url`."""
response = HttpResponseRedirect(self.target_url)
response.status_code = self.status_code
return response
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)
+ #: 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):
app_label = 'philo'
def __unicode__(self):
+ """Returns the path of the uploaded file."""
return self.file.name
# encoding: utf-8
+"""
+:class:`Page`\ s are the most frequently used :class:`View` subclass. They define a basic HTML page and its associated content. Each :class:`Page` renders itself according to a :class:`Template`. The :class:`Template` may contain :ttag:`container <philo.templatetags.containers.do_container>` tags, which define related :class:`Contentlet`\ s and :class:`ContentReference`\ s for any page using that :class:`Template`.
+
+"""
+
from django.conf import settings
from django.contrib.contenttypes.models import ContentType
from django.contrib.contenttypes import generic
class Template(TreeModel):
+ """Represents a database-driven django template."""
+ #: The name of the template. Used for organization and debugging.
name = models.CharField(max_length=255)
+ #: Can be used to let users know what the template is meant to be used for.
documentation = models.TextField(null=True, blank=True)
+ #: Defines the mimetype of the template. This is not validated. Default: ``text/html``.
mimetype = models.CharField(max_length=255, default=getattr(settings, 'DEFAULT_CONTENT_TYPE', 'text/html'))
+ #: An insecure :class:`~philo.models.fields.TemplateField` containing the django template code for this template.
code = TemplateField(secure=False, verbose_name='django template code')
@property
def containers(self):
"""
- Returns a tuple where the first item is a list of names of contentlets referenced by containers,
- and the second item is a list of tuples of names and contenttypes of contentreferences referenced by containers.
- This will break if there is a recursive extends or includes in the template code.
- Due to the use of an empty Context, any extends or include tags with dynamic arguments probably won't work.
+ Returns a tuple where the first item is a list of names of contentlets referenced by containers, and the second item is a list of tuples of names and contenttypes of contentreferences referenced by containers. This will break if there is a recursive extends or includes in the template code. Due to the use of an empty Context, any extends or include tags with dynamic arguments probably won't work.
+
"""
template = DjangoTemplate(self.code)
return contentlet_specs, contentreference_specs
def __unicode__(self):
+ """Returns the value of the :attr:`name` field."""
return self.name
class Meta:
class Page(View):
"""
- Represents a page - something which is rendered according to a template. The page will have a number of related Contentlets depending on the template selected - but these will appear only after the page has been saved with that template.
+ Represents a page - something which is rendered according to a :class:`Template`. The page will have a number of related :class:`Contentlet`\ s and :class:`ContentReference`\ s depending on the template selected - but these will appear only after the page has been saved with that template.
+
"""
+ #: A :class:`ForeignKey` to the :class:`Template` used to render this :class:`Page`.
template = models.ForeignKey(Template, related_name='pages')
+ #: The name of this page. Chances are this will be used for organization - i.e. finding the page in a list of pages - rather than for display.
title = models.CharField(max_length=255)
def get_containers(self):
+ """
+ Returns the results :attr:`~Template.containers` for the related template. This is a tuple containing the specs of all :ttag:`containers <philo.templatetags.containers.do_container>` in the :class:`Template`'s code. The value will be cached on the instance so that multiple accesses will be less expensive.
+
+ """
if not hasattr(self, '_containers'):
self._containers = self.template.containers
return self._containers
containers = property(get_containers)
def render_to_string(self, request=None, extra_context=None):
+ """
+ In addition to rendering as an :class:`HttpResponse`, a :class:`Page` can also render as a string. This means, for example, that :class:`Page`\ s can be used to render emails or other non-HTML content with the same :ttag:`container <philo.templatetags.containers.do_container>`-based functionality as is used for HTML.
+
+ """
context = {}
context.update(extra_context or {})
context.update({'page': self, 'attributes': self.attributes})
return string
def actually_render_to_response(self, request, extra_context=None):
+ """Returns an :class:`HttpResponse` with the content of the :meth:`render_to_string` method and the mimetype set to the :attr:`~Template.mimetype` of the related :class:`Template`."""
return HttpResponse(self.render_to_string(request, extra_context), mimetype=self.template.mimetype)
def __unicode__(self):
+ """Returns the value of :attr:`title`"""
return self.title
def clean_fields(self, exclude=None):
+ """
+ This is an override of the default model clean_fields method. Essentially, in addition to validating the fields, this method validates the :class:`Template` instance that is used to render this :class:`Page`. This is useful for catching template errors before they show up as 500 errors on a live site.
+
+ """
if exclude is None:
exclude = []
class Contentlet(models.Model):
+ """Represents a piece of content on a page. This content is treated as a secure :class:`~philo.models.fields.TemplateField`."""
+ #: The page which this :class:`Contentlet` is related to.
page = models.ForeignKey(Page, related_name='contentlets')
+ #: This represents the name of the container as defined by a :ttag:`container <philo.templatetags.containers.do_container>` tag.
name = models.CharField(max_length=255, db_index=True)
+ #: A secure :class:`~philo.models.fields.TemplateField` holding the content for this :class:`Contentlet`. Note that actually using this field as a template requires use of the :ttag:`include_string <philo.templatetags.include_string.do_include_string>` template tag.
content = TemplateField()
def __unicode__(self):
+ """Returns the value of the :attr:`name` field."""
return self.name
class Meta:
class ContentReference(models.Model):
+ """Represents a model instance related to a page."""
+ #: The page which this :class:`ContentReference` is related to.
page = models.ForeignKey(Page, related_name='contentreferences')
+ #: This represents the name of the container as defined by a :ttag:`container <philo.templatetags.containers.do_container>` tag.
name = models.CharField(max_length=255, db_index=True)
content_type = models.ForeignKey(ContentType, verbose_name='Content type')
content_id = models.PositiveIntegerField(verbose_name='Content ID', blank=True, null=True)
+ #: A :class:`GenericForeignKey` to a model instance. The content type of this instance is defined by the :ttag:`container <philo.templatetags.containers.do_container>` tag which defines this :class:`ContentReference`.
content = generic.GenericForeignKey('content_type', 'content_id')
def __unicode__(self):
+ """Returns the value of the :attr:`name` field."""
return self.name
class Meta:
git.ithinksw.org / philo.git / commitdiff