Merge lp:~leonardr/lazr.restful/grok-django into lp:lazr.restful

[Leonard Richardson]

[Leonard Richardson (leonardr)]

This branch removes almost all ZCML directives from django.zcml, replacing it with grok directives. Two things are worth mentioning:

1. I added a location_interface argument to the AbsoluteURLGrokker. Django apps use IDjangoLocation instead of ILocation.

2. I renamed lazr.restful.frameworks.django to lazr.restful.frameworks.restful_django. This is because I couldn't import django.foo from within django.py: it was masking the real "django" model. If there's any way around this I'd like to know about it.

[Celso Providelo (cprov)]

Leonard,

Grok directives to replace ZCML work gracefully, thanks for using them.

Gary, has pointed that we could use __import__ from 2.4 for importing django, then when 2.4 support dies we could use 2.5 and higher absolute/relative import behavior [1]

If it works fine, I think it's better than renaming the file.

[1] http://docs.python.org/whatsnew/2.5.html#pep-328-absolute-and-relative-imports

Other than that it's great, let's see it in action. Great job!

review: Approve (code)

=== modified file 'src/lazr/restful/directives/__init__.py'
--- src/lazr/restful/directives/__init__.py	2009-09-03 14:10:38 +0000
+++ src/lazr/restful/directives/__init__.py	2009-09-03 17:31:27 +0000
@@ -104,6 +104,16 @@
         return True
 
 
+class location_interface(martian.Directive):
+    """Directive to specify the location interface.
+
+    The default is zope.location.interfaces.ILocation
+    """
+    scope = martian.CLASS
+    store = martian.ONCE
+    default = ILocation
+
+
 class AbsoluteURLGrokker(martian.ClassGrokker):
     """Registers a strategy for generating an object's URL.
 
@@ -111,7 +121,8 @@
     AbsoluteURL.
     """
     martian.component(AbsoluteURL)
-    def execute(self, cls, config, *kw):
+    martian.directive(location_interface)
+    def execute(self, cls, config, location_interface, *kw):
         getSiteManager().registerAdapter(
-            cls, (ILocation, IWebServiceLayer), IAbsoluteURL)
+            cls, (location_interface, IWebServiceLayer), IAbsoluteURL)
         return True

=== modified file 'src/lazr/restful/docs/django.txt'
--- src/lazr/restful/docs/django.txt	2009-08-19 17:03:30 +0000
+++ src/lazr/restful/docs/django.txt	2009-09-03 17:31:27 +0000
@@ -97,7 +97,7 @@
 Now here's a subordinate resource that just implements IDjangoLocatino.
 
     >>> from zope.interface import implements
-    >>> from lazr.restful.frameworks.django import IDjangoLocation
+    >>> from lazr.restful.frameworks.restful_django import IDjangoLocation
     >>> class SubordinateResource:
     ...     implements(IDjangoLocation)
     ...
@@ -179,7 +179,7 @@
 The adapter class is ManagerSequencer.
 
     >>> sequence
-    <lazr.restful.frameworks.django.ManagerSequencer...>
+    <lazr.restful.frameworks.restful_django.ManagerSequencer...>
 
 A ManagerSequencer object makes a Manager object act like a Python
 list, which is what IFiniteSequence needs.

=== modified file 'src/lazr/restful/frameworks/django.zcml'
--- src/lazr/restful/frameworks/django.zcml	2009-08-19 13:52:39 +0000
+++ src/lazr/restful/frameworks/django.zcml	2009-09-03 17:31:27 +0000
@@ -1,45 +1,4 @@
 <!-- -*- xml -*- -->
-<configure xmlns="http://namespaces.zope.org/zope">
-
-  <!--A Django model object can't implement ILocation, because its
-      metaclass prohibits us from defining the property __name__. We
-      suggest implementing IDjangoLocation (which uses __url_path__
-      instead of __name__), and define this adapter from
-      IDjangoLocation to ILocation.-->
-  <adapter
-     for="lazr.restful.frameworks.django.IDjangoLocation"
-     provides="zope.location.interfaces.ILocation"
-     factory="lazr.restful.frameworks.django.DjangoLocation" />
-
-  <!--A class that implements IDjangoLocation can have a URL generated
-      for it with Zope's standard AbsoluteURL class.-->
-  <adapter
-      for="lazr.restful.frameworks.django.IDjangoLocation
-           lazr.restful.interfaces.IWebServiceClientRequest"
-      provides="zope.traversing.browser.interfaces.IAbsoluteURL"
-      factory="zope.traversing.browser.absoluteurl.AbsoluteURL"
-      />
-
-  <!--We want a raised django.core.exceptions.ObjectDoesNotExist
-      object to result in a 404 status code. But we don't
-      control that class definition, so we can't annotate it.
-      Instead, we define an adapter from that exception class to the
-      NotFoundView.-->
-  <adapter
-      for="django.core.exceptions.ObjectDoesNotExist
-           lazr.restful.interfaces.IWebServiceClientRequest"
-      provides="zope.interface.Interface"
-      factory="lazr.restful.error.NotFoundView"
-      name="index.html"
-      />
-
-  <!--What lazr.restful calls scoped collections (collections that are
-      fetched relative to a particular entry, such as a cookbook's
-      recipes) are handled in Django by Manager objects. By adapting
-      Managers to Zope's IFiniteSequence interface, we can batch their
-      data without having to change the Django side of things. -->
-  <adapter for="django.db.models.manager.Manager"
-           provides="zope.interface.common.sequence.IFiniteSequence"
-           factory="lazr.restful.frameworks.django.ManagerSequencer" />
-
+<configure xmlns:grok="http://namespaces.zope.org/grok">
+  <grok:grok package="lazr.restful.frameworks.restful_django" />
 </configure>

=== renamed file 'src/lazr/restful/frameworks/django.py' => 'src/lazr/restful/frameworks/restful_django.py'
--- src/lazr/restful/frameworks/django.py	2009-08-19 17:03:30 +0000
+++ src/lazr/restful/frameworks/restful_django.py	2009-09-03 17:31:27 +0000
@@ -12,6 +12,17 @@
 from zope.interface import Interface, implements
 from zope.interface.common.sequence import IFiniteSequence
 from zope.location.interfaces import ILocation
+from zope.traversing.browser.interfaces import IAbsoluteURL
+from zope.traversing.browser.absoluteurl import AbsoluteURL
+
+import grokcore.component
+from django.core.exceptions import ObjectDoesNotExist
+from django.db.models.manager import Manager
+
+from lazr.restful import directives
+from lazr.restful.interfaces import (
+    IWebServiceLayer, IWebServiceClientRequest)
+from lazr.restful.error import NotFoundView
 
 
 class IDjangoLocation(Interface):
@@ -28,6 +39,20 @@
     def __parent__(self):
         """This object's parent in the object tree."""
 
+# We want a raised django.core.exceptions.ObjectDoesNotExist
+# object to result in a 404 status code. But we don't
+# control that class definition, so we can't annotate it.
+# Instead, we define an adapter from that exception class to the
+# NotFoundView
+grokcore.component.global_adapter(
+    NotFoundView, (ObjectDoesNotExist, IWebServiceClientRequest),
+    Interface, name="index.html")
+
+
+class DjangoAbsoluteURL(AbsoluteURL):
+    """An AbsoluteURL implementation for Django."""
+    directives.location_interface(IDjangoLocation)
+
 
 class DjangoLocation(object):
     """Adapts Django model objects to ILocation.
@@ -47,6 +72,7 @@
     @property
     def __name__(self):
         return self.context.__url_path__
+grokcore.component.global_adapter(DjangoLocation, IDjangoLocation, ILocation)
 
 
 class ManagerSequencer(object):
@@ -72,3 +98,4 @@
     def __len__(self):
         """Return the length of the dataset."""
         return self.manager.count()
+grokcore.component.global_adapter(ManagerSequencer, Manager, IFiniteSequence)