Merge lp:~salgado/lazr.restful/extension-interfaces into lp:lazr.restful
- extension-interfaces
- Merge into trunk
| Status: | Merged |
|---|---|
| Approved by: | Gary Poster |
| Approved revision: | 154 |
| Merged at revision: | 135 |
| Proposed branch: | lp:~salgado/lazr.restful/extension-interfaces |
| Merge into: | lp:lazr.restful |
| Diff against target: |
1498 lines (+792/-121) 16 files modified
src/lazr/restful/NEWS.txt (+10/-0) src/lazr/restful/_resource.py (+14/-13) src/lazr/restful/declarations.py (+70/-32) src/lazr/restful/docs/multiversion.txt (+15/-0) src/lazr/restful/docs/webservice-declarations.txt (+65/-59) src/lazr/restful/docs/webservice.txt (+28/-0) src/lazr/restful/example/base/tests/test_integration.py (+1/-0) src/lazr/restful/example/base_extended/README.txt (+22/-0) src/lazr/restful/example/base_extended/__init__.py (+3/-0) src/lazr/restful/example/base_extended/comments.py (+32/-0) src/lazr/restful/example/base_extended/site.zcml (+18/-0) src/lazr/restful/example/base_extended/tests/test_integration.py (+38/-0) src/lazr/restful/metazcml.py (+95/-16) src/lazr/restful/testing/helpers.py (+45/-0) src/lazr/restful/tests/test_declarations.py (+335/-0) src/lazr/restful/version.txt (+1/-1) |
| To merge this branch: | bzr merge lp:~salgado/lazr.restful/extension-interfaces |
| Related bugs: |
| Reviewer | Review Type | Date Requested | Status |
|---|---|---|---|
| Gary Poster | Approve | ||
| Leonard Richardson (community) | Needs Fixing | ||
|
Review via email:
|
|||
Commit message
Description of the change
This branch makes it possible to extend webservice entries by marking certain interfaces as extensions to others. It's still a work in progress and I'm proposing the merge just to get feedback on the design and desirability of such feature.
With the current design you just decorate extension interfaces with the regular @export_
That will just store the list of extended interfaces as an annotation on the interface.
That list of extended interfaces is then picked up by the code which generates the webservice interfaces/
Since the extension interfaces are usually not provided directly by the content classes (they are provided through an adapter), the webservice adapters would have to adapt the content objects into the extension interface when accessing a field that actually comes from one such interface. However, when accessing fields that come from the content interface, such adaptation wouldn't be necessary (as the content object is supposed to provide the content interface). To simplify things, though, I've changed the webservice adapters to always adapt the content object into the field's originating interface.
https:/
| Leonard Richardson (leonardr) wrote : | # |
| Guilherme Salgado (salgado) wrote : | # |
On Fri, 2010-07-16 at 15:36 +0000, Leonard Richardson wrote:
> This branch is slow going but I have one suggestion. Can you test this assertion?
>
> + assert name in orig_iface, (
> + "Could not find interface where %s is defined" % name)
>
> I don't see how it could be triggered. But maye the point is that it never is triggered?
As we discussed at the Epic, I don't think we can trigger that assertion
without introducing a bug somewhere.
--
Guilherme Salgado <https:/
| Gary Poster (gary) wrote : | # |
I've done a non-exhaustive review (as a supplement to Leonard's not a replacement), and want to share my comments so far.
Requests:
- This is an important new feature for lazr.restful, and I don't see any instructions on how to use it. Could you add some documentation (doctest) to the example webservice part of the package? (As a small corollary, we'll want to mention something in the CHANGES/NEWS file.)
- I see that find_interfaces
Suggestions:
- for the new argument name, "contributes_to" -> "extends"? Take it only if you like it, but it matches nicely with "extensions," which you use later, for instance. If you do this, you'd want to change "contributors" to "extenders," I suspect.
| Guilherme Salgado (salgado) wrote : | # |
On Wed, 2010-07-21 at 20:27 +0000, Gary Poster wrote:
> I've done a non-exhaustive review (as a supplement to Leonard's not a
> replacement), and want to share my comments so far.
Cool, thanks!
>
> Requests:
>
> - This is an important new feature for lazr.restful, and I don't see
> any instructions on how to use it. Could you add some documentation
> (doctest) to the example webservice part of the package? (As a small
> corollary, we'll want to mention something in the CHANGES/NEWS file.)
Indeed, and I also think it would be worth mentioning it in
docs/webservice
>
> - I see that find_interfaces
> raising ConflictInContr
> these errors are as helpful as they can be. Right now the exception
> just has the name and the base interface that has been modified. I'd
> also like to see the two or more interfaces that have created the
> conflict--and I'd like a test that shows that a traceback with this
> error gives the developer a nice error message telling what's gone
> wrong and where to look to address it. (A unit test of the error's
> __str__ should be sufficient.)
Something like http://
show the error message in one of the existing unit tests?
>
> Suggestions:
>
> - for the new argument name, "contributes_to" -> "extends"? Take it
> only if you like it, but it matches nicely with "extensions," which
> you use later, for instance. If you do this, you'd want to change
> "contributors" to "extenders," I suspect.
Heh, extends is exactly what I used in the first round but after I
showed it to Leonard he suggested contributes_to. I guess I'll keep
this in mind and see if he has any other suggestions.
Cheers,
--
Guilherme Salgado <https:/
| Gary Poster (gary) wrote : | # |
On Jul 22, 2010, at 6:28 AM, Guilherme Salgado wrote:
> On Wed, 2010-07-21 at 20:27 +0000, Gary Poster wrote:
>> I've done a non-exhaustive review (as a supplement to Leonard's not a
>> replacement), and want to share my comments so far.
>
> Cool, thanks!
>
>>
>> Requests:
>>
>> - This is an important new feature for lazr.restful, and I don't see
>> any instructions on how to use it. Could you add some documentation
>> (doctest) to the example webservice part of the package? (As a small
>> corollary, we'll want to mention something in the CHANGES/NEWS file.)
>
> Indeed, and I also think it would be worth mentioning it in
> docs/webservice
+1
>
>>
>> - I see that find_interfaces
>> raising ConflictInContr
>> these errors are as helpful as they can be. Right now the exception
>> just has the name and the base interface that has been modified. I'd
>> also like to see the two or more interfaces that have created the
>> conflict--and I'd like a test that shows that a traceback with this
>> error gives the developer a nice error message telling what's gone
>> wrong and where to look to address it. (A unit test of the error's
>> __str__ should be sufficient.)
>
> Something like http://
> show the error message in one of the existing unit tests?
Looks perfect, thank you.
>
>>
>> Suggestions:
>>
>> - for the new argument name, "contributes_to" -> "extends"? Take it
>> only if you like it, but it matches nicely with "extensions," which
>> you use later, for instance. If you do this, you'd want to change
>> "contributors" to "extenders," I suspect.
>
> Heh, extends is exactly what I used in the first round but after I
> showed it to Leonard he suggested contributes_to. I guess I'll keep
> this in mind and see if he has any other suggestions.
Understood.
Leonard will not be back today. I'll discuss on IRC how we should proceed.
Gary
| Leonard Richardson (leonardr) wrote : | # |
I didn't like "extends" for two reasons. First, "Foo extends bar" implies that 'foo' derives from 'bar', where as in this case 'bar' derives from 'foo'. Second, "extends" already means something in object-oriented programming and I didn't want to overload the term.
This is really good, almost ready to land. Comments:
I second Gary's suggestion about ConflictInContr
You still need to describe this change in the NEWS file.
I don't know how useful that TestWebServiceC
I would like to see this feature used in an example web service (ie. added to examples/base or in a totally new web service of your design). This is less for purposes of test coverage and more to show how the feature would work in a real situation.
Lines 802 and 803 are the same.
Some of your tests are missing explanatory comments. The stub classes like Product need to have docstrings saying things like "A stub class that publishes one string field and one read operation."
- 145. By Guilherme Salgado
-
Improve the ConflictInContr
ibutingInterfac es exception to state what interfaces contain the conflicting attributes - 146. By Guilherme Salgado
-
Add new entry to NEWS.txt
| Guilherme Salgado (salgado) wrote : | # |
On Tue, 2010-07-27 at 19:06 +0000, Leonard Richardson wrote:
> Review: Needs Fixing
> I didn't like "extends" for two reasons. First, "Foo extends bar"
> implies that 'foo' derives from 'bar', where as in this case 'bar'
> derives from 'foo'. Second, "extends" already means something in
> object-oriented programming and I didn't want to overload the term.
>
> This is really good, almost ready to land. Comments:
>
> I second Gary's suggestion about ConflictInContr
> think your patch looks good.
Cool.
>
> You still need to describe this change in the NEWS file.
Done; please let me know if it looks good.
>
> I don't know how useful that TestWebServiceC
> is, but it's fine since oyu use it twice. The register_module
> refactoring is a great idea.
>
> I would like to see this feature used in an example web service (ie.
> added to examples/base or in a totally new web service of your
> design). This is less for purposes of test coverage and more to show
> how the feature would work in a real situation.
I moved some things in examples/base to make use of the new feature
(http://
use it like that in a simple interface. In fact, since the need for
this feature came from us wanting to split the implementation of some
very complex classes into smaller ones, I find it hard to think of a
good yet short example to use here. Maybe you have an idea?
While doing this I've found a bug that was causing the generated
webservice interfaces to use the doc/name of extension interfaces
instead of those from the main interface.
http://
>
> Lines 802 and 803 are the same.
Not really; one of them registers ProductToHasBugs and the other
ProjectToHasBugs
>
> Some of your tests are missing explanatory comments. The stub classes
Good catch; I've just added them.
> like Product need to have docstrings saying things like "A stub class
> that publishes one string field and one read operation."
I'm not sure where to add such docstrings as the stub class really is
Product but the one that publishes things is IProduct. Also, I don't
think a docstring like that adds any value, but I could add them if you
feel strong about it.
--
Guilherme Salgado <https:/
- 147. By Guilherme Salgado
-
Some comments/docstrings on tests
- 148. By Guilherme Salgado
-
Fix a bug in generate_
entry_interface s that was causing the generated webservice interfaces to use the doc/name of extension interfaces instead of those from the main interface - 149. By Guilherme Salgado
-
Document contributing interfaces in webservice-
declarations. txt, rename a couple remaining variables from extensions to contributors and add a unit test to show that contributing interfaces are not exported by themselves
| Guilherme Salgado (salgado) wrote : | # |
Other than the things I'd mentioned in my previous comment, I also added a new unit test to show that contributing interfaces are not exported by themselves together with a short explanation of contributing interfaces on webservice-
| Gary Poster (gary) wrote : | # |
This is really a very nice branch. Thank you.
I hate to not give it a final go-ahead, but I do have one last request.
= Requests =
You said:
> Leonard said:
> > I would like to see this feature used in an example web service (ie.
> > added to examples/base or in a totally new web service of your
> > design). This is less for purposes of test coverage and more to show
> > how the feature would work in a real situation.
>
> I moved some things in examples/base to make use of the new feature
> (http://
> use it like that in a simple interface. In fact, since the need for
> this feature came from us wanting to split the implementation of some
> very complex classes into smaller ones, I find it hard to think of a
> good yet short example to use here. Maybe you have an idea?
I'd argue that the central story is reuse. That reuse might be to factor out a simpler webservice that can be reused elsewhere (which is actually what is driving your work, AIUI) or it might be to extend a simpler webservice (which you might end up doing as well). I think you could easily explain a change in this way.
If you didn't already have an example, I might try to think up some scenario, like another branch of a company that wanted to add, say, the idea of a recipe contributor, or wanted to add the idea of favorite recipes or recipe ratings. That particular idea might be undesirable for the imaginary people using the base website.
What you have already might work though. While it's hard to imagine someone not wanting search, perhaps other teams have a more complicated search method. You are sharing/reusing the base webservice, and you just want to implement a very simple search. The other team works from the same base code, but extends the cookbook with a much more complex search method that also incorporates ideas that you don't need and don't want, like contributors, favorites, and/or ratings.
Can you use your patch and then add an explanation with an imaginary scenario like the one I gave above?
= Small suggestions =
In generate_
= Thoughts =
AFAICT, saying that an exported interface contributes to another interface effectively exports that other interface even if it were not initially marked to be exported. I don't love that, but I don't think it is a big deal, and I'm not going to worry about it.
Product docstrings: I'm fine with leaving them out as you suggest.
NEWS looks good. Thank you!
- 150. By Guilherme Salgado
-
Turn a set() into a list() as we didn't seem to need a set there.
- 151. By Guilherme Salgado
-
Raise a meaningful exception when an interface contributes to another interface which is not exported
| Guilherme Salgado (salgado) wrote : | # |
On Tue, 2010-08-03 at 18:11 +0000, Gary Poster wrote:
> This is really a very nice branch. Thank you.
>
> I hate to not give it a final go-ahead, but I do have one last request.
>
> = Requests =
>
> You said:
> > Leonard said:
> > > I would like to see this feature used in an example web service (ie.
> > > added to examples/base or in a totally new web service of your
> > > design). This is less for purposes of test coverage and more to show
> > > how the feature would work in a real situation.
> >
> > I moved some things in examples/base to make use of the new feature
> > (http://
> > use it like that in a simple interface. In fact, since the need for
> > this feature came from us wanting to split the implementation of some
> > very complex classes into smaller ones, I find it hard to think of a
> > good yet short example to use here. Maybe you have an idea?
>
> I'd argue that the central story is reuse. That reuse might be to
> factor out a simpler webservice that can be reused elsewhere (which is
> actually what is driving your work, AIUI) or it might be to extend a
> simpler webservice (which you might end up doing as well). I think
> you could easily explain a change in this way.
Well, what we really want is to be able to move attributes/methods out
of existing interfaces and into adapters while still publicizing a
single entry comprising what's exported by the changed interface and all
of its adapters. For the reuse story one can use mix-ins as long as
it's ok to have the exported interface inherit from a bunch of others
(as we currently do).
>
> If you didn't already have an example, I might try to think up some
> scenario, like another branch of a company that wanted to add, say,
> the idea of a recipe contributor, or wanted to add the idea of
> favorite recipes or recipe ratings. That particular idea might be
> undesirable for the imaginary people using the base website.
>
> What you have already might work though. While it's hard to imagine
> someone not wanting search, perhaps other teams have a more
> complicated search method. You are sharing/reusing the base
> webservice, and you just want to implement a very simple search. The
> other team works from the same base code, but extends the cookbook
> with a much more complex search method that also incorporates ideas
> that you don't need and don't want, like contributors, favorites,
> and/or ratings.
>
After letting this marinate on my head for a while longer, I thought of
creating an IHasComments interface that contributes a 'comments'
attribute to IRecipe, as if there was a separate web service which wants
to allow its users to comment on recipes
(http://
I've also modified one of the tests for the base example to show the
comments, but that uncovered a bug in the current implementation:
EntryResource.
the IRecipe object directly instead of through its IHasComments adapter,
and that causes a ForbiddenAttribute. I think I could change
redacted_fields to adapt the context into the field'...
| Guilherme Salgado (salgado) wrote : | # |
http://
| Gary Poster (gary) wrote : | # |
On Aug 3, 2010, at 5:46 PM, Guilherme Salgado wrote:
> On Tue, 2010-08-03 at 18:11 +0000, Gary Poster wrote:
>> This is really a very nice branch. Thank you.
>>
>> I hate to not give it a final go-ahead, but I do have one last request.
>>
>> = Requests =
>>
>> You said:
>>> Leonard said:
>>>> I would like to see this feature used in an example web service (ie.
>>>> added to examples/base or in a totally new web service of your
>>>> design). This is less for purposes of test coverage and more to show
>>>> how the feature would work in a real situation.
>>>
>>> I moved some things in examples/base to make use of the new feature
>>> (http://
>>> use it like that in a simple interface. In fact, since the need for
>>> this feature came from us wanting to split the implementation of some
>>> very complex classes into smaller ones, I find it hard to think of a
>>> good yet short example to use here. Maybe you have an idea?
>>
>> I'd argue that the central story is reuse. That reuse might be to
>> factor out a simpler webservice that can be reused elsewhere (which is
>> actually what is driving your work, AIUI) or it might be to extend a
>> simpler webservice (which you might end up doing as well). I think
>> you could easily explain a change in this way.
>
> Well, what we really want is to be able to move attributes/methods out
> of existing interfaces and into adapters while still publicizing a
> single entry comprising what's exported by the changed interface and all
> of its adapters. For the reuse story one can use mix-ins as long as
> it's ok to have the exported interface inherit from a bunch of others
> (as we currently do).
Right, but the mix-in approach means a lot more work for small changes. I could be wrong, but with the mix-in class approach, you have to make your own separate registration of *everything* because you don't want one interface, you want another one. There are examples of this kind of annoyance in the webservice package. With your feature, you can reuse the entirety of a webservice, including its registrations, and then register your own things in addition. That's much easier.
Maybe I'm missing something, but that's how I see it right now.
>
>>
>> If you didn't already have an example, I might try to think up some
>> scenario, like another branch of a company that wanted to add, say,
>> the idea of a recipe contributor, or wanted to add the idea of
>> favorite recipes or recipe ratings. That particular idea might be
>> undesirable for the imaginary people using the base website.
>>
>> What you have already might work though. While it's hard to imagine
>> someone not wanting search, perhaps other teams have a more
>> complicated search method. You are sharing/reusing the base
>> webservice, and you just want to implement a very simple search. The
>> other team works from the same base code, but extends the cookbook
>> with a much more complex search method that also incorporates ideas
>> that you don't need and don't want, like contributors, favorites,
>> and/or ratings.
>>
>
> After letting this marinate on my head for a while long...
| Gary Poster (gary) wrote : | # |
For posterity...
On IRC I mentioned to Salgado that in http://
- 152. By Guilherme Salgado
-
Fix EntryResource.
redacted_ fields so that it doesn't assume all fields in entry.schema are directly provided by self.context
| Guilherme Salgado (salgado) wrote : | # |
On Wed, 2010-08-04 at 18:09 +0000, Gary Poster wrote:
> >
> > After letting this marinate on my head for a while longer, I thought of
> > creating an IHasComments interface that contributes a 'comments'
> > attribute to IRecipe, as if there was a separate web service which wants
> > to allow its users to comment on recipes
> > (http://
>
> I like it.
>
> You *could* show what I was just talking about above, if you wanted to, by setting up a separate webservice that added comments to the original webservice. It ought to be super easy--include the configuration of the original webservice plus your extra bits. If it's not easy then that might even be construed as a problem.
>
> But that's not a requirement for this to land.
>
I've tried that by doing the same thing that the other examples do, but
it didn't work: http://
http://
them to my branch. Any idea why it's not working?
--
Guilherme Salgado <https:/
- 153. By Guilherme Salgado
-
Fix a test which I accidentally left broken
- 154. By Guilherme Salgado
-
New example webservice extending the base one using contributing interfaces
- 155. By Guilherme Salgado
-
Fix version
Preview Diff
| 1 | === modified file 'src/lazr/restful/NEWS.txt' | |||
| 2 | --- src/lazr/restful/NEWS.txt 2010-06-14 15:29:08 +0000 | |||
| 3 | +++ src/lazr/restful/NEWS.txt 2010-08-05 14:04:50 +0000 | |||
| 4 | @@ -2,6 +2,16 @@ | |||
| 5 | 2 | NEWS for lazr.restful | 2 | NEWS for lazr.restful |
| 6 | 3 | ===================== | 3 | ===================== |
| 7 | 4 | 4 | ||
| 8 | 5 | 0.10.0 (2010-08-05) | ||
| 9 | 6 | =================== | ||
| 10 | 7 | |||
| 11 | 8 | Added the ability to mark interface A as a contributor to interface B so that | ||
| 12 | 9 | instead of publishing A separately we will add all of A's fields and | ||
| 13 | 10 | operations to the published version of B. Objects implementing B must be | ||
| 14 | 11 | adaptable into A for this to work, but lazr.restful will take care of doing | ||
| 15 | 12 | the actual adaptation before accessing fields/operations that are not directly | ||
| 16 | 13 | provided by an object. | ||
| 17 | 14 | |||
| 18 | 5 | 0.9.29 (2010-06-14) | 15 | 0.9.29 (2010-06-14) |
| 19 | 6 | =================== | 16 | =================== |
| 20 | 7 | 17 | ||
| 21 | 8 | 18 | ||
| 22 | === modified file 'src/lazr/restful/_resource.py' | |||
| 23 | --- src/lazr/restful/_resource.py 2010-06-14 15:24:20 +0000 | |||
| 24 | +++ src/lazr/restful/_resource.py 2010-08-05 14:04:50 +0000 | |||
| 25 | @@ -1488,11 +1488,7 @@ | |||
| 26 | 1488 | def redacted_fields(self): | 1488 | def redacted_fields(self): |
| 27 | 1489 | """Names the fields the current user doesn't have permission to see.""" | 1489 | """Names the fields the current user doesn't have permission to see.""" |
| 28 | 1490 | failures = [] | 1490 | failures = [] |
| 34 | 1491 | try: | 1491 | orig_interfaces = self.entry._orig_interfaces |
| 30 | 1492 | checker = getChecker(self.context) | ||
| 31 | 1493 | except TypeError: | ||
| 32 | 1494 | # There's no permission checker. | ||
| 33 | 1495 | checker = None | ||
| 35 | 1496 | for name, field in getFieldsInOrder(self.entry.schema): | 1492 | for name, field in getFieldsInOrder(self.entry.schema): |
| 36 | 1497 | try: | 1493 | try: |
| 37 | 1498 | # Can we view the field's value? We check the | 1494 | # Can we view the field's value? We check the |
| 38 | @@ -1515,15 +1511,20 @@ | |||
| 39 | 1515 | # name. Since 'original_name' is not present, assume the | 1511 | # name. Since 'original_name' is not present, assume the |
| 40 | 1516 | # names are the same. | 1512 | # names are the same. |
| 41 | 1517 | original_name = name | 1513 | original_name = name |
| 49 | 1518 | if checker is None: | 1514 | context = orig_interfaces[name](self.context) |
| 50 | 1519 | # This is more expensive than using a Zope | 1515 | try: |
| 51 | 1520 | # checker, but there is no checker, so either | 1516 | checker = getChecker(context) |
| 52 | 1521 | # there is no permission control on this object, | 1517 | except TypeError: |
| 53 | 1522 | # or permission control is implemented some other | 1518 | # This is more expensive than using a Zope checker, but |
| 54 | 1523 | # way. | 1519 | # there is no checker, so either there is no permission |
| 55 | 1524 | getattr(self.context, original_name) | 1520 | # control on this object, or permission control is |
| 56 | 1521 | # implemented some other way. Also note that we use | ||
| 57 | 1522 | # getattr() on self.entry rather than self.context because | ||
| 58 | 1523 | # some of the fields in entry.schema will be provided by | ||
| 59 | 1524 | # adapters rather than directly by self.context. | ||
| 60 | 1525 | getattr(self.entry, name) | ||
| 61 | 1525 | else: | 1526 | else: |
| 63 | 1526 | checker.check(self.context, original_name) | 1527 | checker.check(context, original_name) |
| 64 | 1527 | except Unauthorized: | 1528 | except Unauthorized: |
| 65 | 1528 | # This is an expensive operation that will make this | 1529 | # This is an expensive operation that will make this |
| 66 | 1529 | # request more expensive still, but it happens | 1530 | # request more expensive still, but it happens |
| 67 | 1530 | 1531 | ||
| 68 | === modified file 'src/lazr/restful/declarations.py' | |||
| 69 | --- src/lazr/restful/declarations.py 2010-05-07 14:02:44 +0000 | |||
| 70 | +++ src/lazr/restful/declarations.py 2010-08-05 14:04:50 +0000 | |||
| 71 | @@ -37,6 +37,7 @@ | |||
| 72 | 37 | ] | 37 | ] |
| 73 | 38 | 38 | ||
| 74 | 39 | import copy | 39 | import copy |
| 75 | 40 | import itertools | ||
| 76 | 40 | import sys | 41 | import sys |
| 77 | 41 | 42 | ||
| 78 | 42 | from zope.component import getUtility, getGlobalSiteManager | 43 | from zope.component import getUtility, getGlobalSiteManager |
| 79 | @@ -50,6 +51,7 @@ | |||
| 80 | 50 | from zope.traversing.browser import absoluteURL | 51 | from zope.traversing.browser import absoluteURL |
| 81 | 51 | 52 | ||
| 82 | 52 | from lazr.delegates import Passthrough | 53 | from lazr.delegates import Passthrough |
| 83 | 54 | |||
| 84 | 53 | from lazr.restful.fields import CollectionField, Reference | 55 | from lazr.restful.fields import CollectionField, Reference |
| 85 | 54 | from lazr.restful.interface import copy_field | 56 | from lazr.restful.interface import copy_field |
| 86 | 55 | from lazr.restful.interfaces import ( | 57 | from lazr.restful.interfaces import ( |
| 87 | @@ -114,8 +116,13 @@ | |||
| 88 | 114 | return f_locals.setdefault(TAGGED_DATA, {}) | 116 | return f_locals.setdefault(TAGGED_DATA, {}) |
| 89 | 115 | 117 | ||
| 90 | 116 | 118 | ||
| 92 | 117 | def export_as_webservice_entry(singular_name=None, plural_name=None): | 119 | def export_as_webservice_entry(singular_name=None, plural_name=None, |
| 93 | 120 | contributes_to=None): | ||
| 94 | 118 | """Mark the content interface as exported on the web service as an entry. | 121 | """Mark the content interface as exported on the web service as an entry. |
| 95 | 122 | |||
| 96 | 123 | If contributes_to is a non-empty sequence of Interfaces, this entry will | ||
| 97 | 124 | actually not be exported on its own but instead will contribute its | ||
| 98 | 125 | attributes/methods to other exported entries. | ||
| 99 | 119 | """ | 126 | """ |
| 100 | 120 | _check_called_from_interface_def('export_as_webservice_entry()') | 127 | _check_called_from_interface_def('export_as_webservice_entry()') |
| 101 | 121 | def mark_entry(interface): | 128 | def mark_entry(interface): |
| 102 | @@ -138,7 +145,7 @@ | |||
| 103 | 138 | interface.setTaggedValue( | 145 | interface.setTaggedValue( |
| 104 | 139 | LAZR_WEBSERVICE_EXPORTED, dict( | 146 | LAZR_WEBSERVICE_EXPORTED, dict( |
| 105 | 140 | type=ENTRY_TYPE, singular_name=my_singular_name, | 147 | type=ENTRY_TYPE, singular_name=my_singular_name, |
| 107 | 141 | plural_name=my_plural_name)) | 148 | plural_name=my_plural_name, contributes_to=contributes_to)) |
| 108 | 142 | 149 | ||
| 109 | 143 | # Set the name of the fields that didn't specify it using the | 150 | # Set the name of the fields that didn't specify it using the |
| 110 | 144 | # 'export_as' parameter in exported(). This must be done here, | 151 | # 'export_as' parameter in exported(). This must be done here, |
| 111 | @@ -161,8 +168,6 @@ | |||
| 112 | 161 | if tags.get('as') is None: | 168 | if tags.get('as') is None: |
| 113 | 162 | tags['as'] = name | 169 | tags['as'] = name |
| 114 | 163 | 170 | ||
| 115 | 164 | |||
| 116 | 165 | |||
| 117 | 166 | annotate_exported_methods(interface) | 171 | annotate_exported_methods(interface) |
| 118 | 167 | return interface | 172 | return interface |
| 119 | 168 | addClassAdvisor(mark_entry) | 173 | addClassAdvisor(mark_entry) |
| 120 | @@ -820,7 +825,6 @@ | |||
| 121 | 820 | method, annotation_stack) | 825 | method, annotation_stack) |
| 122 | 821 | # The mutator method must take no arguments, not counting | 826 | # The mutator method must take no arguments, not counting |
| 123 | 822 | # arguments with values fixed by call_with(). | 827 | # arguments with values fixed by call_with(). |
| 124 | 823 | signature = fromFunction(method).getSignatureInfo() | ||
| 125 | 824 | for version, annotations in annotation_stack.stack: | 828 | for version, annotations in annotation_stack.stack: |
| 126 | 825 | if annotations['type'] == REMOVED_OPERATION_TYPE: | 829 | if annotations['type'] == REMOVED_OPERATION_TYPE: |
| 127 | 826 | continue | 830 | continue |
| 128 | @@ -851,7 +855,7 @@ | |||
| 129 | 851 | "'%s' isn't exported as %s %s." % (interface.__name__, art, type)) | 855 | "'%s' isn't exported as %s %s." % (interface.__name__, art, type)) |
| 130 | 852 | 856 | ||
| 131 | 853 | 857 | ||
| 133 | 854 | def generate_entry_interfaces(interface, *versions): | 858 | def generate_entry_interfaces(interface, contributors=[], *versions): |
| 134 | 855 | """Create IEntry subinterfaces based on the tags in `interface`. | 859 | """Create IEntry subinterfaces based on the tags in `interface`. |
| 135 | 856 | 860 | ||
| 136 | 857 | :param interface: The data model interface to use as the basis | 861 | :param interface: The data model interface to use as the basis |
| 137 | @@ -890,17 +894,17 @@ | |||
| 138 | 890 | # has a set of annotations for every version. We'll make a list of | 894 | # has a set of annotations for every version. We'll make a list of |
| 139 | 891 | # the published fields, which we'll iterate over once for each | 895 | # the published fields, which we'll iterate over once for each |
| 140 | 892 | # version. | 896 | # version. |
| 141 | 893 | fields = getFields(interface).items() | ||
| 142 | 894 | tags_for_published_fields = [] | 897 | tags_for_published_fields = [] |
| 152 | 895 | for name, field in fields: | 898 | for iface in itertools.chain([interface], contributors): |
| 153 | 896 | tag_stack = field.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) | 899 | for name, field in getFields(iface).items(): |
| 154 | 897 | if tag_stack is None: | 900 | tag_stack = field.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) |
| 155 | 898 | # This field is not published at all. | 901 | if tag_stack is None: |
| 156 | 899 | continue | 902 | # This field is not published at all. |
| 157 | 900 | error_message_prefix = ( | 903 | continue |
| 158 | 901 | 'Field "%s" in interface "%s": ' % (name, interface.__name__)) | 904 | error_message_prefix = ( |
| 159 | 902 | _normalize_field_annotations(field, versions, error_message_prefix) | 905 | 'Field "%s" in interface "%s": ' % (name, iface.__name__)) |
| 160 | 903 | tags_for_published_fields.append((name, field, tag_stack.stack)) | 906 | _normalize_field_annotations(field, versions, error_message_prefix) |
| 161 | 907 | tags_for_published_fields.append((name, field, tag_stack.stack)) | ||
| 162 | 904 | 908 | ||
| 163 | 905 | generated_interfaces = [] | 909 | generated_interfaces = [] |
| 164 | 906 | for version in versions: | 910 | for version in versions: |
| 165 | @@ -930,7 +934,8 @@ | |||
| 166 | 930 | return generated_interfaces | 934 | return generated_interfaces |
| 167 | 931 | 935 | ||
| 168 | 932 | 936 | ||
| 170 | 933 | def generate_entry_adapters(content_interface, webservice_interfaces): | 937 | def generate_entry_adapters( |
| 171 | 938 | content_interface, contributors, webservice_interfaces): | ||
| 172 | 934 | """Create classes adapting from content_interface to webservice_interfaces. | 939 | """Create classes adapting from content_interface to webservice_interfaces. |
| 173 | 935 | 940 | ||
| 174 | 936 | Unlike with generate_collection_adapter and | 941 | Unlike with generate_collection_adapter and |
| 175 | @@ -950,7 +955,10 @@ | |||
| 176 | 950 | # Go through the fields and build up a picture of what this entry looks | 955 | # Go through the fields and build up a picture of what this entry looks |
| 177 | 951 | # like for every version. | 956 | # like for every version. |
| 178 | 952 | adapters_by_version = {} | 957 | adapters_by_version = {} |
| 180 | 953 | for name, field in getFields(content_interface).items(): | 958 | fields = getFields(content_interface).items() |
| 181 | 959 | for version, iface in webservice_interfaces: | ||
| 182 | 960 | fields.extend(getFields(iface).items()) | ||
| 183 | 961 | for name, field in fields: | ||
| 184 | 954 | tag_stack = field.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) | 962 | tag_stack = field.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) |
| 185 | 955 | if tag_stack is None: | 963 | if tag_stack is None: |
| 186 | 956 | continue | 964 | continue |
| 187 | @@ -967,12 +975,34 @@ | |||
| 188 | 967 | mutator, annotations = tags.get( | 975 | mutator, annotations = tags.get( |
| 189 | 968 | 'mutator_annotations', (None, {})) | 976 | 'mutator_annotations', (None, {})) |
| 190 | 969 | 977 | ||
| 191 | 978 | # Always use the field's original_name here as we've combined | ||
| 192 | 979 | # fields from the content interface with fields of the webservice | ||
| 193 | 980 | # interfaces (where they may have different names). | ||
| 194 | 981 | orig_name = tags['original_name'] | ||
| 195 | 982 | |||
| 196 | 983 | # Some fields may be provided by an adapter of the content class | ||
| 197 | 984 | # instead of being provided directly by the content class. In | ||
| 198 | 985 | # these cases we'd need to adapt the content class before trying | ||
| 199 | 986 | # to access the field, so to simplify things we always do the | ||
| 200 | 987 | # adaptation and rely on the fact that it will be a no-op when an | ||
| 201 | 988 | # we adapt an object into an interface it already provides. | ||
| 202 | 989 | orig_iface = content_interface | ||
| 203 | 990 | for contributor in contributors: | ||
| 204 | 991 | if orig_name in contributor: | ||
| 205 | 992 | orig_iface = contributor | ||
| 206 | 993 | assert orig_name in orig_iface, ( | ||
| 207 | 994 | "Could not find interface where %s is defined" % orig_name) | ||
| 208 | 970 | if mutator is None: | 995 | if mutator is None: |
| 210 | 971 | property = Passthrough(name, 'context') | 996 | prop = Passthrough(orig_name, 'context', orig_iface) |
| 211 | 972 | else: | 997 | else: |
| 215 | 973 | property = PropertyWithMutator( | 998 | prop = PropertyWithMutator( |
| 216 | 974 | name, 'context', mutator, annotations) | 999 | orig_name, 'context', mutator, annotations, orig_iface) |
| 217 | 975 | adapter_dict[tags['as']] = property | 1000 | adapter_dict[tags['as']] = prop |
| 218 | 1001 | |||
| 219 | 1002 | # A dict mapping field names to the interfaces where they came | ||
| 220 | 1003 | # from. | ||
| 221 | 1004 | orig_interfaces = adapter_dict.setdefault('_orig_interfaces', {}) | ||
| 222 | 1005 | orig_interfaces[name] = orig_iface | ||
| 223 | 976 | 1006 | ||
| 224 | 977 | adapters = [] | 1007 | adapters = [] |
| 225 | 978 | for version, webservice_interface in webservice_interfaces: | 1008 | for version, webservice_interface in webservice_interfaces: |
| 226 | @@ -1007,8 +1037,8 @@ | |||
| 227 | 1007 | class PropertyWithMutator(Passthrough): | 1037 | class PropertyWithMutator(Passthrough): |
| 228 | 1008 | """A property with a mutator method.""" | 1038 | """A property with a mutator method.""" |
| 229 | 1009 | 1039 | ||
| 232 | 1010 | def __init__(self, name, context, mutator, annotations): | 1040 | def __init__(self, name, context, mutator, annotations, adaptation): |
| 233 | 1011 | super(PropertyWithMutator, self).__init__(name, context) | 1041 | super(PropertyWithMutator, self).__init__(name, context, adaptation) |
| 234 | 1012 | self.mutator = mutator.__name__ | 1042 | self.mutator = mutator.__name__ |
| 235 | 1013 | self.annotations = annotations | 1043 | self.annotations = annotations |
| 236 | 1014 | 1044 | ||
| 237 | @@ -1016,10 +1046,13 @@ | |||
| 238 | 1016 | """Call the mutator method to set the value.""" | 1046 | """Call the mutator method to set the value.""" |
| 239 | 1017 | params = params_with_dereferenced_user( | 1047 | params = params_with_dereferenced_user( |
| 240 | 1018 | self.annotations.get('call_with', {})) | 1048 | self.annotations.get('call_with', {})) |
| 241 | 1049 | context = getattr(obj, self.contextvar) | ||
| 242 | 1050 | if self.adaptation is not None: | ||
| 243 | 1051 | context = self.adaptation(context) | ||
| 244 | 1019 | # Error checking code in mutator_for() guarantees that there | 1052 | # Error checking code in mutator_for() guarantees that there |
| 245 | 1020 | # is one and only one non-fixed parameter for the mutator | 1053 | # is one and only one non-fixed parameter for the mutator |
| 246 | 1021 | # method. | 1054 | # method. |
| 248 | 1022 | getattr(obj.context, self.mutator)(new_value, **params) | 1055 | getattr(context, self.mutator)(new_value, **params) |
| 249 | 1023 | 1056 | ||
| 250 | 1024 | 1057 | ||
| 251 | 1025 | class CollectionEntrySchema: | 1058 | class CollectionEntrySchema: |
| 252 | @@ -1093,6 +1126,9 @@ | |||
| 253 | 1093 | class BaseResourceOperationAdapter(ResourceOperation): | 1126 | class BaseResourceOperationAdapter(ResourceOperation): |
| 254 | 1094 | """Base class for generated operation adapters.""" | 1127 | """Base class for generated operation adapters.""" |
| 255 | 1095 | 1128 | ||
| 256 | 1129 | def _getMethod(self): | ||
| 257 | 1130 | return getattr(self._orig_iface(self.context), self._method_name) | ||
| 258 | 1131 | |||
| 259 | 1096 | def _getMethodParameters(self, kwargs): | 1132 | def _getMethodParameters(self, kwargs): |
| 260 | 1097 | """Return the method parameters. | 1133 | """Return the method parameters. |
| 261 | 1098 | 1134 | ||
| 262 | @@ -1128,7 +1164,7 @@ | |||
| 263 | 1128 | 'Cache-control', 'max-age=%i' | 1164 | 'Cache-control', 'max-age=%i' |
| 264 | 1129 | % self._export_info['cache_for']) | 1165 | % self._export_info['cache_for']) |
| 265 | 1130 | 1166 | ||
| 267 | 1131 | result = getattr(self.context, self._method_name)(**params) | 1167 | result = self._getMethod()(**params) |
| 268 | 1132 | return self.encodeResult(result) | 1168 | return self.encodeResult(result) |
| 269 | 1133 | 1169 | ||
| 270 | 1134 | 1170 | ||
| 271 | @@ -1142,7 +1178,7 @@ | |||
| 272 | 1142 | header to the URL to the created object. | 1178 | header to the URL to the created object. |
| 273 | 1143 | """ | 1179 | """ |
| 274 | 1144 | params = self._getMethodParameters(kwargs) | 1180 | params = self._getMethodParameters(kwargs) |
| 276 | 1145 | result = getattr(self.context, self._method_name)(**params) | 1181 | result = self._getMethod()(**params) |
| 277 | 1146 | response = self.request.response | 1182 | response = self.request.response |
| 278 | 1147 | response.setStatus(201) | 1183 | response.setStatus(201) |
| 279 | 1148 | response.setHeader('Location', absoluteURL(result, self.request)) | 1184 | response.setHeader('Location', absoluteURL(result, self.request)) |
| 280 | @@ -1194,11 +1230,13 @@ | |||
| 281 | 1194 | name = _versioned_class_name( | 1230 | name = _versioned_class_name( |
| 282 | 1195 | '%s_%s_%s' % (prefix, method.interface.__name__, tag['as']), | 1231 | '%s_%s_%s' % (prefix, method.interface.__name__, tag['as']), |
| 283 | 1196 | version) | 1232 | version) |
| 289 | 1197 | class_dict = {'params' : tuple(tag['params'].values()), | 1233 | class_dict = { |
| 290 | 1198 | 'return_type' : return_type, | 1234 | 'params': tuple(tag['params'].values()), |
| 291 | 1199 | '_export_info': tag, | 1235 | 'return_type': return_type, |
| 292 | 1200 | '_method_name': method.__name__, | 1236 | '_orig_iface': method.interface, |
| 293 | 1201 | '__doc__': method.__doc__} | 1237 | '_export_info': tag, |
| 294 | 1238 | '_method_name': method.__name__, | ||
| 295 | 1239 | '__doc__': method.__doc__} | ||
| 296 | 1202 | 1240 | ||
| 297 | 1203 | if tag['type'] == 'write_operation': | 1241 | if tag['type'] == 'write_operation': |
| 298 | 1204 | class_dict['send_modification_event'] = True | 1242 | class_dict['send_modification_event'] = True |
| 299 | 1205 | 1243 | ||
| 300 | === modified file 'src/lazr/restful/docs/multiversion.txt' | |||
| 301 | --- src/lazr/restful/docs/multiversion.txt 2010-06-03 13:01:01 +0000 | |||
| 302 | +++ src/lazr/restful/docs/multiversion.txt 2010-08-05 14:04:50 +0000 | |||
| 303 | @@ -309,6 +309,11 @@ | |||
| 304 | 309 | ... implements(IContactEntryBeta) | 309 | ... implements(IContactEntryBeta) |
| 305 | 310 | ... delegates(IContactEntryBeta) | 310 | ... delegates(IContactEntryBeta) |
| 306 | 311 | ... schema = IContactEntryBeta | 311 | ... schema = IContactEntryBeta |
| 307 | 312 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 308 | 313 | ... # create the adapters manually here, we need to do the same for | ||
| 309 | 314 | ... # this dict. | ||
| 310 | 315 | ... _orig_interfaces = { | ||
| 311 | 316 | ... 'name': IContact, 'phone': IContact, 'fax': IContact} | ||
| 312 | 312 | ... def __init__(self, context, request): | 317 | ... def __init__(self, context, request): |
| 313 | 313 | ... self.context = context | 318 | ... self.context = context |
| 314 | 314 | 319 | ||
| 315 | @@ -332,6 +337,12 @@ | |||
| 316 | 332 | ... implements(IContactEntry10) | 337 | ... implements(IContactEntry10) |
| 317 | 333 | ... delegates(IContactEntry10) | 338 | ... delegates(IContactEntry10) |
| 318 | 334 | ... schema = IContactEntry10 | 339 | ... schema = IContactEntry10 |
| 319 | 340 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 320 | 341 | ... # create the adapters manually here, we need to do the same for | ||
| 321 | 342 | ... # this dict. | ||
| 322 | 343 | ... _orig_interfaces = { | ||
| 323 | 344 | ... 'name': IContact, 'phone_number': IContact, | ||
| 324 | 345 | ... 'fax_number': IContact} | ||
| 325 | 335 | ... | 346 | ... |
| 326 | 336 | ... def __init__(self, context, request): | 347 | ... def __init__(self, context, request): |
| 327 | 337 | ... self.context = context | 348 | ... self.context = context |
| 328 | @@ -359,6 +370,10 @@ | |||
| 329 | 359 | ... implements(IContactEntryDev) | 370 | ... implements(IContactEntryDev) |
| 330 | 360 | ... delegates(IContactEntryDev) | 371 | ... delegates(IContactEntryDev) |
| 331 | 361 | ... schema = IContactEntryDev | 372 | ... schema = IContactEntryDev |
| 332 | 373 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 333 | 374 | ... # create the adapters manually here, we need to do the same for | ||
| 334 | 375 | ... # this dict. | ||
| 335 | 376 | ... _orig_interfaces = {'name': IContact, 'phone_number': IContact} | ||
| 336 | 362 | ... | 377 | ... |
| 337 | 363 | ... def __init__(self, context, request): | 378 | ... def __init__(self, context, request): |
| 338 | 364 | ... self.context = context | 379 | ... self.context = context |
| 339 | 365 | 380 | ||
| 340 | === modified file 'src/lazr/restful/docs/webservice-declarations.txt' | |||
| 341 | --- src/lazr/restful/docs/webservice-declarations.txt 2010-05-07 15:32:27 +0000 | |||
| 342 | +++ src/lazr/restful/docs/webservice-declarations.txt 2010-08-05 14:04:50 +0000 | |||
| 343 | @@ -32,7 +32,7 @@ | |||
| 344 | 32 | field, but not the inventory_number field. | 32 | field, but not the inventory_number field. |
| 345 | 33 | 33 | ||
| 346 | 34 | >>> from zope.interface import Interface | 34 | >>> from zope.interface import Interface |
| 348 | 35 | >>> from zope.schema import TextLine, Float | 35 | >>> from zope.schema import TextLine, Float, List |
| 349 | 36 | >>> from lazr.restful.declarations import ( | 36 | >>> from lazr.restful.declarations import ( |
| 350 | 37 | ... export_as_webservice_entry, exported) | 37 | ... export_as_webservice_entry, exported) |
| 351 | 38 | >>> class IBook(Interface): | 38 | >>> class IBook(Interface): |
| 352 | @@ -69,6 +69,7 @@ | |||
| 353 | 69 | ... "%s: %s" %(key, format_value(value)) | 69 | ... "%s: %s" %(key, format_value(value)) |
| 354 | 70 | ... for key, value in sorted(tag.items())) | 70 | ... for key, value in sorted(tag.items())) |
| 355 | 71 | >>> print_export_tag(IBook) | 71 | >>> print_export_tag(IBook) |
| 356 | 72 | contributes_to: None | ||
| 357 | 72 | plural_name: 'books' | 73 | plural_name: 'books' |
| 358 | 73 | singular_name: 'book' | 74 | singular_name: 'book' |
| 359 | 74 | type: 'entry' | 75 | type: 'entry' |
| 360 | @@ -774,6 +775,37 @@ | |||
| 361 | 774 | return_type: None | 775 | return_type: None |
| 362 | 775 | type: 'write_operation' | 776 | type: 'write_operation' |
| 363 | 776 | 777 | ||
| 364 | 778 | |||
| 365 | 779 | Contributing interfaces | ||
| 366 | 780 | ======================= | ||
| 367 | 781 | |||
| 368 | 782 | It is possible to mix multiple interfaces into a single exported entry. This | ||
| 369 | 783 | is specially useful when you want to export fields/methods that belong to | ||
| 370 | 784 | adapters for your entry's class instead of to the class itself. For example, | ||
| 371 | 785 | we can have an IDeveloper interface contributing to IUser. | ||
| 372 | 786 | |||
| 373 | 787 | >>> class IDeveloper(Interface): | ||
| 374 | 788 | ... export_as_webservice_entry(contributes_to=[IUser]) | ||
| 375 | 789 | ... | ||
| 376 | 790 | ... programming_languages = exported(List( | ||
| 377 | 791 | ... title=u'Programming Languages spoken by this developer')) | ||
| 378 | 792 | |||
| 379 | 793 | This will cause all the fields/methods of IDeveloper to be exported as part of | ||
| 380 | 794 | the IBook entry instead of exporting a new entry for IDeveloper. For this to | ||
| 381 | 795 | work you just need to ensure an object of the exported entry type can be | ||
| 382 | 796 | adapted into the contributing interface (e.g. an IUser object can be adapted | ||
| 383 | 797 | into IDeveloper). | ||
| 384 | 798 | |||
| 385 | 799 | >>> print_export_tag(IDeveloper) | ||
| 386 | 800 | contributes_to: [<InterfaceClass __builtin__.IUser>] | ||
| 387 | 801 | plural_name: 'developers' | ||
| 388 | 802 | singular_name: 'developer' | ||
| 389 | 803 | type: 'entry' | ||
| 390 | 804 | |||
| 391 | 805 | To learn how this works, see ContributingInterfacesTestCase in | ||
| 392 | 806 | tests/test_declarations.py. | ||
| 393 | 807 | |||
| 394 | 808 | |||
| 395 | 777 | Generating the webservice | 809 | Generating the webservice |
| 396 | 778 | ========================= | 810 | ========================= |
| 397 | 779 | 811 | ||
| 398 | @@ -787,7 +819,7 @@ | |||
| 399 | 787 | 819 | ||
| 400 | 788 | >>> from lazr.restful.declarations import generate_entry_interfaces | 820 | >>> from lazr.restful.declarations import generate_entry_interfaces |
| 401 | 789 | >>> [[version, entry_interface]] = generate_entry_interfaces( | 821 | >>> [[version, entry_interface]] = generate_entry_interfaces( |
| 403 | 790 | ... IBook, 'beta') | 822 | ... IBook, [], 'beta') |
| 404 | 791 | 823 | ||
| 405 | 792 | The created interface is named with 'Entry' appended to the original | 824 | The created interface is named with 'Entry' appended to the original |
| 406 | 793 | name, and is in the same module | 825 | name, and is in the same module |
| 407 | @@ -836,14 +868,14 @@ | |||
| 408 | 836 | 868 | ||
| 409 | 837 | >>> class SimpleNotExported(Interface): | 869 | >>> class SimpleNotExported(Interface): |
| 410 | 838 | ... """Interface not exported.""" | 870 | ... """Interface not exported.""" |
| 412 | 839 | >>> generate_entry_interfaces(SimpleNotExported, 'beta') | 871 | >>> generate_entry_interfaces(SimpleNotExported, [], 'beta') |
| 413 | 840 | Traceback (most recent call last): | 872 | Traceback (most recent call last): |
| 414 | 841 | ... | 873 | ... |
| 415 | 842 | TypeError: 'SimpleNotExported' isn't tagged for webservice export. | 874 | TypeError: 'SimpleNotExported' isn't tagged for webservice export. |
| 416 | 843 | 875 | ||
| 417 | 844 | The interface must also be exported as an entry: | 876 | The interface must also be exported as an entry: |
| 418 | 845 | 877 | ||
| 420 | 846 | >>> generate_entry_interfaces(IBookSet, 'beta') | 878 | >>> generate_entry_interfaces(IBookSet, [], 'beta') |
| 421 | 847 | Traceback (most recent call last): | 879 | Traceback (most recent call last): |
| 422 | 848 | ... | 880 | ... |
| 423 | 849 | TypeError: 'IBookSet' isn't exported as an entry. | 881 | TypeError: 'IBookSet' isn't exported as an entry. |
| 424 | @@ -854,7 +886,7 @@ | |||
| 425 | 854 | 886 | ||
| 426 | 855 | >>> from lazr.restful.declarations import generate_entry_adapters | 887 | >>> from lazr.restful.declarations import generate_entry_adapters |
| 427 | 856 | >>> entry_adapter_factories = generate_entry_adapters( | 888 | >>> entry_adapter_factories = generate_entry_adapters( |
| 429 | 857 | ... IBook, [('beta', entry_interface)]) | 889 | ... IBook, [], [('beta', entry_interface)]) |
| 430 | 858 | 890 | ||
| 431 | 859 | generate_entry_adapters() generates an adapter for every version of | 891 | generate_entry_adapters() generates an adapter for every version of |
| 432 | 860 | the web service (see a test for it below, in "Versioned | 892 | the web service (see a test for it below, in "Versioned |
| 433 | @@ -899,18 +931,14 @@ | |||
| 434 | 899 | utilities providing basic information about the web service. This one | 931 | utilities providing basic information about the web service. This one |
| 435 | 900 | is just a dummy. | 932 | is just a dummy. |
| 436 | 901 | 933 | ||
| 437 | 934 | >>> from lazr.restful.testing.helpers import TestWebServiceConfiguration | ||
| 438 | 902 | >>> from zope.component import provideUtility | 935 | >>> from zope.component import provideUtility |
| 439 | 903 | >>> from lazr.restful.interfaces import IWebServiceConfiguration | 936 | >>> from lazr.restful.interfaces import IWebServiceConfiguration |
| 443 | 904 | >>> class MyWebServiceConfiguration: | 937 | >>> class MyWebServiceConfiguration(TestWebServiceConfiguration): |
| 441 | 905 | ... implements(IWebServiceConfiguration) | ||
| 442 | 906 | ... view_permission = "lazr.View" | ||
| 444 | 907 | ... active_versions = ["beta", "1.0", "2.0", "3.0"] | 938 | ... active_versions = ["beta", "1.0", "2.0", "3.0"] |
| 445 | 908 | ... last_version_with_mutator_named_operations = "1.0" | 939 | ... last_version_with_mutator_named_operations = "1.0" |
| 446 | 909 | ... code_revision = "1.0b" | 940 | ... code_revision = "1.0b" |
| 447 | 910 | ... default_batch_size = 50 | 941 | ... default_batch_size = 50 |
| 448 | 911 | ... | ||
| 449 | 912 | ... def get_request_user(self): | ||
| 450 | 913 | ... return 'A user' | ||
| 451 | 914 | >>> provideUtility(MyWebServiceConfiguration(), IWebServiceConfiguration) | 942 | >>> provideUtility(MyWebServiceConfiguration(), IWebServiceConfiguration) |
| 452 | 915 | 943 | ||
| 453 | 916 | We must also set up the ability to create versioned requests. This web | 944 | We must also set up the ability to create versioned requests. This web |
| 454 | @@ -959,14 +987,15 @@ | |||
| 455 | 959 | It's an error to call this function on an interface not exported on the | 987 | It's an error to call this function on an interface not exported on the |
| 456 | 960 | web service: | 988 | web service: |
| 457 | 961 | 989 | ||
| 459 | 962 | >>> generate_entry_adapters(SimpleNotExported, ('beta', entry_interface)) | 990 | >>> generate_entry_adapters( |
| 460 | 991 | ... SimpleNotExported, [], ('beta', entry_interface)) | ||
| 461 | 963 | Traceback (most recent call last): | 992 | Traceback (most recent call last): |
| 462 | 964 | ... | 993 | ... |
| 463 | 965 | TypeError: 'SimpleNotExported' isn't tagged for webservice export. | 994 | TypeError: 'SimpleNotExported' isn't tagged for webservice export. |
| 464 | 966 | 995 | ||
| 465 | 967 | Or exported as a collection: | 996 | Or exported as a collection: |
| 466 | 968 | 997 | ||
| 468 | 969 | >>> generate_entry_adapters(IBookSet, ('beta', entry_interface)) | 998 | >>> generate_entry_adapters(IBookSet, [], ('beta', entry_interface)) |
| 469 | 970 | Traceback (most recent call last): | 999 | Traceback (most recent call last): |
| 470 | 971 | ... | 1000 | ... |
| 471 | 972 | TypeError: 'IBookSet' isn't exported as an entry. | 1001 | TypeError: 'IBookSet' isn't exported as an entry. |
| 472 | @@ -1142,6 +1171,7 @@ | |||
| 473 | 1142 | >>> print_params(write_method_adapter_factory.params) | 1171 | >>> print_params(write_method_adapter_factory.params) |
| 474 | 1143 | 1172 | ||
| 475 | 1144 | >>> class BookOnSteroids(Book): | 1173 | >>> class BookOnSteroids(Book): |
| 476 | 1174 | ... implements(IBookOnSteroids) | ||
| 477 | 1145 | ... def checkout(self, who, kind): | 1175 | ... def checkout(self, who, kind): |
| 478 | 1146 | ... print "%s did a %s check out of '%s'." % ( | 1176 | ... print "%s did a %s check out of '%s'." % ( |
| 479 | 1147 | ... who, kind, self.title) | 1177 | ... who, kind, self.title) |
| 480 | @@ -1273,7 +1303,7 @@ | |||
| 481 | 1273 | ... @export_destructor_operation() | 1303 | ... @export_destructor_operation() |
| 482 | 1274 | ... def destroy(): | 1304 | ... def destroy(): |
| 483 | 1275 | ... pass | 1305 | ... pass |
| 485 | 1276 | >>> ignored = generate_entry_interfaces(IHasText, 'beta') | 1306 | >>> ignored = generate_entry_interfaces(IHasText, [], 'beta') |
| 486 | 1277 | 1307 | ||
| 487 | 1278 | A destructor method cannot take any free arguments. | 1308 | A destructor method cannot take any free arguments. |
| 488 | 1279 | 1309 | ||
| 489 | @@ -1299,7 +1329,7 @@ | |||
| 490 | 1299 | ... @call_with(argument="fixed value") | 1329 | ... @call_with(argument="fixed value") |
| 491 | 1300 | ... def destroy(argument): | 1330 | ... def destroy(argument): |
| 492 | 1301 | ... pass | 1331 | ... pass |
| 494 | 1302 | >>> ignored = generate_entry_interfaces(IHasText, 'beta') | 1332 | >>> ignored = generate_entry_interfaces(IHasText, [], 'beta') |
| 495 | 1303 | 1333 | ||
| 496 | 1304 | An entry cannot have more than one destructor. | 1334 | An entry cannot have more than one destructor. |
| 497 | 1305 | 1335 | ||
| 498 | @@ -1315,7 +1345,7 @@ | |||
| 499 | 1315 | ... @export_destructor_operation() | 1345 | ... @export_destructor_operation() |
| 500 | 1316 | ... def destroy2(): | 1346 | ... def destroy2(): |
| 501 | 1317 | ... pass | 1347 | ... pass |
| 503 | 1318 | >>> generate_entry_interfaces(IHasText, 'beta') | 1348 | >>> generate_entry_interfaces(IHasText, [], 'beta') |
| 504 | 1319 | Traceback (most recent call last): | 1349 | Traceback (most recent call last): |
| 505 | 1320 | ... | 1350 | ... |
| 506 | 1321 | TypeError: An entry can only have one destructor method for | 1351 | TypeError: An entry can only have one destructor method for |
| 507 | @@ -1354,10 +1384,10 @@ | |||
| 508 | 1354 | Generate the entry interface and adapter... | 1384 | Generate the entry interface and adapter... |
| 509 | 1355 | 1385 | ||
| 510 | 1356 | >>> hastext_entry_interfaces = generate_entry_interfaces( | 1386 | >>> hastext_entry_interfaces = generate_entry_interfaces( |
| 512 | 1357 | ... IHasText, 'beta') | 1387 | ... IHasText, [], 'beta') |
| 513 | 1358 | >>> [(beta, hastext_entry_interface)] = hastext_entry_interfaces | 1388 | >>> [(beta, hastext_entry_interface)] = hastext_entry_interfaces |
| 514 | 1359 | >>> [(beta, hastext_entry_adapter_factory)] = generate_entry_adapters( | 1389 | >>> [(beta, hastext_entry_adapter_factory)] = generate_entry_adapters( |
| 516 | 1360 | ... IHasText, hastext_entry_interfaces) | 1390 | ... IHasText, [], hastext_entry_interfaces) |
| 517 | 1361 | 1391 | ||
| 518 | 1362 | >>> obj = HasText() | 1392 | >>> obj = HasText() |
| 519 | 1363 | >>> hastext_entry_adapter = hastext_entry_adapter_factory(obj, request) | 1393 | >>> hastext_entry_adapter = hastext_entry_adapter_factory(obj, request) |
| 520 | @@ -1489,7 +1519,7 @@ | |||
| 521 | 1489 | ... | 1519 | ... |
| 522 | 1490 | >>> class CachedBookSet(BookSet): | 1520 | >>> class CachedBookSet(BookSet): |
| 523 | 1491 | ... """Simple ICachedBookSet implementation.""" | 1521 | ... """Simple ICachedBookSet implementation.""" |
| 525 | 1492 | ... implements(IBookSet) | 1522 | ... implements(ICachedBookSet) |
| 526 | 1493 | ... | 1523 | ... |
| 527 | 1494 | ... def getAllBooks(self): | 1524 | ... def getAllBooks(self): |
| 528 | 1495 | ... return self.books | 1525 | ... return self.books |
| 529 | @@ -1660,7 +1690,7 @@ | |||
| 530 | 1660 | 1690 | ||
| 531 | 1661 | >>> versions = ['beta', '1.0', '2.0', '3.0'] | 1691 | >>> versions = ['beta', '1.0', '2.0', '3.0'] |
| 532 | 1662 | >>> versions_and_interfaces = generate_entry_interfaces( | 1692 | >>> versions_and_interfaces = generate_entry_interfaces( |
| 534 | 1663 | ... IMultiVersionEntry, *versions) | 1693 | ... IMultiVersionEntry, [], *versions) |
| 535 | 1664 | 1694 | ||
| 536 | 1665 | >>> for version, interface in versions_and_interfaces: | 1695 | >>> for version, interface in versions_and_interfaces: |
| 537 | 1666 | ... print version | 1696 | ... print version |
| 538 | @@ -1718,7 +1748,7 @@ | |||
| 539 | 1718 | classes. | 1748 | classes. |
| 540 | 1719 | 1749 | ||
| 541 | 1720 | >>> entry_adapters = generate_entry_adapters( | 1750 | >>> entry_adapters = generate_entry_adapters( |
| 543 | 1721 | ... IMultiVersionEntry, versions_and_interfaces) | 1751 | ... IMultiVersionEntry, [], versions_and_interfaces) |
| 544 | 1722 | 1752 | ||
| 545 | 1723 | >>> for version, adapter in entry_adapters: | 1753 | >>> for version, adapter in entry_adapters: |
| 546 | 1724 | ... print version | 1754 | ... print version |
| 547 | @@ -1827,7 +1857,7 @@ | |||
| 548 | 1827 | version, then 'bar' inherits behavior from 'foo'. | 1857 | version, then 'bar' inherits behavior from 'foo'. |
| 549 | 1828 | 1858 | ||
| 550 | 1829 | >>> foo, bar = generate_entry_interfaces( | 1859 | >>> foo, bar = generate_entry_interfaces( |
| 552 | 1830 | ... IAmbiguousMultiVersion, 'foo', 'bar') | 1860 | ... IAmbiguousMultiVersion, [], 'foo', 'bar') |
| 553 | 1831 | 1861 | ||
| 554 | 1832 | >>> print foo[0] | 1862 | >>> print foo[0] |
| 555 | 1833 | foo | 1863 | foo |
| 556 | @@ -1855,7 +1885,7 @@ | |||
| 557 | 1855 | ... ('bar', dict(exported_as='bar_name'))) | 1885 | ... ('bar', dict(exported_as='bar_name'))) |
| 558 | 1856 | 1886 | ||
| 559 | 1857 | >>> bar, foo = generate_entry_interfaces( | 1887 | >>> bar, foo = generate_entry_interfaces( |
| 561 | 1858 | ... IAmbiguousMultiVersion, 'bar', 'foo') | 1888 | ... IAmbiguousMultiVersion, [], 'bar', 'foo') |
| 562 | 1859 | 1889 | ||
| 563 | 1860 | >>> print bar[0] | 1890 | >>> print bar[0] |
| 564 | 1861 | bar | 1891 | bar |
| 565 | @@ -1888,7 +1918,7 @@ | |||
| 566 | 1888 | ... ('1.0', dict(exported_as='bar'))) | 1918 | ... ('1.0', dict(exported_as='bar'))) |
| 567 | 1889 | 1919 | ||
| 568 | 1890 | >>> generate_entry_interfaces( | 1920 | >>> generate_entry_interfaces( |
| 570 | 1891 | ... INonexistentVersionEntry, 'beta', '1.0') | 1921 | ... INonexistentVersionEntry, [], 'beta', '1.0') |
| 571 | 1892 | Traceback (most recent call last): | 1922 | Traceback (most recent call last): |
| 572 | 1893 | ... | 1923 | ... |
| 573 | 1894 | ValueError: Field "field" in interface "INonexistentVersionEntry": | 1924 | ValueError: Field "field" in interface "INonexistentVersionEntry": |
| 574 | @@ -1904,7 +1934,7 @@ | |||
| 575 | 1904 | ... ('1.0', dict(exported_as='bar')), | 1934 | ... ('1.0', dict(exported_as='bar')), |
| 576 | 1905 | ... ('2.0', dict(exported_as='foo'))) | 1935 | ... ('2.0', dict(exported_as='foo'))) |
| 577 | 1906 | 1936 | ||
| 579 | 1907 | >>> generate_entry_interfaces(IWrongOrderEntry, '1.0', '2.0') | 1937 | >>> generate_entry_interfaces(IWrongOrderEntry, [], '1.0', '2.0') |
| 580 | 1908 | Traceback (most recent call last): | 1938 | Traceback (most recent call last): |
| 581 | 1909 | ... | 1939 | ... |
| 582 | 1910 | ValueError: Field "..." in interface "IWrongOrderEntry": | 1940 | ValueError: Field "..." in interface "IWrongOrderEntry": |
| 583 | @@ -1920,7 +1950,7 @@ | |||
| 584 | 1920 | ... ('beta', dict(exported_as='another_beta_name')), | 1950 | ... ('beta', dict(exported_as='another_beta_name')), |
| 585 | 1921 | ... ('beta', dict(exported_as='beta_name'))) | 1951 | ... ('beta', dict(exported_as='beta_name'))) |
| 586 | 1922 | 1952 | ||
| 588 | 1923 | >>> generate_entry_interfaces(IDuplicateEntry, 'beta', '1.0') | 1953 | >>> generate_entry_interfaces(IDuplicateEntry, [], 'beta', '1.0') |
| 589 | 1924 | Traceback (most recent call last): | 1954 | Traceback (most recent call last): |
| 590 | 1925 | ... | 1955 | ... |
| 591 | 1926 | ValueError: Field "field" in interface "IDuplicateEntry": | 1956 | ValueError: Field "field" in interface "IDuplicateEntry": |
| 592 | @@ -1937,7 +1967,7 @@ | |||
| 593 | 1937 | ... ('beta', dict(exported_as='beta_name')), | 1967 | ... ('beta', dict(exported_as='beta_name')), |
| 594 | 1938 | ... exported_as='earliest_name') | 1968 | ... exported_as='earliest_name') |
| 595 | 1939 | 1969 | ||
| 597 | 1940 | >>> generate_entry_interfaces(IDuplicateEntry, 'beta', '1.0') | 1970 | >>> generate_entry_interfaces(IDuplicateEntry, [], 'beta', '1.0') |
| 598 | 1941 | Traceback (most recent call last): | 1971 | Traceback (most recent call last): |
| 599 | 1942 | ... | 1972 | ... |
| 600 | 1943 | ValueError: Field "field" in interface "IDuplicateEntry": | 1973 | ValueError: Field "field" in interface "IDuplicateEntry": |
| 601 | @@ -1977,7 +2007,7 @@ | |||
| 602 | 1977 | ... ('beta', dict(exported_as='unchanging_name'))) | 2007 | ... ('beta', dict(exported_as='unchanging_name'))) |
| 603 | 1978 | 2008 | ||
| 604 | 1979 | >>> [version for version, tags in | 2009 | >>> [version for version, tags in |
| 606 | 1980 | ... generate_entry_interfaces(IUnchangingEntry, *versions)] | 2010 | ... generate_entry_interfaces(IUnchangingEntry, [], *versions)] |
| 607 | 1981 | ['beta', '1.0', '2.0', '3.0'] | 2011 | ['beta', '1.0', '2.0', '3.0'] |
| 608 | 1982 | 2012 | ||
| 609 | 1983 | Named operations | 2013 | Named operations |
| 610 | @@ -2291,7 +2321,7 @@ | |||
| 611 | 2291 | ... pass | 2321 | ... pass |
| 612 | 2292 | 2322 | ||
| 613 | 2293 | >>> ignored = generate_entry_interfaces( | 2323 | >>> ignored = generate_entry_interfaces( |
| 615 | 2294 | ... IDifferentMutators, 'beta', '1.0') | 2324 | ... IDifferentMutators, [], 'beta', '1.0') |
| 616 | 2295 | 2325 | ||
| 617 | 2296 | But you can't define two mutators for the same field in the same version. | 2326 | But you can't define two mutators for the same field in the same version. |
| 618 | 2297 | 2327 | ||
| 619 | @@ -2342,7 +2372,7 @@ | |||
| 620 | 2342 | ... pass | 2372 | ... pass |
| 621 | 2343 | 2373 | ||
| 622 | 2344 | >>> generate_entry_interfaces( | 2374 | >>> generate_entry_interfaces( |
| 624 | 2345 | ... IImplicitAndExplicitMutator, 'beta', '1.0') | 2375 | ... IImplicitAndExplicitMutator, [], 'beta', '1.0') |
| 625 | 2346 | Traceback (most recent call last): | 2376 | Traceback (most recent call last): |
| 626 | 2347 | ... | 2377 | ... |
| 627 | 2348 | ValueError: Field "field" in interface | 2378 | ValueError: Field "field" in interface |
| 628 | @@ -2377,7 +2407,7 @@ | |||
| 629 | 2377 | ... pass | 2407 | ... pass |
| 630 | 2378 | 2408 | ||
| 631 | 2379 | >>> ignored = generate_entry_interfaces( | 2409 | >>> ignored = generate_entry_interfaces( |
| 633 | 2380 | ... IImplicitAndExplicitMutator, 'alpha', 'beta', '1.0') | 2410 | ... IImplicitAndExplicitMutator, [], 'alpha', 'beta', '1.0') |
| 634 | 2381 | 2411 | ||
| 635 | 2382 | Destructor operations | 2412 | Destructor operations |
| 636 | 2383 | ********************* | 2413 | ********************* |
| 637 | @@ -2402,7 +2432,7 @@ | |||
| 638 | 2402 | ... """Another destructor method.""" | 2432 | ... """Another destructor method.""" |
| 639 | 2403 | 2433 | ||
| 640 | 2404 | >>> ignore = generate_entry_interfaces( | 2434 | >>> ignore = generate_entry_interfaces( |
| 642 | 2405 | ... IGoodDestructorEntry, 'beta', '1.0') | 2435 | ... IGoodDestructorEntry, [], 'beta', '1.0') |
| 643 | 2406 | 2436 | ||
| 644 | 2407 | In this next example, the destructor is removed in 1.0 and | 2437 | In this next example, the destructor is removed in 1.0 and |
| 645 | 2408 | added back in 2.0. The 2.0 version does not inherit any values from | 2438 | added back in 2.0. The 2.0 version does not inherit any values from |
| 646 | @@ -2476,33 +2506,7 @@ | |||
| 647 | 2476 | (Put the interface in a module where it will be possible for the ZCML | 2506 | (Put the interface in a module where it will be possible for the ZCML |
| 648 | 2477 | handler to inspect.) | 2507 | handler to inspect.) |
| 649 | 2478 | 2508 | ||
| 677 | 2479 | >>> import sys | 2509 | >>> from lazr.restful.testing.helpers import register_test_module |
| 651 | 2480 | >>> from types import ModuleType | ||
| 652 | 2481 | >>> def create_test_module(name, *contents): | ||
| 653 | 2482 | ... """Defines a new module and adds it to sys.modules.""" | ||
| 654 | 2483 | ... new_module = ModuleType(name) | ||
| 655 | 2484 | ... sys.modules['lazr.restful.' + name] = new_module | ||
| 656 | 2485 | ... for object in contents: | ||
| 657 | 2486 | ... setattr(new_module, object.__name__, object) | ||
| 658 | 2487 | ... return new_module | ||
| 659 | 2488 | |||
| 660 | 2489 | >>> from zope.configuration import xmlconfig | ||
| 661 | 2490 | >>> def register_test_module(name, *contents): | ||
| 662 | 2491 | ... new_module = create_test_module(name, *contents) | ||
| 663 | 2492 | ... try: | ||
| 664 | 2493 | ... zcmlcontext = xmlconfig.string(""" | ||
| 665 | 2494 | ... <configure | ||
| 666 | 2495 | ... xmlns:webservice= | ||
| 667 | 2496 | ... "http://namespaces.canonical.com/webservice"> | ||
| 668 | 2497 | ... <include package="lazr.restful" file="meta.zcml" /> | ||
| 669 | 2498 | ... <webservice:register module="lazr.restful.%s" /> | ||
| 670 | 2499 | ... </configure> | ||
| 671 | 2500 | ... """ % name) | ||
| 672 | 2501 | ... except Exception, e: | ||
| 673 | 2502 | ... del sys.modules['lazr.restful.' + name] | ||
| 674 | 2503 | ... raise e | ||
| 675 | 2504 | ... return new_module | ||
| 676 | 2505 | |||
| 678 | 2506 | >>> bookexample = register_test_module( | 2510 | >>> bookexample = register_test_module( |
| 679 | 2507 | ... 'bookexample', IBook, IBookSet, IBookOnSteroids, | 2511 | ... 'bookexample', IBook, IBookSet, IBookOnSteroids, |
| 680 | 2508 | ... IBookSetOnSteroids, ISimpleComment, InvalidEmail) | 2512 | ... IBookSetOnSteroids, ISimpleComment, InvalidEmail) |
| 681 | @@ -2559,6 +2563,7 @@ | |||
| 682 | 2559 | 2563 | ||
| 683 | 2560 | (Clean-up.) | 2564 | (Clean-up.) |
| 684 | 2561 | 2565 | ||
| 685 | 2566 | >>> import sys | ||
| 686 | 2562 | >>> del bookexample | 2567 | >>> del bookexample |
| 687 | 2563 | >>> del sys.modules['lazr.restful.bookexample'] | 2568 | >>> del sys.modules['lazr.restful.bookexample'] |
| 688 | 2564 | 2569 | ||
| 689 | @@ -2878,3 +2883,4 @@ | |||
| 690 | 2878 | <...POST_IBetaMutatorEntry3_set_value_beta...> | 2883 | <...POST_IBetaMutatorEntry3_set_value_beta...> |
| 691 | 2879 | >>> operation_for(context, '3.0', 'set_value') | 2884 | >>> operation_for(context, '3.0', 'set_value') |
| 692 | 2880 | <...POST_IBetaMutatorEntry3_set_value_beta...> | 2885 | <...POST_IBetaMutatorEntry3_set_value_beta...> |
| 693 | 2886 | |||
| 694 | 2881 | 2887 | ||
| 695 | === modified file 'src/lazr/restful/docs/webservice.txt' | |||
| 696 | --- src/lazr/restful/docs/webservice.txt 2010-05-20 18:11:11 +0000 | |||
| 697 | +++ src/lazr/restful/docs/webservice.txt 2010-08-05 14:04:50 +0000 | |||
| 698 | @@ -636,11 +636,23 @@ | |||
| 699 | 636 | >>> from lazr.restful import Entry | 636 | >>> from lazr.restful import Entry |
| 700 | 637 | >>> from lazr.restful.testing.webservice import FakeRequest | 637 | >>> from lazr.restful.testing.webservice import FakeRequest |
| 701 | 638 | 638 | ||
| 702 | 639 | >>> from UserDict import UserDict | ||
| 703 | 640 | >>> class FakeDict(UserDict): | ||
| 704 | 641 | ... def __init__(self, interface): | ||
| 705 | 642 | ... UserDict.__init__(self) | ||
| 706 | 643 | ... self.interface = interface | ||
| 707 | 644 | ... def __getitem__(self, key): | ||
| 708 | 645 | ... return self.interface | ||
| 709 | 646 | |||
| 710 | 639 | >>> class AuthorEntry(Entry): | 647 | >>> class AuthorEntry(Entry): |
| 711 | 640 | ... """An author, as exposed through the web service.""" | 648 | ... """An author, as exposed through the web service.""" |
| 712 | 641 | ... adapts(IAuthor) | 649 | ... adapts(IAuthor) |
| 713 | 642 | ... delegates(IAuthorEntry) | 650 | ... delegates(IAuthorEntry) |
| 714 | 643 | ... schema = IAuthorEntry | 651 | ... schema = IAuthorEntry |
| 715 | 652 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 716 | 653 | ... # create the adapters manually here, we need to do the same for | ||
| 717 | 654 | ... # this dict. | ||
| 718 | 655 | ... _orig_interfaces = FakeDict(IAuthor) | ||
| 719 | 644 | 656 | ||
| 720 | 645 | >>> request = FakeRequest() | 657 | >>> request = FakeRequest() |
| 721 | 646 | >>> verifyObject(IAuthorEntry, AuthorEntry(A1, request)) | 658 | >>> verifyObject(IAuthorEntry, AuthorEntry(A1, request)) |
| 722 | @@ -675,20 +687,36 @@ | |||
| 723 | 675 | ... """A cookbook, as exposed through the web service.""" | 687 | ... """A cookbook, as exposed through the web service.""" |
| 724 | 676 | ... delegates(ICookbookEntry) | 688 | ... delegates(ICookbookEntry) |
| 725 | 677 | ... schema = ICookbookEntry | 689 | ... schema = ICookbookEntry |
| 726 | 690 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 727 | 691 | ... # create the adapters manually here, we need to do the same for | ||
| 728 | 692 | ... # this dict. | ||
| 729 | 693 | ... _orig_interfaces = FakeDict(ICookbook) | ||
| 730 | 678 | 694 | ||
| 731 | 679 | >>> class DishEntry(Entry): | 695 | >>> class DishEntry(Entry): |
| 732 | 680 | ... """A dish, as exposed through the web service.""" | 696 | ... """A dish, as exposed through the web service.""" |
| 733 | 681 | ... delegates(IDishEntry) | 697 | ... delegates(IDishEntry) |
| 734 | 682 | ... schema = IDishEntry | 698 | ... schema = IDishEntry |
| 735 | 699 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 736 | 700 | ... # create the adapters manually here, we need to do the same for | ||
| 737 | 701 | ... # this dict. | ||
| 738 | 702 | ... _orig_interfaces = FakeDict(IDish) | ||
| 739 | 683 | 703 | ||
| 740 | 684 | >>> class CommentEntry(Entry): | 704 | >>> class CommentEntry(Entry): |
| 741 | 685 | ... """A comment, as exposed through the web service.""" | 705 | ... """A comment, as exposed through the web service.""" |
| 742 | 686 | ... delegates(ICommentEntry) | 706 | ... delegates(ICommentEntry) |
| 743 | 687 | ... schema = ICommentEntry | 707 | ... schema = ICommentEntry |
| 744 | 708 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 745 | 709 | ... # create the adapters manually here, we need to do the same for | ||
| 746 | 710 | ... # this dict. | ||
| 747 | 711 | ... _orig_interfaces = FakeDict(IComment) | ||
| 748 | 688 | 712 | ||
| 749 | 689 | >>> class RecipeEntry(Entry): | 713 | >>> class RecipeEntry(Entry): |
| 750 | 690 | ... delegates(IRecipeEntry) | 714 | ... delegates(IRecipeEntry) |
| 751 | 691 | ... schema = IRecipeEntry | 715 | ... schema = IRecipeEntry |
| 752 | 716 | ... # This dict is normally generated by lazr.restful, but since we | ||
| 753 | 717 | ... # create the adapters manually here, we need to do the same for | ||
| 754 | 718 | ... # this dict. | ||
| 755 | 719 | ... _orig_interfaces = FakeDict(IRecipe) | ||
| 756 | 692 | 720 | ||
| 757 | 693 | We need to register these entries as a multiadapter adapter from | 721 | We need to register these entries as a multiadapter adapter from |
| 758 | 694 | (e.g.) ``IAuthor`` and ``IWebServiceClientRequest`` to (e.g.) | 722 | (e.g.) ``IAuthor`` and ``IWebServiceClientRequest`` to (e.g.) |
| 759 | 695 | 723 | ||
| 760 | === modified file 'src/lazr/restful/example/base/tests/test_integration.py' | |||
| 761 | --- src/lazr/restful/example/base/tests/test_integration.py 2009-09-01 13:12:32 +0000 | |||
| 762 | +++ src/lazr/restful/example/base/tests/test_integration.py 2010-08-05 14:04:50 +0000 | |||
| 763 | @@ -29,6 +29,7 @@ | |||
| 764 | 29 | doctest.REPORT_NDIFF) | 29 | doctest.REPORT_NDIFF) |
| 765 | 30 | 30 | ||
| 766 | 31 | class FunctionalLayer: | 31 | class FunctionalLayer: |
| 767 | 32 | allow_teardown = False | ||
| 768 | 32 | zcml = os.path.abspath(resource_filename('lazr.restful', 'ftesting.zcml')) | 33 | zcml = os.path.abspath(resource_filename('lazr.restful', 'ftesting.zcml')) |
| 769 | 33 | zcml_layer(FunctionalLayer) | 34 | zcml_layer(FunctionalLayer) |
| 770 | 34 | 35 | ||
| 771 | 35 | 36 | ||
| 772 | === added directory 'src/lazr/restful/example/base_extended' | |||
| 773 | === added file 'src/lazr/restful/example/base_extended/README.txt' | |||
| 774 | --- src/lazr/restful/example/base_extended/README.txt 1970-01-01 00:00:00 +0000 | |||
| 775 | +++ src/lazr/restful/example/base_extended/README.txt 2010-08-05 14:04:50 +0000 | |||
| 776 | @@ -0,0 +1,22 @@ | |||
| 777 | 1 | This is a very simple webservice that demonstrates how to use contributing | ||
| 778 | 2 | interfaces to add fields to an existing webservice using a plugin-like | ||
| 779 | 3 | pattern. | ||
| 780 | 4 | |||
| 781 | 5 | Here we've just added a 'comments' field to the IRecipe entry. | ||
| 782 | 6 | |||
| 783 | 7 | >>> from lazr.restful.testing.webservice import WebServiceCaller | ||
| 784 | 8 | >>> webservice = WebServiceCaller(domain='cookbooks.dev') | ||
| 785 | 9 | |||
| 786 | 10 | # The comments DB for this webservice is empty so we'll add some comments | ||
| 787 | 11 | # to the recipe with ID=1 | ||
| 788 | 12 | >>> from lazr.restful.example.base_extended.comments import comments_db | ||
| 789 | 13 | >>> comments_db[1] = ['Comment 1', 'Comment 2'] | ||
| 790 | 14 | |||
| 791 | 15 | And as we can see below, a recipe's representation now include its comments. | ||
| 792 | 16 | |||
| 793 | 17 | >>> print "\n".join(webservice.get('/recipes/1').jsonBody()['comments']) | ||
| 794 | 18 | Comment 1 | ||
| 795 | 19 | Comment 2 | ||
| 796 | 20 | |||
| 797 | 21 | >>> webservice.get('/recipes/2').jsonBody()['comments'] | ||
| 798 | 22 | [] | ||
| 799 | 0 | 23 | ||
| 800 | === added file 'src/lazr/restful/example/base_extended/__init__.py' | |||
| 801 | --- src/lazr/restful/example/base_extended/__init__.py 1970-01-01 00:00:00 +0000 | |||
| 802 | +++ src/lazr/restful/example/base_extended/__init__.py 2010-08-05 14:04:50 +0000 | |||
| 803 | @@ -0,0 +1,3 @@ | |||
| 804 | 1 | """A simple webservice which uses contributing interfaces to extend the 'base' | ||
| 805 | 2 | one. | ||
| 806 | 3 | """ | ||
| 807 | 0 | 4 | ||
| 808 | === added file 'src/lazr/restful/example/base_extended/comments.py' | |||
| 809 | --- src/lazr/restful/example/base_extended/comments.py 1970-01-01 00:00:00 +0000 | |||
| 810 | +++ src/lazr/restful/example/base_extended/comments.py 2010-08-05 14:04:50 +0000 | |||
| 811 | @@ -0,0 +1,32 @@ | |||
| 812 | 1 | |||
| 813 | 2 | from zope.component import adapts | ||
| 814 | 3 | from zope.interface import implements, Interface | ||
| 815 | 4 | from zope.schema import List, Text | ||
| 816 | 5 | |||
| 817 | 6 | from lazr.restful.example.base.interfaces import IRecipe | ||
| 818 | 7 | |||
| 819 | 8 | from lazr.restful.declarations import ( | ||
| 820 | 9 | export_as_webservice_entry, exported) | ||
| 821 | 10 | |||
| 822 | 11 | |||
| 823 | 12 | class IHasComments(Interface): | ||
| 824 | 13 | export_as_webservice_entry(contributes_to=[IRecipe]) | ||
| 825 | 14 | comments = exported( | ||
| 826 | 15 | List(title=u'Comments made by users', value_type=Text())) | ||
| 827 | 16 | |||
| 828 | 17 | |||
| 829 | 18 | class RecipeToHasCommentsAdapter: | ||
| 830 | 19 | implements(IHasComments) | ||
| 831 | 20 | adapts(IRecipe) | ||
| 832 | 21 | |||
| 833 | 22 | def __init__(self, recipe): | ||
| 834 | 23 | self.recipe = recipe | ||
| 835 | 24 | |||
| 836 | 25 | @property | ||
| 837 | 26 | def comments(self): | ||
| 838 | 27 | return comments_db.get(self.recipe.id, []) | ||
| 839 | 28 | |||
| 840 | 29 | |||
| 841 | 30 | # A fake database for storing comments. Monkey-patch this to test the | ||
| 842 | 31 | # IHasComments adapter. | ||
| 843 | 32 | comments_db = {} | ||
| 844 | 0 | 33 | ||
| 845 | === added file 'src/lazr/restful/example/base_extended/site.zcml' | |||
| 846 | --- src/lazr/restful/example/base_extended/site.zcml 1970-01-01 00:00:00 +0000 | |||
| 847 | +++ src/lazr/restful/example/base_extended/site.zcml 2010-08-05 14:04:50 +0000 | |||
| 848 | @@ -0,0 +1,18 @@ | |||
| 849 | 1 | <configure | ||
| 850 | 2 | xmlns="http://namespaces.zope.org/zope" | ||
| 851 | 3 | xmlns:webservice="http://namespaces.canonical.com/webservice" | ||
| 852 | 4 | xmlns:grok="http://namespaces.zope.org/grok"> | ||
| 853 | 5 | |||
| 854 | 6 | <include package="lazr.restful" file="basic-site.zcml" /> | ||
| 855 | 7 | |||
| 856 | 8 | <include package="lazr.restful.example.base" /> | ||
| 857 | 9 | |||
| 858 | 10 | <webservice:register module="lazr.restful.example.base_extended.comments" /> | ||
| 859 | 11 | <grok:grok package="lazr.restful.example.base_extended" /> | ||
| 860 | 12 | |||
| 861 | 13 | <adapter | ||
| 862 | 14 | factory="lazr.restful.example.base_extended.comments.RecipeToHasCommentsAdapter" /> | ||
| 863 | 15 | |||
| 864 | 16 | <securityPolicy | ||
| 865 | 17 | component="zope.security.simplepolicies.PermissiveSecurityPolicy" /> | ||
| 866 | 18 | </configure> | ||
| 867 | 0 | 19 | ||
| 868 | === added directory 'src/lazr/restful/example/base_extended/tests' | |||
| 869 | === added file 'src/lazr/restful/example/base_extended/tests/__init__.py' | |||
| 870 | === added file 'src/lazr/restful/example/base_extended/tests/test_integration.py' | |||
| 871 | --- src/lazr/restful/example/base_extended/tests/test_integration.py 1970-01-01 00:00:00 +0000 | |||
| 872 | +++ src/lazr/restful/example/base_extended/tests/test_integration.py 2010-08-05 14:04:50 +0000 | |||
| 873 | @@ -0,0 +1,38 @@ | |||
| 874 | 1 | # Copyright 20010 Canonical Ltd. All rights reserved. | ||
| 875 | 2 | |||
| 876 | 3 | """Test harness for LAZR doctests.""" | ||
| 877 | 4 | |||
| 878 | 5 | __metaclass__ = type | ||
| 879 | 6 | __all__ = [] | ||
| 880 | 7 | |||
| 881 | 8 | import os | ||
| 882 | 9 | import doctest | ||
| 883 | 10 | from pkg_resources import resource_filename | ||
| 884 | 11 | |||
| 885 | 12 | from van.testing.layer import zcml_layer, wsgi_intercept_layer | ||
| 886 | 13 | |||
| 887 | 14 | from lazr.restful.example.base.tests.test_integration import ( | ||
| 888 | 15 | CookbookWebServiceTestPublication, DOCTEST_FLAGS) | ||
| 889 | 16 | from lazr.restful.testing.webservice import WebServiceApplication | ||
| 890 | 17 | |||
| 891 | 18 | |||
| 892 | 19 | class FunctionalLayer: | ||
| 893 | 20 | allow_teardown = False | ||
| 894 | 21 | zcml = os.path.abspath(resource_filename( | ||
| 895 | 22 | 'lazr.restful.example.base_extended', 'site.zcml')) | ||
| 896 | 23 | zcml_layer(FunctionalLayer) | ||
| 897 | 24 | |||
| 898 | 25 | |||
| 899 | 26 | class WSGILayer(FunctionalLayer): | ||
| 900 | 27 | @classmethod | ||
| 901 | 28 | def make_application(self): | ||
| 902 | 29 | return WebServiceApplication({}, CookbookWebServiceTestPublication) | ||
| 903 | 30 | wsgi_intercept_layer(WSGILayer) | ||
| 904 | 31 | |||
| 905 | 32 | |||
| 906 | 33 | def additional_tests(): | ||
| 907 | 34 | """See `zope.testing.testrunner`.""" | ||
| 908 | 35 | tests = ['../README.txt'] | ||
| 909 | 36 | suite = doctest.DocFileSuite(optionflags=DOCTEST_FLAGS, *tests) | ||
| 910 | 37 | suite.layer = WSGILayer | ||
| 911 | 38 | return suite | ||
| 912 | 0 | 39 | ||
| 913 | === modified file 'src/lazr/restful/metazcml.py' | |||
| 914 | --- src/lazr/restful/metazcml.py 2010-03-03 13:24:04 +0000 | |||
| 915 | +++ src/lazr/restful/metazcml.py 2010-08-05 14:04:50 +0000 | |||
| 916 | @@ -7,6 +7,7 @@ | |||
| 917 | 7 | 7 | ||
| 918 | 8 | 8 | ||
| 919 | 9 | import inspect | 9 | import inspect |
| 920 | 10 | import itertools | ||
| 921 | 10 | 11 | ||
| 922 | 11 | from zope.component import getUtility | 12 | from zope.component import getUtility |
| 923 | 12 | from zope.component.zcml import handler | 13 | from zope.component.zcml import handler |
| 924 | @@ -16,14 +17,15 @@ | |||
| 925 | 16 | 17 | ||
| 926 | 17 | 18 | ||
| 927 | 18 | from lazr.restful.declarations import ( | 19 | from lazr.restful.declarations import ( |
| 931 | 19 | LAZR_WEBSERVICE_EXPORTED, OPERATION_TYPES, REMOVED_OPERATION_TYPE, | 20 | COLLECTION_TYPE, ENTRY_TYPE, LAZR_WEBSERVICE_EXPORTED, OPERATION_TYPES, |
| 932 | 20 | generate_collection_adapter, generate_entry_adapters, | 21 | REMOVED_OPERATION_TYPE, generate_collection_adapter, |
| 933 | 21 | generate_entry_interfaces, generate_operation_adapter) | 22 | generate_entry_adapters, generate_entry_interfaces, |
| 934 | 23 | generate_operation_adapter) | ||
| 935 | 22 | from lazr.restful.error import WebServiceExceptionView | 24 | from lazr.restful.error import WebServiceExceptionView |
| 936 | 23 | 25 | ||
| 937 | 24 | from lazr.restful.interfaces import ( | 26 | from lazr.restful.interfaces import ( |
| 938 | 25 | ICollection, IEntry, IResourceDELETEOperation, IResourceGETOperation, | 27 | ICollection, IEntry, IResourceDELETEOperation, IResourceGETOperation, |
| 940 | 26 | IResourceOperation, IResourcePOSTOperation, IWebServiceClientRequest, | 28 | IResourcePOSTOperation, IWebServiceClientRequest, |
| 941 | 27 | IWebServiceConfiguration, IWebServiceVersion) | 29 | IWebServiceConfiguration, IWebServiceVersion) |
| 942 | 28 | 30 | ||
| 943 | 29 | 31 | ||
| 944 | @@ -34,7 +36,7 @@ | |||
| 945 | 34 | title=u'Module which will be inspected for webservice declarations') | 36 | title=u'Module which will be inspected for webservice declarations') |
| 946 | 35 | 37 | ||
| 947 | 36 | 38 | ||
| 949 | 37 | def generate_and_register_entry_adapters(interface, info): | 39 | def generate_and_register_entry_adapters(interface, info, contributors): |
| 950 | 38 | """Generate an entry adapter for every version of the web service. | 40 | """Generate an entry adapter for every version of the web service. |
| 951 | 39 | 41 | ||
| 952 | 40 | This code generates an IEntry subinterface for every version, each | 42 | This code generates an IEntry subinterface for every version, each |
| 953 | @@ -48,9 +50,10 @@ | |||
| 954 | 48 | versions = list(config.active_versions) | 50 | versions = list(config.active_versions) |
| 955 | 49 | 51 | ||
| 956 | 50 | # Generate an interface and an adapter for every version. | 52 | # Generate an interface and an adapter for every version. |
| 960 | 51 | web_interfaces = generate_entry_interfaces(interface, *versions) | 53 | web_interfaces = generate_entry_interfaces( |
| 961 | 52 | web_factories = generate_entry_adapters(interface, web_interfaces) | 54 | interface, contributors, *versions) |
| 962 | 53 | provides = IEntry | 55 | web_factories = generate_entry_adapters( |
| 963 | 56 | interface, contributors, web_interfaces) | ||
| 964 | 54 | for i in range(0, len(web_interfaces)): | 57 | for i in range(0, len(web_interfaces)): |
| 965 | 55 | interface_version, web_interface = web_interfaces[i] | 58 | interface_version, web_interface = web_interfaces[i] |
| 966 | 56 | factory_version, factory = web_factories[i] | 59 | factory_version, factory = web_factories[i] |
| 967 | @@ -161,10 +164,79 @@ | |||
| 968 | 161 | tag = interface.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) | 164 | tag = interface.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) |
| 969 | 162 | if tag is None: | 165 | if tag is None: |
| 970 | 163 | continue | 166 | continue |
| 972 | 164 | if tag['type'] in ['entry', 'collection']: | 167 | if tag['type'] in [ENTRY_TYPE, COLLECTION_TYPE]: |
| 973 | 165 | yield interface | 168 | yield interface |
| 974 | 166 | 169 | ||
| 975 | 167 | 170 | ||
| 976 | 171 | def find_interfaces_and_contributors(module): | ||
| 977 | 172 | """Find the interfaces and its contributors marked for export. | ||
| 978 | 173 | |||
| 979 | 174 | Return a dictionary with interfaces as keys and their contributors as | ||
| 980 | 175 | values. | ||
| 981 | 176 | """ | ||
| 982 | 177 | interfaces_with_contributors = {} | ||
| 983 | 178 | for interface in find_exported_interfaces(module): | ||
| 984 | 179 | if issubclass(interface, Exception): | ||
| 985 | 180 | # Exceptions can't have interfaces, so just store it in | ||
| 986 | 181 | # interfaces_with_contributors and move on. | ||
| 987 | 182 | interfaces_with_contributors.setdefault(interface, []) | ||
| 988 | 183 | continue | ||
| 989 | 184 | |||
| 990 | 185 | tag = interface.getTaggedValue(LAZR_WEBSERVICE_EXPORTED) | ||
| 991 | 186 | if tag.get('contributes_to'): | ||
| 992 | 187 | # Append this interface (which is a contributing interface) to the | ||
| 993 | 188 | # list of contributors of every interface it contributes to. | ||
| 994 | 189 | for iface in tag['contributes_to']: | ||
| 995 | 190 | if iface.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) is None: | ||
| 996 | 191 | raise AttemptToContributeToNonExportedInterface( | ||
| 997 | 192 | "Interface %s contributes to %s, which is not " | ||
| 998 | 193 | "exported." % (interface.__name__, iface.__name__)) | ||
| 999 | 194 | raise AssertionError('foo') | ||
| 1000 | 195 | contributors = interfaces_with_contributors.setdefault( | ||
| 1001 | 196 | iface, []) | ||
| 1002 | 197 | contributors.append(interface) | ||
| 1003 | 198 | else: | ||
| 1004 | 199 | # This is a regular interface, but one of its contributing | ||
| 1005 | 200 | # interfaces may have been processed previously and in that case a | ||
| 1006 | 201 | # key for it would already exist in interfaces_with_contributors; | ||
| 1007 | 202 | # that's why we use setdefault. | ||
| 1008 | 203 | interfaces_with_contributors.setdefault(interface, []) | ||
| 1009 | 204 | |||
| 1010 | 205 | # For every exported interface, check that none of its names are exported | ||
| 1011 | 206 | # in more than one contributing interface. | ||
| 1012 | 207 | for interface, contributors in interfaces_with_contributors.items(): | ||
| 1013 | 208 | if len(contributors) == 0: | ||
| 1014 | 209 | continue | ||
| 1015 | 210 | names = {} | ||
| 1016 | 211 | for iface in itertools.chain([interface], contributors): | ||
| 1017 | 212 | for name, f in iface.namesAndDescriptions(all=True): | ||
| 1018 | 213 | if f.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) is not None: | ||
| 1019 | 214 | L = names.setdefault(name, []) | ||
| 1020 | 215 | L.append(iface) | ||
| 1021 | 216 | for name, interfaces in names.items(): | ||
| 1022 | 217 | if len(interfaces) > 1: | ||
| 1023 | 218 | raise ConflictInContributingInterfaces(name, interfaces) | ||
| 1024 | 219 | return interfaces_with_contributors | ||
| 1025 | 220 | |||
| 1026 | 221 | |||
| 1027 | 222 | class ConflictInContributingInterfaces(Exception): | ||
| 1028 | 223 | """More than one interface tried to contribute a given attribute/method to | ||
| 1029 | 224 | another interface. | ||
| 1030 | 225 | """ | ||
| 1031 | 226 | |||
| 1032 | 227 | def __init__(self, name, interfaces): | ||
| 1033 | 228 | self.msg = ( | ||
| 1034 | 229 | "'%s' is exported in more than one contributing interface: %s" | ||
| 1035 | 230 | % (name, ", ".join(i.__name__ for i in interfaces))) | ||
| 1036 | 231 | |||
| 1037 | 232 | def __str__(self): | ||
| 1038 | 233 | return self.msg | ||
| 1039 | 234 | |||
| 1040 | 235 | |||
| 1041 | 236 | class AttemptToContributeToNonExportedInterface(Exception): | ||
| 1042 | 237 | """An interface contributes to another one which is not exported.""" | ||
| 1043 | 238 | |||
| 1044 | 239 | |||
| 1045 | 168 | def register_webservice(context, module): | 240 | def register_webservice(context, module): |
| 1046 | 169 | """Generate and register web service adapters. | 241 | """Generate and register web service adapters. |
| 1047 | 170 | 242 | ||
| 1048 | @@ -175,19 +247,21 @@ | |||
| 1049 | 175 | if not inspect.ismodule(module): | 247 | if not inspect.ismodule(module): |
| 1050 | 176 | raise TypeError("module attribute must be a module: %s, %s" % | 248 | raise TypeError("module attribute must be a module: %s, %s" % |
| 1051 | 177 | module, type(module)) | 249 | module, type(module)) |
| 1053 | 178 | for interface in find_exported_interfaces(module): | 250 | interfaces_with_contributors = find_interfaces_and_contributors(module) |
| 1054 | 251 | |||
| 1055 | 252 | for interface, contributors in interfaces_with_contributors.items(): | ||
| 1056 | 179 | if issubclass(interface, Exception): | 253 | if issubclass(interface, Exception): |
| 1057 | 180 | register_exception_view(context, interface) | 254 | register_exception_view(context, interface) |
| 1058 | 181 | continue | 255 | continue |
| 1059 | 182 | 256 | ||
| 1060 | 183 | tag = interface.getTaggedValue(LAZR_WEBSERVICE_EXPORTED) | 257 | tag = interface.getTaggedValue(LAZR_WEBSERVICE_EXPORTED) |
| 1062 | 184 | if tag['type'] == 'entry': | 258 | if tag['type'] == ENTRY_TYPE: |
| 1063 | 185 | context.action( | 259 | context.action( |
| 1064 | 186 | discriminator=('webservice entry interface', interface), | 260 | discriminator=('webservice entry interface', interface), |
| 1065 | 187 | callable=generate_and_register_entry_adapters, | 261 | callable=generate_and_register_entry_adapters, |
| 1067 | 188 | args=(interface, context.info), | 262 | args=(interface, context.info, contributors), |
| 1068 | 189 | ) | 263 | ) |
| 1070 | 190 | elif tag['type'] == 'collection': | 264 | elif tag['type'] == COLLECTION_TYPE: |
| 1071 | 191 | for version in tag['collection_default_content'].keys(): | 265 | for version in tag['collection_default_content'].keys(): |
| 1072 | 192 | factory = generate_collection_adapter(interface, version) | 266 | factory = generate_collection_adapter(interface, version) |
| 1073 | 193 | provides = ICollection | 267 | provides = ICollection |
| 1074 | @@ -203,11 +277,12 @@ | |||
| 1075 | 203 | raise AssertionError('Unknown export type: %s' % tag['type']) | 277 | raise AssertionError('Unknown export type: %s' % tag['type']) |
| 1076 | 204 | context.action( | 278 | context.action( |
| 1077 | 205 | discriminator=('webservice versioned operations', interface), | 279 | discriminator=('webservice versioned operations', interface), |
| 1079 | 206 | args=(context, interface), | 280 | args=(context, interface, contributors), |
| 1080 | 207 | callable=generate_and_register_webservice_operations) | 281 | callable=generate_and_register_webservice_operations) |
| 1081 | 208 | 282 | ||
| 1082 | 209 | 283 | ||
| 1084 | 210 | def generate_and_register_webservice_operations(context, interface): | 284 | def generate_and_register_webservice_operations( |
| 1085 | 285 | context, interface, contributors): | ||
| 1086 | 211 | """Create and register adapters for all exported methods. | 286 | """Create and register adapters for all exported methods. |
| 1087 | 212 | 287 | ||
| 1088 | 213 | Different versions of the web service may publish the same | 288 | Different versions of the web service may publish the same |
| 1089 | @@ -228,7 +303,11 @@ | |||
| 1090 | 228 | else: | 303 | else: |
| 1091 | 229 | block_mutator_operations_as_of_version = None | 304 | block_mutator_operations_as_of_version = None |
| 1092 | 230 | 305 | ||
| 1094 | 231 | for name, method in interface.namesAndDescriptions(True): | 306 | methods = interface.namesAndDescriptions(True) |
| 1095 | 307 | for iface in contributors: | ||
| 1096 | 308 | methods.extend(iface.namesAndDescriptions(True)) | ||
| 1097 | 309 | |||
| 1098 | 310 | for name, method in methods: | ||
| 1099 | 232 | tag = method.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) | 311 | tag = method.queryTaggedValue(LAZR_WEBSERVICE_EXPORTED) |
| 1100 | 233 | if tag is None or tag['type'] not in OPERATION_TYPES: | 312 | if tag is None or tag['type'] not in OPERATION_TYPES: |
| 1101 | 234 | # This method is not published as a named operation. | 313 | # This method is not published as a named operation. |
| 1102 | 235 | 314 | ||
| 1103 | === added file 'src/lazr/restful/testing/helpers.py' | |||
| 1104 | --- src/lazr/restful/testing/helpers.py 1970-01-01 00:00:00 +0000 | |||
| 1105 | +++ src/lazr/restful/testing/helpers.py 2010-08-05 14:04:50 +0000 | |||
| 1106 | @@ -0,0 +1,45 @@ | |||
| 1107 | 1 | import sys | ||
| 1108 | 2 | from types import ModuleType | ||
| 1109 | 3 | |||
| 1110 | 4 | from zope.configuration import xmlconfig | ||
| 1111 | 5 | from zope.interface import implements | ||
| 1112 | 6 | |||
| 1113 | 7 | from lazr.restful.interfaces import IWebServiceConfiguration | ||
| 1114 | 8 | |||
| 1115 | 9 | |||
| 1116 | 10 | def create_test_module(name, *contents): | ||
| 1117 | 11 | """Defines a new module and adds it to sys.modules.""" | ||
| 1118 | 12 | new_module = ModuleType(name) | ||
| 1119 | 13 | sys.modules['lazr.restful.' + name] = new_module | ||
| 1120 | 14 | for object in contents: | ||
| 1121 | 15 | setattr(new_module, object.__name__, object) | ||
| 1122 | 16 | return new_module | ||
| 1123 | 17 | |||
| 1124 | 18 | |||
| 1125 | 19 | def register_test_module(name, *contents): | ||
| 1126 | 20 | new_module = create_test_module(name, *contents) | ||
| 1127 | 21 | try: | ||
| 1128 | 22 | xmlconfig.string(""" | ||
| 1129 | 23 | <configure | ||
| 1130 | 24 | xmlns:webservice= | ||
| 1131 | 25 | "http://namespaces.canonical.com/webservice"> | ||
| 1132 | 26 | <include package="lazr.restful" file="meta.zcml" /> | ||
| 1133 | 27 | <webservice:register module="lazr.restful.%s" /> | ||
| 1134 | 28 | </configure> | ||
| 1135 | 29 | """ % name) | ||
| 1136 | 30 | except Exception, e: | ||
| 1137 | 31 | del sys.modules['lazr.restful.' + name] | ||
| 1138 | 32 | raise e | ||
| 1139 | 33 | return new_module | ||
| 1140 | 34 | |||
| 1141 | 35 | |||
| 1142 | 36 | class TestWebServiceConfiguration: | ||
| 1143 | 37 | implements(IWebServiceConfiguration) | ||
| 1144 | 38 | view_permission = "lazr.View" | ||
| 1145 | 39 | active_versions = ["beta", "1.0"] | ||
| 1146 | 40 | last_version_with_mutator_named_operations = "1.0" | ||
| 1147 | 41 | code_revision = "1.0b" | ||
| 1148 | 42 | default_batch_size = 50 | ||
| 1149 | 43 | |||
| 1150 | 44 | def get_request_user(self): | ||
| 1151 | 45 | return 'A user' | ||
| 1152 | 0 | 46 | ||
| 1153 | === added file 'src/lazr/restful/tests/test_declarations.py' | |||
| 1154 | --- src/lazr/restful/tests/test_declarations.py 1970-01-01 00:00:00 +0000 | |||
| 1155 | +++ src/lazr/restful/tests/test_declarations.py 2010-08-05 14:04:50 +0000 | |||
| 1156 | @@ -0,0 +1,335 @@ | |||
| 1157 | 1 | import unittest | ||
| 1158 | 2 | |||
| 1159 | 3 | from zope.component import ( | ||
| 1160 | 4 | adapts, getMultiAdapter, getSiteManager, getUtility, provideUtility) | ||
| 1161 | 5 | from zope.component.interfaces import ComponentLookupError | ||
| 1162 | 6 | from zope.interface import alsoProvides, Attribute, implements, Interface | ||
| 1163 | 7 | from zope.publisher.interfaces.http import IHTTPRequest | ||
| 1164 | 8 | from zope.schema import Int, Object, TextLine | ||
| 1165 | 9 | from zope.security.checker import MultiChecker, ProxyFactory | ||
| 1166 | 10 | from zope.security.management import endInteraction, newInteraction | ||
| 1167 | 11 | |||
| 1168 | 12 | from lazr.restful.declarations import ( | ||
| 1169 | 13 | export_as_webservice_entry, exported, export_read_operation, | ||
| 1170 | 14 | export_write_operation, mutator_for, operation_for_version, | ||
| 1171 | 15 | operation_parameters) | ||
| 1172 | 16 | from lazr.restful.interfaces import ( | ||
| 1173 | 17 | IEntry, IResourceGETOperation, IWebServiceConfiguration, | ||
| 1174 | 18 | IWebServiceVersion) | ||
| 1175 | 19 | from lazr.restful.marshallers import SimpleFieldMarshaller | ||
| 1176 | 20 | from lazr.restful.metazcml import ( | ||
| 1177 | 21 | AttemptToContributeToNonExportedInterface, | ||
| 1178 | 22 | ConflictInContributingInterfaces, find_interfaces_and_contributors) | ||
| 1179 | 23 | from lazr.restful._resource import EntryAdapterUtility, EntryResource | ||
| 1180 | 24 | from lazr.restful.testing.webservice import FakeRequest | ||
| 1181 | 25 | from lazr.restful.testing.helpers import ( | ||
| 1182 | 26 | create_test_module, TestWebServiceConfiguration, register_test_module) | ||
| 1183 | 27 | |||
| 1184 | 28 | |||
| 1185 | 29 | class ContributingInterfacesTestCase(unittest.TestCase): | ||
| 1186 | 30 | """Tests for interfaces that contribute fields/operations to others.""" | ||
| 1187 | 31 | |||
| 1188 | 32 | def setUp(self): | ||
| 1189 | 33 | provideUtility( | ||
| 1190 | 34 | TestWebServiceConfiguration(), IWebServiceConfiguration) | ||
| 1191 | 35 | sm = getSiteManager() | ||
| 1192 | 36 | sm.registerUtility( | ||
| 1193 | 37 | ITestServiceRequestBeta, IWebServiceVersion, name='beta') | ||
| 1194 | 38 | sm.registerUtility( | ||
| 1195 | 39 | ITestServiceRequest10, IWebServiceVersion, name='1.0') | ||
| 1196 | 40 | sm.registerAdapter(ProductToHasBugsAdapter) | ||
| 1197 | 41 | sm.registerAdapter(ProjectToHasBugsAdapter) | ||
| 1198 | 42 | sm.registerAdapter(ProductToHasBranchesAdapter) | ||
| 1199 | 43 | sm.registerAdapter(DummyFieldMarshaller) | ||
| 1200 | 44 | self.beta_request = FakeRequest(version='beta') | ||
| 1201 | 45 | alsoProvides( | ||
| 1202 | 46 | self.beta_request, getUtility(IWebServiceVersion, name='beta')) | ||
| 1203 | 47 | self.one_zero_request = FakeRequest(version='1.0') | ||
| 1204 | 48 | alsoProvides( | ||
| 1205 | 49 | self.one_zero_request, getUtility(IWebServiceVersion, name='1.0')) | ||
| 1206 | 50 | self.product = Product() | ||
| 1207 | 51 | self.project = Project() | ||
| 1208 | 52 | |||
| 1209 | 53 | def test_attributes(self): | ||
| 1210 | 54 | # The bug_count field comes from IHasBugs (which IProduct does not | ||
| 1211 | 55 | # provide, although it can be adapted into) but that field is | ||
| 1212 | 56 | # available in the webservice (IEntry) adapter for IProduct, and that | ||
| 1213 | 57 | # adapter knows it needs to adapt the product into an IHasBugs to | ||
| 1214 | 58 | # access .bug_count. | ||
| 1215 | 59 | self.product._bug_count = 10 | ||
| 1216 | 60 | register_test_module('testmod', IProduct, IHasBugs) | ||
| 1217 | 61 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1218 | 62 | self.assertEqual(adapter.bug_count, 10) | ||
| 1219 | 63 | |||
| 1220 | 64 | def test_operations(self): | ||
| 1221 | 65 | # Although getBugsCount() is not provided by IProduct, it is available | ||
| 1222 | 66 | # on the webservice adapter as IHasBugs contributes it to IProduct. | ||
| 1223 | 67 | self.product._bug_count = 10 | ||
| 1224 | 68 | register_test_module('testmod', IProduct, IHasBugs) | ||
| 1225 | 69 | adapter = getMultiAdapter( | ||
| 1226 | 70 | (self.product, self.beta_request), | ||
| 1227 | 71 | IResourceGETOperation, name='getBugsCount') | ||
| 1228 | 72 | self.assertEqual(adapter(), '10') | ||
| 1229 | 73 | |||
| 1230 | 74 | def test_contributing_interface_with_differences_between_versions(self): | ||
| 1231 | 75 | # In the 'beta' version, IHasBranches.development_branches is exported | ||
| 1232 | 76 | # with its original name whereas for the '1.0' version it's exported | ||
| 1233 | 77 | # as 'development_branch_10'. | ||
| 1234 | 78 | self.product._dev_branch = Branch('A product branch') | ||
| 1235 | 79 | register_test_module('testmod', IProduct, IHasBranches) | ||
| 1236 | 80 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1237 | 81 | self.assertEqual(adapter.development_branch, self.product._dev_branch) | ||
| 1238 | 82 | |||
| 1239 | 83 | adapter = getMultiAdapter( | ||
| 1240 | 84 | (self.product, self.one_zero_request), IEntry) | ||
| 1241 | 85 | self.assertEqual( | ||
| 1242 | 86 | adapter.development_branch_10, self.product._dev_branch) | ||
| 1243 | 87 | |||
| 1244 | 88 | def test_mutator_for_just_one_version(self): | ||
| 1245 | 89 | # On the 'beta' version, IHasBranches contributes a read only | ||
| 1246 | 90 | # development_branch field, but on version '1.0' that field can be | ||
| 1247 | 91 | # modified as we define a mutator for it. | ||
| 1248 | 92 | self.product._dev_branch = Branch('A product branch') | ||
| 1249 | 93 | register_test_module('testmod', IProduct, IHasBranches) | ||
| 1250 | 94 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1251 | 95 | try: | ||
| 1252 | 96 | adapter.development_branch = None | ||
| 1253 | 97 | except AttributeError: | ||
| 1254 | 98 | pass | ||
| 1255 | 99 | else: | ||
| 1256 | 100 | self.fail('IHasBranches.development_branch should be read-only ' | ||
| 1257 | 101 | 'on the beta version') | ||
| 1258 | 102 | |||
| 1259 | 103 | adapter = getMultiAdapter( | ||
| 1260 | 104 | (self.product, self.one_zero_request), IEntry) | ||
| 1261 | 105 | self.assertEqual( | ||
| 1262 | 106 | adapter.development_branch_10, self.product._dev_branch) | ||
| 1263 | 107 | adapter.development_branch_10 = None | ||
| 1264 | 108 | self.assertEqual( | ||
| 1265 | 109 | adapter.development_branch_10, None) | ||
| 1266 | 110 | |||
| 1267 | 111 | def test_contributing_to_multiple_interfaces(self): | ||
| 1268 | 112 | # Check that the webservice adapter for both IProduct and IProject | ||
| 1269 | 113 | # have the IHasBugs attributes, as that interface contributes to them. | ||
| 1270 | 114 | self.product._bug_count = 10 | ||
| 1271 | 115 | self.project._bug_count = 100 | ||
| 1272 | 116 | register_test_module('testmod', IProduct, IProject, IHasBugs) | ||
| 1273 | 117 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1274 | 118 | self.assertEqual(adapter.bug_count, 10) | ||
| 1275 | 119 | |||
| 1276 | 120 | adapter = getMultiAdapter((self.project, self.beta_request), IEntry) | ||
| 1277 | 121 | self.assertEqual(adapter.bug_count, 100) | ||
| 1278 | 122 | |||
| 1279 | 123 | def test_multiple_contributing_interfaces(self): | ||
| 1280 | 124 | # Check that the webservice adapter for IProduct has the attributes | ||
| 1281 | 125 | # from both IHasBugs and IHasBranches. | ||
| 1282 | 126 | self.product._bug_count = 10 | ||
| 1283 | 127 | self.product._dev_branch = Branch('A product branch') | ||
| 1284 | 128 | register_test_module('testmod', IProduct, IHasBugs, IHasBranches) | ||
| 1285 | 129 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1286 | 130 | self.assertEqual(adapter.bug_count, 10) | ||
| 1287 | 131 | self.assertEqual(adapter.development_branch, self.product._dev_branch) | ||
| 1288 | 132 | |||
| 1289 | 133 | def test_redacted_fields_with_no_permission_checker(self): | ||
| 1290 | 134 | # When looking up an entry's redacted_fields, we take into account the | ||
| 1291 | 135 | # interface where the field is defined and adapt the context to that | ||
| 1292 | 136 | # interface before accessing that field. | ||
| 1293 | 137 | register_test_module('testmod', IProduct, IHasBugs, IHasBranches) | ||
| 1294 | 138 | entry_resource = EntryResource(self.product, self.beta_request) | ||
| 1295 | 139 | self.assertEquals([], entry_resource.redacted_fields) | ||
| 1296 | 140 | |||
| 1297 | 141 | def test_redacted_fields_with_permission_checker(self): | ||
| 1298 | 142 | # When looking up an entry's redacted_fields for an object which is | ||
| 1299 | 143 | # security proxied, we use the security checker for the interface | ||
| 1300 | 144 | # where the field is defined. | ||
| 1301 | 145 | register_test_module('testmod', IProduct, IHasBugs, IHasBranches) | ||
| 1302 | 146 | newInteraction() | ||
| 1303 | 147 | try: | ||
| 1304 | 148 | secure_product = ProxyFactory( | ||
| 1305 | 149 | self.product, | ||
| 1306 | 150 | checker=MultiChecker([(IProduct, 'zope.Public')])) | ||
| 1307 | 151 | entry_resource = EntryResource(secure_product, self.beta_request) | ||
| 1308 | 152 | self.assertEquals([], entry_resource.redacted_fields) | ||
| 1309 | 153 | finally: | ||
| 1310 | 154 | endInteraction() | ||
| 1311 | 155 | |||
| 1312 | 156 | def test_duplicate_contributed_attributes(self): | ||
| 1313 | 157 | # We do not allow a given attribute to be contributed to a given | ||
| 1314 | 158 | # interface by more than one contributing interface. | ||
| 1315 | 159 | testmod = create_test_module('testmod', IProduct, IHasBugs, IHasBugs2) | ||
| 1316 | 160 | self.assertRaises( | ||
| 1317 | 161 | ConflictInContributingInterfaces, | ||
| 1318 | 162 | find_interfaces_and_contributors, testmod) | ||
| 1319 | 163 | |||
| 1320 | 164 | def test_contributing_interface_not_exported(self): | ||
| 1321 | 165 | # Contributing interfaces are not exported by themselves -- they only | ||
| 1322 | 166 | # contribute their exported fields/operations to other entries. | ||
| 1323 | 167 | class DummyHasBranches: | ||
| 1324 | 168 | implements(IHasBranches) | ||
| 1325 | 169 | dummy = DummyHasBranches() | ||
| 1326 | 170 | register_test_module('testmod', IProduct, IHasBranches) | ||
| 1327 | 171 | self.assertRaises( | ||
| 1328 | 172 | ComponentLookupError, | ||
| 1329 | 173 | getMultiAdapter, (dummy, self.beta_request), IEntry) | ||
| 1330 | 174 | |||
| 1331 | 175 | def test_cannot_contribute_to_non_exported_interface(self): | ||
| 1332 | 176 | # A contributing interface can only contribute to exported interfaces. | ||
| 1333 | 177 | class INotExported(Interface): | ||
| 1334 | 178 | pass | ||
| 1335 | 179 | class IContributor(Interface): | ||
| 1336 | 180 | export_as_webservice_entry(contributes_to=[INotExported]) | ||
| 1337 | 181 | title = exported(TextLine(title=u'The project title')) | ||
| 1338 | 182 | testmod = create_test_module('testmod', IContributor, INotExported) | ||
| 1339 | 183 | self.assertRaises( | ||
| 1340 | 184 | AttemptToContributeToNonExportedInterface, | ||
| 1341 | 185 | find_interfaces_and_contributors, testmod) | ||
| 1342 | 186 | |||
| 1343 | 187 | def test_duplicate_contributed_methods(self): | ||
| 1344 | 188 | # We do not allow a given method to be contributed to a given | ||
| 1345 | 189 | # interface by more than one contributing interface. | ||
| 1346 | 190 | testmod = create_test_module('testmod', IProduct, IHasBugs, IHasBugs3) | ||
| 1347 | 191 | self.assertRaises( | ||
| 1348 | 192 | ConflictInContributingInterfaces, | ||
| 1349 | 193 | find_interfaces_and_contributors, testmod) | ||
| 1350 | 194 | |||
| 1351 | 195 | def test_ConflictInContributingInterfaces(self): | ||
| 1352 | 196 | # The ConflictInContributingInterfaces exception states what are the | ||
| 1353 | 197 | # contributing interfaces that caused the conflict. | ||
| 1354 | 198 | e = ConflictInContributingInterfaces('foo', [IHasBugs, IHasBugs2]) | ||
| 1355 | 199 | expected_msg = ("'foo' is exported in more than one contributing " | ||
| 1356 | 200 | "interface: IHasBugs, IHasBugs2") | ||
| 1357 | 201 | self.assertEquals(str(e), expected_msg) | ||
| 1358 | 202 | |||
| 1359 | 203 | def test_type_name(self): | ||
| 1360 | 204 | # Even though the generated adapters will contain stuff from various | ||
| 1361 | 205 | # different adapters, its type name is that of the main interface and | ||
| 1362 | 206 | # not one of its contributors. | ||
| 1363 | 207 | register_test_module('testmod', IProduct, IHasBugs) | ||
| 1364 | 208 | adapter = getMultiAdapter((self.product, self.beta_request), IEntry) | ||
| 1365 | 209 | self.assertEqual( | ||
| 1366 | 210 | 'product', EntryAdapterUtility(adapter.__class__).singular_type) | ||
| 1367 | 211 | |||
| 1368 | 212 | |||
| 1369 | 213 | class IProduct(Interface): | ||
| 1370 | 214 | export_as_webservice_entry() | ||
| 1371 | 215 | title = exported(TextLine(title=u'The product title')) | ||
| 1372 | 216 | # Need to define the two attributes below because we have a test which | ||
| 1373 | 217 | # wraps a Product object with a security proxy and later uses adapters | ||
| 1374 | 218 | # that access _dev_branch and _bug_count. | ||
| 1375 | 219 | _dev_branch = Attribute('dev branch') | ||
| 1376 | 220 | _bug_count = Attribute('bug count') | ||
| 1377 | 221 | |||
| 1378 | 222 | |||
| 1379 | 223 | class Product(object): | ||
| 1380 | 224 | implements(IProduct) | ||
| 1381 | 225 | title = 'A product' | ||
| 1382 | 226 | _bug_count = 0 | ||
| 1383 | 227 | _dev_branch = None | ||
| 1384 | 228 | |||
| 1385 | 229 | |||
| 1386 | 230 | class IProject(Interface): | ||
| 1387 | 231 | export_as_webservice_entry() | ||
| 1388 | 232 | title = exported(TextLine(title=u'The project title')) | ||
| 1389 | 233 | |||
| 1390 | 234 | |||
| 1391 | 235 | class Project(object): | ||
| 1392 | 236 | implements(IProject) | ||
| 1393 | 237 | title = 'A project' | ||
| 1394 | 238 | _bug_count = 0 | ||
| 1395 | 239 | |||
| 1396 | 240 | |||
| 1397 | 241 | class IHasBugs(Interface): | ||
| 1398 | 242 | export_as_webservice_entry(contributes_to=[IProduct, IProject]) | ||
| 1399 | 243 | bug_count = exported(Int(title=u'Number of bugs')) | ||
| 1400 | 244 | not_exported = TextLine(title=u'Not exported') | ||
| 1401 | 245 | |||
| 1402 | 246 | @export_read_operation() | ||
| 1403 | 247 | def getBugsCount(): | ||
| 1404 | 248 | pass | ||
| 1405 | 249 | |||
| 1406 | 250 | |||
| 1407 | 251 | class IHasBugs2(Interface): | ||
| 1408 | 252 | export_as_webservice_entry(contributes_to=[IProduct]) | ||
| 1409 | 253 | bug_count = exported(Int(title=u'Number of bugs')) | ||
| 1410 | 254 | not_exported = TextLine(title=u'Not exported') | ||
| 1411 | 255 | |||
| 1412 | 256 | |||
| 1413 | 257 | class IHasBugs3(Interface): | ||
| 1414 | 258 | export_as_webservice_entry(contributes_to=[IProduct]) | ||
| 1415 | 259 | not_exported = TextLine(title=u'Not exported') | ||
| 1416 | 260 | |||
| 1417 | 261 | @export_read_operation() | ||
| 1418 | 262 | def getBugsCount(): | ||
| 1419 | 263 | pass | ||
| 1420 | 264 | |||
| 1421 | 265 | |||
| 1422 | 266 | class ProductToHasBugsAdapter(object): | ||
| 1423 | 267 | adapts(IProduct) | ||
| 1424 | 268 | implements(IHasBugs) | ||
| 1425 | 269 | |||
| 1426 | 270 | def __init__(self, context): | ||
| 1427 | 271 | self.context = context | ||
| 1428 | 272 | self.bug_count = context._bug_count | ||
| 1429 | 273 | |||
| 1430 | 274 | def getBugsCount(self): | ||
| 1431 | 275 | return self.bug_count | ||
| 1432 | 276 | |||
| 1433 | 277 | |||
| 1434 | 278 | class ProjectToHasBugsAdapter(ProductToHasBugsAdapter): | ||
| 1435 | 279 | adapts(IProject) | ||
| 1436 | 280 | |||
| 1437 | 281 | |||
| 1438 | 282 | class IBranch(Interface): | ||
| 1439 | 283 | name = TextLine(title=u'The branch name') | ||
| 1440 | 284 | |||
| 1441 | 285 | |||
| 1442 | 286 | class Branch(object): | ||
| 1443 | 287 | implements(IBranch) | ||
| 1444 | 288 | |||
| 1445 | 289 | def __init__(self, name): | ||
| 1446 | 290 | self.name = name | ||
| 1447 | 291 | |||
| 1448 | 292 | |||
| 1449 | 293 | class IHasBranches(Interface): | ||
| 1450 | 294 | export_as_webservice_entry(contributes_to=[IProduct]) | ||
| 1451 | 295 | not_exported = TextLine(title=u'Not exported') | ||
| 1452 | 296 | development_branch = exported( | ||
| 1453 | 297 | Object(schema=IBranch, readonly=True), | ||
| 1454 | 298 | ('1.0', dict(exported_as='development_branch_10')), | ||
| 1455 | 299 | ('beta', dict(exported_as='development_branch'))) | ||
| 1456 | 300 | |||
| 1457 | 301 | @mutator_for(development_branch) | ||
| 1458 | 302 | @export_write_operation() | ||
| 1459 | 303 | @operation_parameters(value=TextLine()) | ||
| 1460 | 304 | @operation_for_version('1.0') | ||
| 1461 | 305 | def set_dev_branch(value): | ||
| 1462 | 306 | pass | ||
| 1463 | 307 | |||
| 1464 | 308 | |||
| 1465 | 309 | class ProductToHasBranchesAdapter(object): | ||
| 1466 | 310 | adapts(IProduct) | ||
| 1467 | 311 | implements(IHasBranches) | ||
| 1468 | 312 | |||
| 1469 | 313 | def __init__(self, context): | ||
| 1470 | 314 | self.context = context | ||
| 1471 | 315 | |||
| 1472 | 316 | @property | ||
| 1473 | 317 | def development_branch(self): | ||
| 1474 | 318 | return self.context._dev_branch | ||
| 1475 | 319 | |||
| 1476 | 320 | def set_dev_branch(self, value): | ||
| 1477 | 321 | self.context._dev_branch = value | ||
| 1478 | 322 | |||
| 1479 | 323 | |||
| 1480 | 324 | # One of our tests will try to unmarshall some entries, but even though we | ||
| 1481 | 325 | # don't care about the unmarshalling itself, we need to register a generic | ||
| 1482 | 326 | # marshaller so that the adapter lookup doesn't fail and cause an error on the | ||
| 1483 | 327 | # test. | ||
| 1484 | 328 | class DummyFieldMarshaller(SimpleFieldMarshaller): | ||
| 1485 | 329 | adapts(Interface, IHTTPRequest) | ||
| 1486 | 330 | |||
| 1487 | 331 | |||
| 1488 | 332 | class ITestServiceRequestBeta(IWebServiceVersion): | ||
| 1489 | 333 | pass | ||
| 1490 | 334 | class ITestServiceRequest10(IWebServiceVersion): | ||
| 1491 | 335 | pass | ||
| 1492 | 0 | 336 | ||
| 1493 | === modified file 'src/lazr/restful/version.txt' | |||
| 1494 | --- src/lazr/restful/version.txt 2010-06-14 15:29:08 +0000 | |||
| 1495 | +++ src/lazr/restful/version.txt 2010-08-05 14:04:50 +0000 | |||
| 1496 | @@ -1,1 +1,1 @@ | |||
| 1498 | 1 | 0.9.29 | 1 | 0.10.0 |
This branch is slow going but I have one suggestion. Can you test this assertion?
+ assert name in orig_iface, (
+ "Could not find interface where %s is defined" % name)
I don't see how it could be triggered. But maye the point is that it never is triggered?