Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Cleaning up for docs

  • Loading branch information...
commit c76408c2c002dcab6bfc3148760ee58a19cbe05e 1 parent 2585d1b
@coleifer authored
View
83 README.rst
@@ -5,54 +5,67 @@ django-generic-aggregation
annotate() and aggregate() for generically-related data. also a handy function
for filtering GFK-model querysets.
-the use of annotate() and aggregate() require a ``GenericRelation``.
+Use django's `GenericRelation <https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/#reverse-generic-relations>`_ where possible,
+as this can make the queries generated more efficient by using a JOIN rather
+than a subquery.
-Examples
---------
-You want the most commented on blog entries::
+installation
+------------
+
+::
+
+ # install from pypi
+ pip install django-generic-aggregation
+
+ # or install via git
+ pip install -e git+git://github.com/coleifer/django-generic-aggregation.git#egg=generic_aggregation
- >>> from django.contrib.comments.models import Comment
- >>> from django.db.models import Count
- >>> from blog.models import BlogEntry
- >>> from generic_aggregation import generic_annotate
- >>> annotated = generic_annotate(BlogEntry.objects.all(), Comment, Count('comments__id'))
+examples
+--------
- >>> for entry in annotated:
- ... print entry.title, entry.score
+The examples below assume the following simple models:
- The most popular 5
- The second best 4
- Nobody commented 0
+::
+ class Rating(models.Model):
+ rating = models.IntegerField()
+ object_id = models.IntegerField()
+ content_type = models.ForeignKey(ContentType)
+ content_object = GenericForeignKey(ct_field='content_type', fk_field='object_id')
+
+ class Food(models.Model):
+ name = models.CharField(max_length=50)
+ ratings = generic.GenericRelation(Rating) # reverse generic relation
-You want to figure out which items are highest rated::
- from django.db.models import Sum, Avg
+You want to figure out which items are highest rated (generic_annotate)
- # assume a Food model and a generic Rating model
- apple = Food.objects.create(name='apple')
+::
+
+ from django.db.models import Avg
+
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_annotate(food_qs, Rating, Avg('ratings__rating'))
- # create some ratings on the food
- Rating.objects.create(content_object=apple, rating=3)
- Rating.objects.create(content_object=apple, rating=5)
- Rating.objects.create(content_object=apple, rating=7)
+ # you can mix and match queryset / model
+ generic_annotate(food_qs, Rating.objects.all(), Avg('ratings__rating'))
+
+You want the average rating for all foods that start with 'a' (generic_aggregate)
+
+::
+
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_aggregate(food_qs, Rating, Avg('ratings__rating'))
- >>> aggregate = generic_aggregate(Food, Rating, Sum('ratings__rating'))
- >>> print aggregate
- 15
+You want to only display ratings for foods that start with 'a' (generic_filter)
- >>> aggregate = generic_aggregate(Food, Rating.objects.all(), Avg('ratings__rating'))
- >>> print aggregate
- 5
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_filter(Rating.objects.all(), food_qs)
-You want to only display ratings for comments made on a given site:
- >>> from django.contrib.comments.models import Comment
- >>> from generic_aggregation import generic_filter
- >>> ratings = Rating.objects.all() # <--- grab all the ratings
- >>> comments = Comment.objects.filter(site=Site.objects.get_current())
- >>> siteified_ratings = generic_filter(ratings, comments)
+documentation
+-------------
-Check the tests - there are more examples there. Tested with postgres & sqlite
+http://django-generic-aggregation.readthedocs.org/
View
153 docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-generic-aggregation.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-generic-aggregation.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/django-generic-aggregation"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-generic-aggregation"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
View
242 docs/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# django-generic-aggregation documentation build configuration file, created by
+# sphinx-quickstart on Wed May 2 16:49:11 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-generic-aggregation'
+copyright = u'2012, charles leifer'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.3.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-generic-aggregationdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'django-generic-aggregation.tex', u'django-generic-aggregation Documentation',
+ u'charles leifer', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'django-generic-aggregation', u'django-generic-aggregation Documentation',
+ [u'charles leifer'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'django-generic-aggregation', u'django-generic-aggregation Documentation',
+ u'charles leifer', 'django-generic-aggregation', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
View
195 docs/index.rst
@@ -0,0 +1,195 @@
+.. django-generic-aggregation documentation master file, created by
+ sphinx-quickstart on Wed May 2 16:49:11 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+==========================
+django-generic-aggregation
+==========================
+
+annotate() and aggregate() for generically-related data. also a handy function
+for filtering GFK-model querysets.
+
+.. note::
+ Use django's `GenericRelation <https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/#reverse-generic-relations>`_ where possible,
+ as this can make the queries generated more efficient by using a JOIN rather
+ than a subquery.
+
+
+installation
+------------
+
+::
+
+ # install from pypi
+ pip install django-generic-aggregation
+
+ # or install via git
+ pip install -e git+git://github.com/coleifer/django-generic-aggregation.git#egg=generic_aggregation
+
+
+examples
+--------
+
+The examples below assume the following simple models:
+
+.. code-block:: python
+
+ class Rating(models.Model):
+ rating = models.IntegerField()
+ object_id = models.IntegerField()
+ content_type = models.ForeignKey(ContentType)
+ content_object = GenericForeignKey(ct_field='content_type', fk_field='object_id')
+
+ class Food(models.Model):
+ name = models.CharField(max_length=50)
+ ratings = generic.GenericRelation(Rating) # reverse generic relation
+
+
+You want to figure out which items are highest rated (:py:func:`~generic_aggregation.generic_annotate`)
+
+.. code-block:: python
+
+ from django.db.models import Avg
+
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_annotate(food_qs, Rating, Avg('ratings__rating'))
+
+ # you can mix and match queryset / model
+ generic_annotate(food_qs, Rating.objects.all(), Avg('ratings__rating'))
+
+You want the average rating for all foods that start with 'a' (:py:func:`~generic_aggregation.generic_aggregate`)
+
+.. code-block:: python
+
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_aggregate(food_qs, Rating, Avg('ratings__rating'))
+
+You want to only display ratings for foods that start with 'a' (:py:func:`~generic_aggregation.generic_filter`)
+
+ food_qs = Food.objects.filter(name__startswith='a')
+ generic_filter(Rating.objects.all(), food_qs)
+
+
+important detail
+----------------
+
+As you may have noted in the above examples (at least those using annotate and
+aggregate), the aggregate we pass in is prefixed with ``ratings__``. The double-underscore
+prefix refers to the ``ratings`` attribute of the Food model, which is a
+``django.contrib.contenttypes.generic.GenericRelation`` instance. We are querying
+*across* that relation to the field on the Ratings model that we are interested in.
+When possible, use a GenericRelation and construct your queries in this manner.
+
+If you do not have a GenericRelation on the model being queried, it will use
+a "fallback" method that will return the correct results, though queried in a slightly
+different manner (a subquery will be used as opposed to a left outer join).
+
+If for some reason the Generic Foreign Key's "object_id" field is of a different
+type than the Primary Key of the related model -- which is probably the case if you're
+using django.contrib.comments, as it uses a TextField -- a ``CAST`` expression is
+required by some RDBMS'. Django will not put it there for you, so again, the
+code will use the "fallback" methods in this case, which add the necessary ``CAST``.
+
+`View the code <https://github.com/coleifer/django-generic-aggregation/>`_ for the nitty-gritty details.
+
+
+api
+---
+
+.. py:module:: generic_aggregation
+
+.. py:function:: generic_annotate(qs_model, generic_qs_model, aggregator[, gfk_field=None[, alias='score']])
+
+ Find blog entries with the most comments:
+
+ .. code-block:: python
+
+ qs = generic_annotate(Entry.objects.public(), Comment.objects.public(), Count('comments__id'))
+ for entry in qs:
+ print entry.title, entry.score
+
+ Find the highest rated foods:
+
+ .. code-block:: python
+
+ generic_annotate(Food, Rating, Avg('ratings__rating'), alias='avg')
+ for food in qs:
+ print food.name, '- average rating:', food.avg
+
+ .. note::
+ In both of the above examples it is assumed that a GenericRelation exists
+ on Entry to Comment (named "comments") and also on Food to Rating (named "ratings").
+ If a GenericRelation does *not* exist, the query will still return correct
+ results but the code path will be different as it will use the fallback method.
+
+ .. warning::
+ If the underlying column type differs between the qs_model's primary
+ key and the generic_qs_model's foreign key column, it will use the fallback
+ method, which can correctly CASTself.
+
+ :param qs_model: A model or a queryset of objects you want to perform
+ annotation on, e.g. blog entries
+ :param generic_qs_model: A model or queryset containing a GFK, e.g. comments
+ :param aggregator: an aggregation, from django.db.models, e.g. Count('id') or Avg('rating')
+ :param gfk_field: explicitly specify the field w/the gfk
+ :param alias: attribute name to use for annotation
+ :rtype: a queryset containing annotate rows
+
+.. py:function:: generic_aggregate(qs_model, generic_qs_model, aggregator[, gfk_field=None])
+
+ Find total number of comments on blog entries:
+
+ .. code-block:: python
+
+ generic_aggregate(Entry.objects.public(), Comment.objects.public(), Count('comments__id'))
+
+ Find the average rating for foods starting with 'a':
+
+ .. code-block:: python
+
+ a_foods = Food.objects.filter(name__startswith='a')
+ generic_aggregate(a_foods, Rating, Avg('ratings__rating'))
+
+ .. note::
+ In both of the above examples it is assumed that a GenericRelation exists
+ on Entry to Comment (named "comments") and also on Food to Rating (named "ratings").
+ If a GenericRelation does *not* exist, the query will still return correct
+ results but the code path will be different as it will use the fallback method.
+
+ .. warning::
+ If the underlying column type differs between the qs_model's primary
+ key and the generic_qs_model's foreign key column, it will use the fallback
+ method, which can correctly CASTself.
+
+ :param qs_model: A model or a queryset of objects you want to perform
+ annotation on, e.g. blog entries
+ :param generic_qs_model: A model or queryset containing a GFK, e.g. comments
+ :param aggregator: an aggregation, from django.db.models, e.g. Count('id') or Avg('rating')
+ :param gfk_field: explicitly specify the field w/the gfk
+ :rtype: a scalar value indicating the result of the aggregation
+
+.. py:function:: generic_filter(generic_qs_model, filter_qs_model[, gfk_field=None])
+
+ Only show me ratings made on foods that start with "a":
+
+ a_foods = Food.objects.filter(name__startswith='a')
+ generic_filter(Rating.objects.all(), a_foods)
+
+ Only show me comments from entries that are marked as public:
+
+ generic_filter(Comment.objects.public(), Entry.objects.public())
+
+ :param generic_qs_model: A model or queryset containing a GFK, e.g. comments
+ :param qs_model: A model or a queryset of objects you want to restrict the generic_qs to
+ :param gfk_field: explicitly specify the field w/the gfk
+ :rtype: a filtered queryset
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
View
190 docs/make.bat
@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-generic-aggregation.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-generic-aggregation.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
View
81 generic_aggregation/utils.py
@@ -68,24 +68,35 @@ def prepare_query(qs_model, generic_qs_model, aggregator, gfk_field):
def generic_annotate(qs_model, generic_qs_model, aggregator, gfk_field=None, alias='score'):
"""
+ Find blog entries with the most comments:
+
+ qs = generic_annotate(Entry.objects.public(), Comment.objects.public(), Count('comments__id'))
+ for entry in qs:
+ print entry.title, entry.score
+
+ Find the highest rated foods:
+
+ generic_annotate(Food, Rating, Avg('ratings__rating'), alias='avg')
+ for food in qs:
+ print food.name, '- average rating:', food.avg
+
+ .. note::
+ In both of the above examples it is assumed that a GenericRelation exists
+ on Entry to Comment (named "comments") and also on Food to Rating (named "ratings").
+ If a GenericRelation does *not* exist, the query will still return correct
+ results but the code path will be different as it will use the fallback method.
+
+ .. warning::
+ If the underlying column type differs between the qs_model's primary
+ key and the generic_qs_model's foreign key column, it will use the fallback
+ method, which can correctly CASTself.
+
:param qs_model: A model or a queryset of objects you want to perform
annotation on, e.g. blog entries
:param generic_qs_model: A model or queryset containing a GFK, e.g. comments
:param aggregator: an aggregation, from django.db.models, e.g. Count('id') or Avg('rating')
:param gfk_field: explicitly specify the field w/the gfk
:param alias: attribute name to use for annotation
-
- Note:
- requires presence of a GenericRelation() on the qs_model, which should
- be referenced in the aggregator function
-
- Warning:
- if the primary key field differs in type from the GFK's fk_field a CAST
- is not expressed on the JOIN, so the code will fallback gracefully
-
- Example:
-
- generic_annotate(Food.objects.all(), Rating.objects.all(), Avg('ratings__rating'))
"""
prepared_query = prepare_query(qs_model, generic_qs_model, aggregator, gfk_field)
if prepared_query is not False:
@@ -97,23 +108,31 @@ def generic_annotate(qs_model, generic_qs_model, aggregator, gfk_field=None, ali
def generic_aggregate(qs_model, generic_qs_model, aggregator, gfk_field=None):
"""
+ Find total number of comments on blog entries:
+
+ generic_aggregate(Entry.objects.public(), Comment.objects.public(), Count('comments__id'))
+
+ Find the average rating for foods starting with 'a':
+
+ a_foods = Food.objects.filter(name__startswith='a')
+ generic_aggregate(a_foods, Rating, Avg('ratings__rating'))
+
+ .. note::
+ In both of the above examples it is assumed that a GenericRelation exists
+ on Entry to Comment (named "comments") and also on Food to Rating (named "ratings").
+ If a GenericRelation does *not* exist, the query will still return correct
+ results but the code path will be different as it will use the fallback method.
+
+ .. warning::
+ If the underlying column type differs between the qs_model's primary
+ key and the generic_qs_model's foreign key column, it will use the fallback
+ method, which can correctly CASTself.
+
:param qs_model: A model or a queryset of objects you want to perform
annotation on, e.g. blog entries
:param generic_qs_model: A model or queryset containing a GFK, e.g. comments
:param aggregator: an aggregation, from django.db.models, e.g. Count('id') or Avg('rating')
:param gfk_field: explicitly specify the field w/the gfk
-
- Note:
- requires presence of a GenericRelation() on the qs_model, which should
- be referenced in the aggregator function
-
- Warning:
- if the primary key field differs in type from the GFK's fk_field a CAST
- is not expressed on the JOIN, so the code will fallback gracefully
-
- Example:
-
- generic_annotate(Food.objects.all(), Rating.objects.all(), Avg('ratings__rating'))
"""
prepared_query = prepare_query(qs_model, generic_qs_model, aggregator, gfk_field)
if prepared_query is not False:
@@ -125,8 +144,18 @@ def generic_aggregate(qs_model, generic_qs_model, aggregator, gfk_field=None):
def generic_filter(generic_qs_model, filter_qs_model, gfk_field=None):
"""
- Filter a queryset of objects containing GFKs so that they are restricted to
- only those objects that relate to items in the filter queryset
+ Only show me ratings made on foods that start with "a":
+
+ a_foods = Food.objects.filter(name__startswith='a')
+ generic_filter(Rating.objects.all(), a_foods)
+
+ Only show me comments from entries that are marked as public:
+
+ generic_filter(Comment.objects.public(), Entry.objects.public())
+
+ :param generic_qs_model: A model or queryset containing a GFK, e.g. comments
+ :param qs_model: A model or a queryset of objects you want to restrict the generic_qs to
+ :param gfk_field: explicitly specify the field w/the gfk
"""
generic_qs = normalize_qs_model(generic_qs_model)
filter_qs = normalize_qs_model(filter_qs_model)
Please sign in to comment.
Something went wrong with that request. Please try again.