Merge lp:~adiroiban/launchpad/bug-525371 into lp:launchpad

[Adi Roiban]

Export POTemplate attributes in the API.

= Bug 525371 =

To help creating various translations statistics (ie for Ubuntu translations) it would be nice to have an LP API that could export the following information about a POTemplate:

 * template name in Launchpad
 * priority
 * length
 * date last updated
 * domain name
 * iscurrent (active or not)
 * source package
 * is in lang pack
 * in how many languages it is translates (nice to have)

The API should return a list of all templates for a series, but also the info for a single template

The requirements are tracked on this wiki page:
https://dev.launchpad.net/Translations/Specs/ReportingAPI

== Proposed fix ==

This is the first step in implementing an API for POTemplates.

We will start with exposing the POTemplates attributes.

Here are the exported attributes:

    active: True
    all_pofiles_collection_link: u'http://.../pmount/+pots/pmount/all_pofiles'
    date_last_updated: u'2005-05-06T20:09:23.775993+00:00'
    description: None
    exported_in_languagepacks: True
    format: u'PO format'
    id: 2
    language_count: 8
    message_count: 63
    name: u'pmount'
    owner_link: u'http://.../~rosetta-admins'
    path: u'po/template.pot'
    priority: 0
    resource_type_link: u'http://.../#potemplate'
    self_link: u'http://.../ubuntu/hoary/+source/pmount/+pots/pmount'
    translation_domain: u'pmount'

== Pre-implementation notes ==

During the last UDS I have talked with Henning and we had a pre-implementation talk.
He agreed with the current exported attributes. He said that he can not comment on the technical implementation details for the API.

If you think it is needed you can ask someone experienced with the LP API to review this branch.

== Implementation details ==

POFile API export is just a stub to illustrate how pofiles are linked to the corresponding po templates.

I don't know how to fix the /usr/share lint errors. Any hints are much appreciated.

== Tests ==

  lib/lp/registry/stories/webservice/xx-distroseries.txt
  lib/lp/registry/stories/webservice/xx-project-registry.txt
  lib/lp/registry/stories/webservice/xx-source-package.txt
  lib/lp/translations/stories/webservice/xx-potemplate.txt

== Demo and Q/A ==

To get the potemplates for a sourcepackage
curl -ks https://launchpad.dev/api/devel/ubuntu/hoary/+source/evolution/all_translation_templates

To get the potemplates for a productseries
curl -ks https://launchpad.dev/api/devel/evolution/trunk/all_translation_templates

To get the potemplates for a distroseries
curl -ks https://launchpad.dev/api/devel/ubuntu/hoary/all_translation_templates

"all_translation_templates" are linked from the sourcepackage, distroseries and productseries
curl -ks https://launchpad.dev/api/devel/ubuntu/hoary/+source/evolution
curl -ks https://launchpad.dev/api/devel/ubuntu/hoary
curl -ks https://launchpad.dev/api/devel/evolution/trunk

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/translations/interfaces/webservice.py

== Pyflakes notices ==

lib/lp/translations/interfaces/webservice.py
    8: 'IHasTranslationImports' imported but unused
    8: 'ITranslationImportQueue' imported but unused
    8: 'ITranslationImportQueueEntry' imported but unused
    13: 'IPOTemplate' imported but unused
    15: 'IPOFile' imported but unused
warning: Not importing directory '/usr/share/pyshared/lazr': missing __init__.py
warning: Not importing directory '/usr/share/pyshared/lazr': missing __init__.py
warning: Not importing directory '/usr/share/pyshared/lazr': missing __init__.py

[Jeroen T. Vermeulen (jtv)]

Hi Adi,

It's really great that you're doing this. I'm reading it through and it looks good to me so far. One note though about the testing in xx-distroseries.txt.

You've got the problem here that you have to rely on existing test data, which can be a bit arbitrary. For example, the fact that there are 6 templates in the distroseries is pretty meaningless in the context of the test. But it's a lot of trouble to set up a fresh distroseries with fresh translation templates, especially if the existing tests don't do it either.

So here's an idea: instead of printing the exact number of templates, why not show that int(all_translation_templates['total_size']) is identical to len(list(getUtility(ILaunchpadCelebrities).ubuntu.getSeries('hoary'))).

Jeroen

[Adi Roiban (adiroiban)]

Hi,

I have improved the tests to check for templates count from the db.

Here is the latest diff:

=== modified file 'lib/lp/registry/stories/webservice/xx-distroseries.txt'
--- lib/lp/registry/stories/webservice/xx-distroseries.txt 2010-05-17 09:35:18 +0000
+++ lib/lp/registry/stories/webservice/xx-distroseries.txt 2010-05-18 14:51:40 +0000
@@ -107,9 +107,19 @@
 All templates associated to a distribution series are available at the
 'all_translation_templates' collection link.

+ >>> from zope.component import getUtility
+ >>> from canonical.launchpad.interfaces.launchpad import (
+ ... ILaunchpadCelebrities)
+ >>> from lp.translations.interfaces.potemplate import IPOTemplateSet
+ >>> login('<email address hidden>')
+ >>> hoary = getUtility(ILaunchpadCelebrities).ubuntu.getSeries('hoary')
+ >>> templates = getUtility(IPOTemplateSet).getSubset(distroseries=hoary)
+ >>> db_count = len(list(templates))
+ >>> logout()
     >>> all_translation_templates = anon_webservice.get(
     ... '/ubuntu/hoary/all_translation_templates').jsonBody()
- >>> print all_translation_templates['total_size']
- 6
+ >>> api_count = all_translation_templates['total_size']
+ >>> api_count == db_count
+ True
     >>> print(all_translation_templates['entries'][0]['resource_type_link'])
     http://.../#potemplate

=== modified file 'lib/lp/registry/stories/webservice/xx-project-registry.txt'
--- lib/lp/registry/stories/webservice/xx-project-registry.txt 2010-05-17 09:35:18 +0000
+++ lib/lp/registry/stories/webservice/xx-project-registry.txt 2010-05-18 15:10:45 +0000
@@ -897,11 +897,20 @@
 "all_translation_templates" will list all POTemplates associated with this
 product series.

+
+ >>> from zope.component import getUtility
+ >>> from lp.translations.interfaces.potemplate import IPOTemplateSet
+ >>> login('<email address hidden>')
+ >>> templates = getUtility(
+ ... IPOTemplateSet).getSubset(productseries=foobadoo)
+ >>> db_count = len(list(templates))
+ >>> logout()
     >>> all_translation_templates = anon_webservice.get(
     ... babadoo_foobadoo[
     ... 'all_translation_templates_collection_link']).jsonBody()
- >>> print all_translation_templates['total_size']
- 1
+ >>> api_count = all_translation_templates['total_size']
+ >>> api_count == db_count
+ True
     >>> print(all_translation_templates['entries'][0]['resource_type_link'])
     http://.../#potemplate

=== modified file 'lib/lp/registry/stories/webservice/xx-source-package.txt'
--- lib/lp/registry/stories/webservice/xx-source-package.txt 2010-05-17 09:35:18 +0000
+++ lib/lp/registry/stories/webservice/xx-source-package.txt 2010-05-18 15:23:51 +0000
@@ -130,10 +130,27 @@
 All translation templates for a source package are available at the
 'all_translation_templates' collection link.

+
+ >>> from zope.component import getUtility
+ >>> from canonical.launchpad.interfaces.launchpad import (
+ ... ILaunchpadCelebrities)
+ >>> from lp.registry.interfaces.sourcepackagename import (
+ ... ISourcePackageNameSet)
+ >>> from lp.translations.interfaces.potemplate import IPOTemplateSet
+ >...

[Данило Шеган (danilo)]

Hi Adi,

Thanks a lot for the work on this. Overall, it's pretty good.

У пон, 17. 05 2010. у 11:07 +0000, Adi Roiban пише:

> == Tests ==
>
> lib/lp/registry/stories/webservice/xx-distroseries.txt
> lib/lp/registry/stories/webservice/xx-project-registry.txt
> lib/lp/registry/stories/webservice/xx-source-package.txt
> lib/lp/translations/stories/webservice/xx-potemplate.txt

It usually helps if you provide a bin/test command which runs them for
lazy reviewers to copy-paste them :)

> == Demo and Q/A ==
>
> To get the potemplates for a sourcepackage
> curl -ks
https://launchpad.dev/api/devel/ubuntu/hoary/+source/evolution/all_translation_templates
>
> To get the potemplates for a productseries
> curl -ks
https://launchpad.dev/api/devel/evolution/trunk/all_translation_templates
>
> To get the potemplates for a distroseries
> curl -ks
https://launchpad.dev/api/devel/ubuntu/hoary/all_translation_templates
>
> "all_translation_templates" are linked from the sourcepackage,
distroseries and productseries
> curl -ks
https://launchpad.dev/api/devel/ubuntu/hoary/+source/evolution
> curl -ks https://launchpad.dev/api/devel/ubuntu/hoary
> curl -ks https://launchpad.dev/api/devel/evolution/trunk
>
> = Launchpad lint =
>
> Checking for conflicts. and issues in doctests and templates.
> Running jslint, xmllint, pyflakes, and pylint.
> Using normal rules.
>
> Linting changed files:
> lib/lp/translations/interfaces/webservice.py

There are many more files with many more lint issues: you should try to
run it after you commit your final change, not before (if you've got
uncommitted changes, it lints just the uncommitted files). Please fix
all the issues.

> == Pyflakes notices ==
>
> lib/lp/translations/interfaces/webservice.py
> 8: 'IHasTranslationImports' imported but unused
> 8: 'ITranslationImportQueue' imported but unused
> 8: 'ITranslationImportQueueEntry' imported but unused
> 13: 'IPOTemplate' imported but unused
> 15: 'IPOFile' imported but unused

You should add the following to webservice.py if that's the intention:

__all__ = [
    'IHasTranslationImports',
    'IPOFile',
    'IPOTemplate',
    'ITranslationImportQueue',
    'ITranslationImportQueueEntry',
    ]

But, why is this necessary?

> warning: Not importing directory '/usr/share/pyshared/lazr': missing
__init__.py
> warning: Not importing directory '/usr/share/pyshared/lazr': missing
__init__.py
> warning: Not importing directory '/usr/share/pyshared/lazr': missing
__init__.py

This might be a bug in lazr that needs fixing. Can you please check and
file appropriate bug if it is?

> === modified file 'lib/canonical/launchpad/security.py'
> --- lib/canonical/launchpad/security.py 2010-05-17 12:43:53
+0000
> +++ lib/canonical/launchpad/security.py 2010-05-19 12:09:43
+0000
> @@ -61,8 +61,7 @@ from lp.hardwaredb.interfaces.hwdb impor
> from lp.services.worlddata.interfaces.language import ILanguage,
ILanguageSet
> from lp.translations.interfaces.languagepack import ILanguagePack
> from canonical.launchpad.interfaces.launchpad import (
> - IBazaarApplication, IHasBug, IHasDrivers, ILaunchpadCelebrities,
> - IPersonRoles)
> + IHas...

[Данило Шеган (danilo)]

review: Needs Fixing

[Adi Roiban (adiroiban)]

On Wed, 2010-05-19 at 14:43 +0000, Данило Шеган wrote:
> Hi Adi,
>
> Thanks a lot for the work on this. Overall, it's pretty good.
>
> У пон, 17. 05 2010. у 11:07 +0000, Adi Roiban пише:
>
> > == Tests ==
> >
> > lib/lp/registry/stories/webservice/xx-distroseries.txt
> > lib/lp/registry/stories/webservice/xx-project-registry.txt
> > lib/lp/registry/stories/webservice/xx-source-package.txt
> > lib/lp/translations/stories/webservice/xx-potemplate.txt
>
> It usually helps if you provide a bin/test command which runs them for
> lazy reviewers to copy-paste them :)

Sorry. I will add it with the next MP.

./bin/test -t xx-potemplate.txt -t xx-distroseries.txt \
 -t xx-project-registry.txt -t xx-source-package.txt

:)

[snip]
> > = Launchpad lint =
> >
> > Checking for conflicts. and issues in doctests and templates.
> > Running jslint, xmllint, pyflakes, and pylint.
> > Using normal rules.
> >
> > Linting changed files:
> > lib/lp/translations/interfaces/webservice.py
>
> There are many more files with many more lint issues: you should try to
> run it after you commit your final change, not before (if you've got
> uncommitted changes, it lints just the uncommitted files). Please fix
> all the issues.

I have fixed some of the other warning.

There are still some warnings for code like:

    @operation_parameters(
        pocket=Choice(
            title=_("Pocket"), required=True,
            vocabulary=DBEnumeratedType))

and it looks fine to me, but pylint complains about:

lib/lp/registry/interfaces/sourcepackage.py
    191: [C0322, ISourcePackage.getBranch] Operator not preceded by a
space
    required=True,
    ^
    vocabulary=DBEnumeratedType))

> > == Pyflakes notices ==
> >
> > lib/lp/translations/interfaces/webservice.py
> > 8: 'IHasTranslationImports' imported but unused
> > 8: 'ITranslationImportQueue' imported but unused
> > 8: 'ITranslationImportQueueEntry' imported but unused
> > 13: 'IPOTemplate' imported but unused
> > 15: 'IPOFile' imported but unused
>
> You should add the following to webservice.py if that's the intention:
>
> __all__ = [
> 'IHasTranslationImports',
> 'IPOFile',
> 'IPOTemplate',
> 'ITranslationImportQueue',
> 'ITranslationImportQueueEntry',
> ]
>
> But, why is this necessary?

Only interfaces listed in webservices.py will be exported by
lazr.restful.

Adding __all__ will still generate Pyflakes notices as they are still
unused in that file.

> > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> __init__.py
> > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> __init__.py
> > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> __init__.py
>
> This might be a bug in lazr that needs fixing. Can you please check and
> file appropriate bug if it is?

Is is not a problem in lazr. I have the same problem with:
'/usr/share/pyshared/google': missing __init__.py

Those file were installed as dependencies for ubuntuone-client-gnome by
python-protobuf and python-lazr-uri, python-lazr-restfulclient and are
maintained by main Ubuntu developers... not in the LP PPA.

> > === modified file 'lib/...

[Данило Шеган (danilo)]

Hi Adi,

Thanks for the updates. There's still just a little bit more to do :)

У сре, 19. 05 2010. у 20:13 +0000, Adi Roiban пише:

> There are still some warnings for code like:
>
> @operation_parameters(
> pocket=Choice(
> title=_("Pocket"), required=True,
> vocabulary=DBEnumeratedType))
>
> and it looks fine to me, but pylint complains about:
>
> lib/lp/registry/interfaces/sourcepackage.py
> 191: [C0322, ISourcePackage.getBranch] Operator not preceded by a
> space
> required=True,
> ^
> vocabulary=DBEnumeratedType))
>
>
> > > == Pyflakes notices ==
> > >
> > > lib/lp/translations/interfaces/webservice.py
> > > 8: 'IHasTranslationImports' imported but unused
> > > 8: 'ITranslationImportQueue' imported but unused
> > > 8: 'ITranslationImportQueueEntry' imported but unused
> > > 13: 'IPOTemplate' imported but unused
> > > 15: 'IPOFile' imported but unused
> >
> > You should add the following to webservice.py if that's the intention:
> >
> > __all__ = [
> > 'IHasTranslationImports',
> > 'IPOFile',
> > 'IPOTemplate',
> > 'ITranslationImportQueue',
> > 'ITranslationImportQueueEntry',
> > ]
> >
> > But, why is this necessary?
>
> Only interfaces listed in webservices.py will be exported by
> lazr.restful.
>
> Adding __all__ will still generate Pyflakes notices as they are still
> unused in that file.

It actually fixed it for me. I'm attaching a patch which fixes all the
lint issues I've seen. It would be nicer if you did that instead :)

Also, "operator not preceded by space" lint issues in this particular
context seem to be opposed to our style guide. It would be best to
raise this on launchpad-dev mailing list to come to an agreement and to
see if we can fix either pylint or style guide.

> > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > __init__.py
> > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > __init__.py
> > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > __init__.py
> >
> > This might be a bug in lazr that needs fixing. Can you please check and
> > file appropriate bug if it is?
>
> Is is not a problem in lazr. I have the same problem with:
> '/usr/share/pyshared/google': missing __init__.py
>
> Those file were installed as dependencies for ubuntuone-client-gnome by
> python-protobuf and python-lazr-uri, python-lazr-restfulclient and are
> maintained by main Ubuntu developers... not in the LP PPA.

Well, LAZR is a library shared between Launchpad and UbuntuOne. It's
still a bug that would need to be filed. I've worked-around it locally
by doing "sudo touch /usr/share/pyshared/lazr/__init__.py", and there is
probably no reason why the package shouldn't do the same for everybody.

> Should POTemplate and POFile API be available only to authenticated
> users?

Not, it's fine if they are anonymously available.

> > === modified file
> > 'lib/lp/registry/stories/webservice/xx-distroseries.txt'
> > === modified file
> > 'lib/lp/registry/stories/webservice/xx-project-registry.txt'
> > === modified file
> > 'lib/lp/registry/stories/webservice/...

[Adi Roiban (adiroiban)]

On Thu, 2010-05-20 at 16:33 +0000, Данило Шеган wrote:
> Hi Adi,
>
> Thanks for the updates. There's still just a little bit more to do :)
>
> У сре, 19. 05 2010. у 20:13 +0000, Adi Roiban пише:
>
> > There are still some warnings for code like:
> >
> > @operation_parameters(
> > pocket=Choice(
> > title=_("Pocket"), required=True,
> > vocabulary=DBEnumeratedType))
> >
> > and it looks fine to me, but pylint complains about:
> >
> > lib/lp/registry/interfaces/sourcepackage.py
> > 191: [C0322, ISourcePackage.getBranch] Operator not preceded by a
> > space
> > required=True,
> > ^
> > vocabulary=DBEnumeratedType))
> >
> >
> > > > == Pyflakes notices ==
> > > >
> > > > lib/lp/translations/interfaces/webservice.py
> > > > 8: 'IHasTranslationImports' imported but unused
> > > > 8: 'ITranslationImportQueue' imported but unused
> > > > 8: 'ITranslationImportQueueEntry' imported but unused
> > > > 13: 'IPOTemplate' imported but unused
> > > > 15: 'IPOFile' imported but unused
> > >
> > > You should add the following to webservice.py if that's the intention:
> > >
> > > __all__ = [
> > > 'IHasTranslationImports',
> > > 'IPOFile',
> > > 'IPOTemplate',
> > > 'ITranslationImportQueue',
> > > 'ITranslationImportQueueEntry',
> > > ]
> > >
> > > But, why is this necessary?
> >
> > Only interfaces listed in webservices.py will be exported by
> > lazr.restful.
> >
> > Adding __all__ will still generate Pyflakes notices as they are still
> > unused in that file.
>
> It actually fixed it for me. I'm attaching a patch which fixes all the
> lint issues I've seen. It would be nicer if you did that instead :)

I have no idea why this is not fixing for me.

Here is the output for `make lint` after applying your patch:

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/registry/interfaces/distroseries.py
  lib/lp/registry/interfaces/sourcepackage.py
  lib/lp/translations/interfaces/webservice.py
  lib/lp/translations/model/potemplate.py

== Pyflakes notices ==

lib/lp/translations/interfaces/webservice.py
    16: 'IHasTranslationImports' imported but unused
    16: 'ITranslationImportQueue' imported but unused
    16: 'ITranslationImportQueueEntry' imported but unused
    21: 'IPOTemplate' imported but unused
    23: 'IPOFile' imported but unused

> Also, "operator not preceded by space" lint issues in this particular
> context seem to be opposed to our style guide. It would be best to
> raise this on launchpad-dev mailing list to come to an agreement and to
> see if we can fix either pylint or style guide.

I have sent and email to lp-dev ML.

> > > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > > __init__.py
> > > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > > __init__.py
> > > > warning: Not importing directory '/usr/share/pyshared/lazr': missing
> > > __init__.py
> > >
> > > This might be a bug in lazr that needs fixing. Can you please check and
> > > file app...

[Данило Шеган (danilo)]

Hey Adi, we are getting very close. Just a few more small issues to
fix.

У чет, 20. 05 2010. у 18:00 +0000, Adi Roiban пише:

> > It actually fixed it for me. I'm attaching a patch which fixes all the
> > lint issues I've seen. It would be nicer if you did that instead :)
>
> I have no idea why this is not fixing for me.
>
> Here is the output for `make lint` after applying your patch:
>
> = Launchpad lint =
>
> Checking for conflicts. and issues in doctests and templates.
> Running jslint, xmllint, pyflakes, and pylint.
> Using normal rules.
>
> Linting changed files:
> lib/lp/registry/interfaces/distroseries.py
> lib/lp/registry/interfaces/sourcepackage.py
> lib/lp/translations/interfaces/webservice.py
> lib/lp/translations/model/potemplate.py
>
> == Pyflakes notices ==
>
> lib/lp/translations/interfaces/webservice.py
> 16: 'IHasTranslationImports' imported but unused
> 16: 'ITranslationImportQueue' imported but unused
> 16: 'ITranslationImportQueueEntry' imported but unused
> 21: 'IPOTemplate' imported but unused
> 23: 'IPOFile' imported but unused

Hum, very interesting. Perhaps it's a problem with pyflakes
incompatibilities? (FWIW, it seems your branch now specifies __all__
twice)

FWIW, defining __all__ fixes pyflakes warnings for me, but not the
pylint warnings.

> > Also, "operator not preceded by space" lint issues in this particular
> > context seem to be opposed to our style guide. It would be best to
> > raise this on launchpad-dev mailing list to come to an agreement and to
> > see if we can fix either pylint or style guide.
>
> I have sent and email to lp-dev ML.

Cool. It seems everybody agrees that we should not change the
styleguide, but instead not use pylint as is. You can ignore those
warnings and revert that bit of my patch. It'd still be very useful to
resolve the pyflakes warnings that you are getting, though.

> I have filled a bug report for that:
> https://bugs.edge.launchpad.net/ubuntu/+source/lazr.restfulclient/+bug/583426

Excellent, thanks a lot.

> [snip]
> >
> > > > > === modified file 'lib/lp/translations/interfaces/potemplate.py'
> > > > ...
> > > > > source_file = Object(
> > > > > title=_('Source file for this translation template'),
> > > > > readonly=True, schema=ILibraryFileAlias)
> > > >
> > > > I don't remember why we decided not to export this one? It could be
> > > > useful for things like xpipo conversion (with XPI-based translations,
> > > > it should contain a reference to imported en-US.xpi).
> > > >
> > > > Though, we should probably just export it as the public URL, so not a
> > > > big deal (let's not block this branch on this).
> > >
> > > I will leave it for another branch, but for me, it would make sense if
> > > this attribute would be used for all translation templates, not only
> > > XPI.
> >
> > Well, we can reconstruct the gettext POT file completely from what we
> > have in the DB. Thus, it's not needed.
>
> My note was about creating a more consistent API so that in the API
> source_file (or whatever name we choose for it) would return the
> template file for all formats, not only XPI.

Sure...

> Instead of...

[Adi Roiban (adiroiban)]

On Thu, 2010-05-20 at 18:48 +0000, Данило Шеган wrote:
> Hey Adi, we are getting very close. Just a few more small issues to
> fix.
>
> У чет, 20. 05 2010. у 18:00 +0000, Adi Roiban пише:
>
> > > It actually fixed it for me. I'm attaching a patch which fixes all the
> > > lint issues I've seen. It would be nicer if you did that instead :)
> >
> > I have no idea why this is not fixing for me.
> >
> > Here is the output for `make lint` after applying your patch:
> >
> > = Launchpad lint =
> >
> > Checking for conflicts. and issues in doctests and templates.
> > Running jslint, xmllint, pyflakes, and pylint.
> > Using normal rules.
> >
> > Linting changed files:
> > lib/lp/registry/interfaces/distroseries.py
> > lib/lp/registry/interfaces/sourcepackage.py
> > lib/lp/translations/interfaces/webservice.py
> > lib/lp/translations/model/potemplate.py
> >
> > == Pyflakes notices ==
> >
> > lib/lp/translations/interfaces/webservice.py
> > 16: 'IHasTranslationImports' imported but unused
> > 16: 'ITranslationImportQueue' imported but unused
> > 16: 'ITranslationImportQueueEntry' imported but unused
> > 21: 'IPOTemplate' imported but unused
> > 23: 'IPOFile' imported but unused
>
> Hum, very interesting. Perhaps it's a problem with pyflakes
> incompatibilities? (FWIW, it seems your branch now specifies __all__
> twice)
>
> FWIW, defining __all__ fixes pyflakes warnings for me, but not the
> pylint warnings.

I have removed the duplicate __all__ and only leave it before the
imports.

[snip]
> > > Add __all__: have you tried it at all? It totally works for me, and I'd
> > > be very surprised if it doesn't work for you. Also, __all__ is required
> > > in all our modules as well (importfascist used to check that before,
> > > maybe it doesn't anymore)
>
> I'd really like to get this resolved. It seems the line length is also
> slightly differently defined for you:
>
> === modified file 'lib/lp/translations/interfaces/pofile.py'
> --- lib/lp/translations/interfaces/pofile.py 2010-05-19 17:04:11 +0000
> +++ lib/lp/translations/interfaces/pofile.py 2010-05-20 17:58:16 +0000
> @@ -127,9 +127,9 @@
> '''),
> required=False)
>
> - translation_messages = Attribute(_('''
> - All `ITranslationMessage` objects related to this translation file.
> - '''))
> + translation_messages = Attribute(_(
> + "All `ITranslationMessage` objects related to this "
> + "translation file."))
>
> plural_forms = Int(
> title=_('Number of plural forms for the language of this PO file.'),
>
>
> This is not needed for me, because just putting it as
>
> translation_messages = Attribute(_(
> 'All `ITranslationMessage` objects related to this translation file.'
> ))
>
> works fine. Not that there's anything wrong with your approach, I am just noting this.

This will break the styleguide as there is a space before the ')'

> > > > === modified file 'lib/lp/translations/interfaces/pofile.py'
> > > > --- lib/lp/translations/interfaces/pofile.py 2010-03-08 21:06:34 +0000
> > > > +++ lib/lp/translations/interfaces/pofile.py 2010-05-19 17:04:11 +0...

[Данило Шеган (danilo)]

Hi Adi,

У чет, 20. 05 2010. у 19:06 +0000, Adi Roiban пише:
> > This is not needed for me, because just putting it as
> >
> > translation_messages = Attribute(_(
> > 'All `ITranslationMessage` objects related to this translation file.'
> > ))
> >
> > works fine. Not that there's anything wrong with your approach, I am just noting this.
>
> This will break the styleguide as there is a space before the ')'

Heh, this is not really a space: it's a multiline wrapping of braces,
and we do exactly the same thing with tuples (we'd do it with imports as
well if we didn't have too many of those), as mentioned on [1]:

  something = (
      FirstVeryLongName,
      SecondVeryLongName,
  )

[1] https://dev.launchpad.net/PythonStyleGuide#Multiline%20braces

Anyway, as I said, your style is just as fine as well.

 review approve
 merge approve

I'll get this into ec2 land soon.

Cheers,
Danilo

review: Approve

[Данило Шеган (danilo)]

Hi Adi,

Ok, I realized there are more things to fix first. We've discussed them
over on IRC, but I will repeat myself a bit for reference.

 review needs-fixing

Attribute names should include as little gettextisms as possible:
"all_pofiles" and "all_potemplates" should be "translation_files" and
"translation_templates" (this one is already almost alright in the
branch: I am not sure about the "all").

And further on that topic, we should only show most relevant translation
templates: these are usually only the current, non-obsolete ones.
Obsolete templates are useful only for management purposes, and if we
want, we can export them either separately, or export all of

  getCurrentTranslationTemplates
  getObsoleteTranslationTemplates
  getTranslationTemplates

There is no need to wrap either of the methods in a property in order to
export them. What's else, these methods expose some implementation
details (like "just_ids" parameter, needed for performance reasons
elsewhere) and we should not get them exported as such.

Since I want to see this branch move in soon, I don't want to dwell on
cleaning up these right now.

Now, performance reasons are very important to consider here. We may
have to investigate whether `doNotSnapshot` is needed, and how batching
works over Collection results ([1] suggests it splits results into
batches of 75, but we'd have to check that). If API framework splits
the results into batches and only serializes a single batch (vs
serializing a whole result set), it'd be ok even if we don't use
doNotSnapshot (unless it turns out to be too slow once it hits
edge/staging, when we'll need to fix it).

Also, at the moment, we should export only the most useful list of
templates (because most of this code needs slight refactoring, we should
not export all methods and then stop exporting them soon after). At the
moment, for the "reporting" use case, I believe only "current" templates
make sense to be exported. Now, exporting it with just_ids parameter is
fine as well, and we can fix it with the refactoring in the future.

Next, we did mention how it should already allow read-write access if
you've got sufficient privileges. In my tests that has turned out to be
false. This is definitely not a blocker (it's ok if we start with
read-only API), but we at least need to understand why this is so and
how is write access created (so we don't do it by accident).

Example script I tried out (after doing 'make run' in this branch, run
this in a python console and log in with sufficient privileges, eg.
<email address hidden>:test):

  cachedir = "/home/danilo/.launchpadlib/cache/"
  from launchpadlib.launchpad import Launchpad
  launchpad = Launchpad.login_with('dev testing', 'dev', cachedir)
  ubuntu = launchpad.distributions['ubuntu']
  hoary = ubuntu.series[2]
  pots = hoary.all_translation_templates
  pot = pots[0]
  pot.translation_domain = 'something_else'
  pot.lp_save()

So, suggested course of action to get this landed:

 0. fix "all_pofile" attribute name
 1. Check if we get batching of results on API method calls/attributes
for free (without needing to do anything else)
 2. If 1 is true, check if batching snapshots the en...

review: Needs Fixing

[Adi Roiban (adiroiban)]

On Wed, 2010-05-26 at 16:12 +0000, Данило Шеган wrote:
> Review: Needs Fixing
> Hi Adi,
>
> Ok, I realized there are more things to fix first. We've discussed them
> over on IRC, but I will repeat myself a bit for reference.
>
> review needs-fixing
>
> Attribute names should include as little gettextisms as possible:
> "all_pofiles" and "all_potemplates" should be "translation_files" and
> "translation_templates" (this one is already almost alright in the
> branch: I am not sure about the "all").

renamed all_pofiles to translation_files
removed all_translation_templates since its content will be provided by
a method.

I have renamed the name used for exporting pofile and potemplate entries
and collections.

> And further on that topic, we should only show most relevant translation
> templates: these are usually only the current, non-obsolete ones.
> Obsolete templates are useful only for management purposes, and if we
> want, we can export them either separately, or export all of
>
> getCurrentTranslationTemplates
> getObsoleteTranslationTemplates
> getTranslationTemplates
>
> There is no need to wrap either of the methods in a property in order to
> export them. What's else, these methods expose some implementation
> details (like "just_ids" parameter, needed for performance reasons
> elsewhere) and we should not get them exported as such.
>
> Since I want to see this branch move in soon, I don't want to dwell on
> cleaning up these right now.

We can hide the "just_ids" in the exported API call.
We can export getCurrentTranslationTemplates() method, with just_ids
hidden and always set to False.

I still think that exporting getTranslationTemplates() will make the API
simpler (rather than exporting all 3 methods) and the client side check
for active/inactive templates is not that complicated.

> Now, performance reasons are very important to consider here. We may
> have to investigate whether `doNotSnapshot` is needed, and how batching
> works over Collection results ([1] suggests it splits results into
> batches of 75, but we'd have to check that). If API framework splits
> the results into batches and only serializes a single batch (vs
> serializing a whole result set), it'd be ok even if we don't use
> doNotSnapshot (unless it turns out to be too slow once it hits
> edge/staging, when we'll need to fix it).

I will raise this discussion over the lp-dev ML. I still have to read
the code and see exactly why, where and how those snosphots are
needed/used in order to ask a valid question.

I think that we should land this branch and the start of next cycle.
The first attempt should be without doNotSnapshot. If something goes
wrong we can reconsider our options.

> Also, at the moment, we should export only the most useful list of
> templates (because most of this code needs slight refactoring, we should
> not export all methods and then stop exporting them soon after). At the
> moment, for the "reporting" use case, I believe only "current" templates
> make sense to be exported. Now, exporting it with just_ids parameter is
> fine as well, and we can fix it with the refactoring in the future.

See above comments.

> Next, we...

[Jeroen T. Vermeulen (jtv)]

We've been discussing this in IRC. It turns out that IDistroSeries.getTranslationTemplates wasn't batching properly because it used shortlist() to limit its results. As a side effect, that listifies the query result—causing all its results to be fetched and marshaled. The batching logic then slices the resulting list instead of the query result, which is somewhat pointless.

The docstring deliberately makes no promise that getTranslationTemplates returns a list, so it's perfectly valid to return the query result directly instead of a shortlisted version of it. Unfortunately the distroseries translations copying script does assert that len(child.getTranslationTemplates()) == 0. This assumes a list-like return value; with a query it should assert that child.getTranslationTemplates.is_empty().

[Jeroen T. Vermeulen (jtv)]

Revision 10369 looks good to me (except the part where you update the getTranslationTemplates docstring to say it returns a list) but brings another problem to my attention: the purpose of the privileges check in POTemplateSubsetNavigation.traverse is a bit unclear. The comment also contains a typo ("is a is a").

You can also make the check easier to read by eliminating individual, simple cases:

if official_rosetta and potemplate.is_current:
    # This template is available for translation.
    return potemplate
elif check_permission('launchpad.Edit', potemplate):
    # User has special privileges for this template.
    return potemplate
else:
    raise NotFoundError(name)

Also, a bit higher up, I don't think the assertion for "unknown context" carries its weight. We have database constraints enforcing it. So might as well do something simpler such as:

if potemplate.distribution is None:
    product_or_distro = potemplate.productseries.product
else:
    product_or_distro = potemplate.distroseries.distribution
official_rosetta = product_or_distro.official_rosetta

[Jeroen T. Vermeulen (jtv)]

For the record I should add that we first discussed the bigger issues (performance, security, various batching hazards) as per Danilo's proposed course of action above. All those points have been satisfied, so the nitpicking about small bits of code means that the branch is in good shape. There is no problematic snapshotting, performance is good, and with the removal of that shortlist we no longer fetch all templates in a distroseries at once.

[Adi Roiban (adiroiban)]

Hi,

Here is the diff with the changes discussed in the latest comment.

If everything is ok, can you please sent this branch to ec2-test?

=== modified file 'lib/lp/registry/model/distroseries.py'
--- lib/lp/registry/model/distroseries.py 2010-05-19 17:24:21 +0000
+++ lib/lp/registry/model/distroseries.py 2010-06-03 15:06:35 +0000
@@ -1886,7 +1886,7 @@
         """See `IHasTranslationTemplates`."""
         result = POTemplate.selectBy(distroseries=self,
                                      orderBy=['-priority', 'name'])
- return shortlist(result, 2000)
+ return result

     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""

=== modified file 'lib/lp/registry/model/productseries.py'
--- lib/lp/registry/model/productseries.py 2010-05-17 09:35:18 +0000
+++ lib/lp/registry/model/productseries.py 2010-06-03 15:06:14 +0000
@@ -427,7 +427,7 @@
         """See `IHasTranslationTemplates`."""
         result = POTemplate.selectBy(
             productseries=self, orderBy=['-priority', 'name'])
- return shortlist(result, 300)
+ return result

     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""

=== modified file 'lib/lp/registry/model/sourcepackage.py'
--- lib/lp/registry/model/sourcepackage.py 2010-05-17 09:35:18 +0000
+++ lib/lp/registry/model/sourcepackage.py 2010-06-03 15:19:06 +0000
@@ -602,7 +602,7 @@
         result = POTemplate.selectBy(
             distroseries=self.distroseries,
             sourcepackagename=self.sourcepackagename)
- return shortlist(result.orderBy(['-priority', 'name']), 300)
+ return result.orderBy(['-priority', 'name'])

     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""

=== modified file 'lib/lp/translations/browser/potemplate.py'
--- lib/lp/translations/browser/potemplate.py 2010-05-27 14:38:56 +0000
+++ lib/lp/translations/browser/potemplate.py 2010-06-03 16:02:24 +0000
@@ -774,18 +774,17 @@

         # Get whether the target for the requested template is officially
         # using Launchpad Translations.
- if potemplate.distribution is not None:
- official_rosetta = potemplate.distribution.official_rosetta
- elif potemplate.product is not None:
- official_rosetta = potemplate.product.official_rosetta
+ if potemplate.distribution is None:
+ product_or_distro = potemplate.productseries.product
         else:
- raise AssertionError('Unknown context for %s' % potemplate.title)
+ product_or_distro = potemplate.distroseries.distribution
+ official_rosetta = product_or_distro.official_rosetta

- if ((official_rosetta and potemplate.iscurrent) or
- check_permission('launchpad.Edit', potemplate)):
- # The target is using officially Launchpad Translations and the
- # template is available to be translated, or the user is a is a
- # Launchpad administrator in which case we show everything.
+ if official_rosetta and potemplate.iscurrent:
+ # This template is av...

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-05-14 08:05:23 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-06-03 16:14:30 +0000
@@ -24,6 +24,8 @@
     patch_plain_parameter_type, patch_choice_parameter_type,
     patch_reference_property)
 
+from canonical.launchpad.interfaces.message import (
+    IIndexedMessage, IMessage, IUserToUserEmail)
 from lp.registry.interfaces.structuralsubscription import (
     IStructuralSubscription, IStructuralSubscriptionTarget)
 from lp.bugs.interfaces.bug import IBug, IFrontPageBugAddForm
@@ -52,16 +54,17 @@
     ISourcePackageRecipe)
 from lp.code.interfaces.sourcepackagerecipebuild import (
     ISourcePackageRecipeBuild)
+from lp.hardwaredb.interfaces.hwdb import HWBus, IHWSubmission
 from lp.registry.interfaces.distribution import IDistribution
 from lp.registry.interfaces.distributionmirror import IDistributionMirror
 from lp.registry.interfaces.distributionsourcepackage import (
     IDistributionSourcePackage)
 from lp.registry.interfaces.distroseries import IDistroSeries
 from lp.registry.interfaces.person import IPerson, IPersonPublic
-from lp.hardwaredb.interfaces.hwdb import HWBus, IHWSubmission
 from lp.registry.interfaces.pocket import PackagePublishingPocket
 from lp.registry.interfaces.product import IProduct
 from lp.registry.interfaces.productseries import IProductSeries
+from lp.registry.interfaces.sourcepackage import ISourcePackage
 from lp.soyuz.interfaces.archive import IArchive
 from lp.soyuz.interfaces.archivepermission import (
     IArchivePermission)
@@ -77,9 +80,9 @@
 from lp.soyuz.interfaces.queue import (
     IPackageUpload, PackageUploadCustomFormat, PackageUploadStatus)
 from lp.soyuz.interfaces.sourcepackagerelease import ISourcePackageRelease
-from lp.registry.interfaces.sourcepackage import ISourcePackage
-from canonical.launchpad.interfaces.message import (
-    IIndexedMessage, IMessage, IUserToUserEmail)
+from lp.translations.interfaces.pofile import IPOFile
+from lp.translations.interfaces.potemplate import (
+    IPOTemplate, IPOTemplateSharingSubset, IPOTemplateSubset)
 
 
 IBranch['bug_branches'].value_type.schema = IBugBranch
@@ -394,5 +397,16 @@
 # IBugTracker
 patch_reference_property(IBugTracker, 'owner', IPerson)
 
+# IPOTemplate
+patch_collection_property(IPOTemplate, 'pofiles', IPOFile)
+patch_reference_property(IPOTemplate, 'product', IProduct)
+
+# IPOTemplateSubset
+patch_reference_property(IPOTemplateSubset, 'distroseries', IDistroSeries)
+patch_reference_property(IPOTemplateSubset, 'productseries', IProductSeries)
+
+# IPOTemplateSharingSubset
+patch_reference_property(IPOTemplateSharingSubset, 'product', IProduct)
+
 # IProductSeries
 patch_reference_property(IProductSeries, 'product', IProduct)

=== modified file 'lib/canonical/launchpad/security.py'
--- lib/canonical/launchpad/security.py	2010-05-24 04:54:44 +0000
+++ lib/canonical/launchpad/security.py	2010-06-03 16:14:30 +0000
@@ -61,8 +61,7 @@
 from lp.services.worlddata.interfaces.language import ILanguage, ILanguageSet
 from lp.translations.interfaces.languagepack import ILanguagePack
 from canonical.launchpad.interfaces.launchpad import (
-    IBazaarApplication, IHasBug, IHasDrivers, ILaunchpadCelebrities,
-    IPersonRoles)
+    IHasBug, IHasDrivers, ILaunchpadCelebrities, IPersonRoles)
 from lp.registry.interfaces.role import IHasOwner
 from lp.registry.interfaces.location import IPersonLocation
 from lp.registry.interfaces.mailinglist import IMailingListSet
@@ -1159,6 +1158,11 @@
                         self.obj).checkAuthenticated(user))
 
 
+class ViewPOTemplates(AnonymousAuthorization):
+    """Anyone can view an IPOTemplate."""
+    usedfor = IPOTemplate
+
+
 class AdminPOTemplateDetails(OnlyRosettaExpertsAndAdmins):
     """Controls administration of an `IPOTemplate`.
 
@@ -1211,6 +1215,11 @@
     usedfor = IProductSeries
 
 
+class ViewPOFile(AnonymousAuthorization):
+    """Anyone can view an IPOFile."""
+    usedfor = IPOFile
+
+
 class EditPOFileDetails(EditByOwnersOrAdmins):
     usedfor = IPOFile
 

=== modified file 'lib/lp/registry/configure.zcml'
--- lib/lp/registry/configure.zcml	2010-04-27 13:57:18 +0000
+++ lib/lp/registry/configure.zcml	2010-06-03 16:14:30 +0000
@@ -113,8 +113,6 @@
         <allow
             interface="lp.translations.interfaces.translationimportqueue.IHasTranslationImports"/>
         <allow
-            interface="lp.translations.interfaces.potemplate.IHasTranslationTemplates"/>
-        <allow
             interface="canonical.launchpad.interfaces.ICanPublishPackages"/>
         <require
             permission="launchpad.Edit"
@@ -1325,8 +1323,6 @@
             interface="lp.bugs.interfaces.bugtarget.IHasBugHeat"/>
         <allow
             interface="lp.translations.interfaces.translationimportqueue.IHasTranslationImports"/>
-        <allow
-            interface="lp.translations.interfaces.potemplate.IHasTranslationTemplates"/>
         <require
             permission="launchpad.Edit"
             set_attributes="product name owner driver summary branch
@@ -1529,8 +1525,6 @@
             interface="canonical.launchpad.interfaces.IHasBuildRecords"/>
         <allow
             interface="lp.translations.interfaces.translationimportqueue.IHasTranslationImports"/>
-        <allow
-            interface="lp.translations.interfaces.potemplate.IHasTranslationTemplates"/>
 
         <!-- IQuestionTarget -->
 

=== modified file 'lib/lp/registry/interfaces/distroseries.py'
--- lib/lp/registry/interfaces/distroseries.py	2010-04-27 22:22:20 +0000
+++ lib/lp/registry/interfaces/distroseries.py	2010-06-03 16:14:30 +0000
@@ -51,6 +51,7 @@
     IStructuralSubscriptionTarget)
 from lp.soyuz.interfaces.buildrecords import IHasBuildRecords
 from lp.translations.interfaces.languagepack import ILanguagePack
+from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 
 
 class DistroSeriesNameField(ContentNameField):
@@ -113,7 +114,7 @@
 
     def _validate(self, version):
         """See `UniqueField`."""
-        super(DistroSeriesVersionField, self)._validate(version)
+        DistroSeriesVersionField._validate(self, version)
         if not sane_version(version):
             raise LaunchpadValidationError(
                 "%s is not a valid version" % version)
@@ -142,7 +143,7 @@
 class IDistroSeriesPublic(
     ISeriesMixin, IHasAppointedDriver, IHasOwner, IBugTarget,
     ISpecificationGoal, IHasMilestones, IHasOfficialBugTags,
-    IHasBuildRecords):
+    IHasBuildRecords, IHasTranslationTemplates):
     """Public IDistroSeries properties."""
 
     id = Attribute("The distroseries's unique number.")
@@ -593,7 +594,8 @@
          :param dsc: string, original content of the dsc file
          :param copyright: string, the original debian/copyright content
          :param changelog: LFA ID of the debian/changelog file in librarian
-         :param changelog_entry: string, changelog extracted from the changesfile
+         :param changelog_entry: string, changelog extracted from the
+                                 changesfile
          :param architecturehintlist: string, DSC architectures
          :param builddepends: string, DSC build dependencies
          :param builddependsindep: string, DSC architecture independent build

=== modified file 'lib/lp/registry/interfaces/productseries.py'
--- lib/lp/registry/interfaces/productseries.py	2010-03-25 20:36:46 +0000
+++ lib/lp/registry/interfaces/productseries.py	2010-06-03 16:14:30 +0000
@@ -32,6 +32,7 @@
 from lp.registry.interfaces.productrelease import IProductRelease
 from lp.blueprints.interfaces.specificationtarget import (
     ISpecificationGoal)
+from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 from lp.translations.interfaces.translations import (
     TranslationsBranchImportMode)
 from canonical.launchpad.interfaces.validation import validate_url
@@ -91,7 +92,8 @@
 
 class IProductSeriesPublic(
     ISeriesMixin, IHasAppointedDriver, IHasOwner, IBugTarget,
-    ISpecificationGoal, IHasMilestones, IHasOfficialBugTags):
+    ISpecificationGoal, IHasMilestones, IHasOfficialBugTags,
+    IHasTranslationTemplates):
     """Public IProductSeries properties."""
     # XXX Mark Shuttleworth 2004-10-14: Would like to get rid of id in
     # interfaces, as soon as SQLobject allows using the object directly

=== modified file 'lib/lp/registry/interfaces/sourcepackage.py'
--- lib/lp/registry/interfaces/sourcepackage.py	2010-04-01 20:26:16 +0000
+++ lib/lp/registry/interfaces/sourcepackage.py	2010-06-03 16:14:30 +0000
@@ -19,21 +19,23 @@
 from zope.interface import Attribute, Interface
 from zope.schema import Choice, Object, TextLine
 from lazr.enum import DBEnumeratedType, DBItem
+from lazr.restful.fields import Reference, ReferenceChoice
+from lazr.restful.declarations import (
+    call_with, export_as_webservice_entry, export_read_operation,
+    export_write_operation, exported, operation_parameters,
+    operation_returns_entry, REQUEST_USER)
 
 from canonical.launchpad import _
 from lp.bugs.interfaces.bugtarget import IBugTarget, IHasOfficialBugTags
 from lp.code.interfaces.hasbranches import (
     IHasBranches, IHasCodeImports, IHasMergeProposals)
 from lp.soyuz.interfaces.component import IComponent
-from lazr.restful.fields import Reference, ReferenceChoice
-from lazr.restful.declarations import (
-    call_with, export_as_webservice_entry, export_read_operation,
-    export_write_operation, exported, operation_parameters,
-    operation_returns_entry, REQUEST_USER)
+from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 
 
 class ISourcePackage(IBugTarget, IHasBranches, IHasMergeProposals,
-                     IHasOfficialBugTags, IHasCodeImports):
+                     IHasOfficialBugTags, IHasCodeImports,
+                     IHasTranslationTemplates):
     """A SourcePackage. See the MagicSourcePackage specification. This
     interface preserves as much as possible of the old SourcePackage
     interface from the SourcePackage table, with the new table-less

=== modified file 'lib/lp/registry/model/distroseries.py'
--- lib/lp/registry/model/distroseries.py	2010-05-12 23:23:19 +0000
+++ lib/lp/registry/model/distroseries.py	2010-06-03 16:14:30 +0000
@@ -103,7 +103,6 @@
 from lp.translations.interfaces.languagepack import LanguagePackType
 from canonical.launchpad.interfaces.librarian import ILibraryFileAliasSet
 from lp.soyuz.interfaces.queue import PackageUploadStatus
-from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 from lp.soyuz.interfaces.publishedpackage import (
     IPublishedPackageSet)
 from lp.soyuz.interfaces.publishing import (
@@ -131,7 +130,7 @@
     """A particular series of a distribution."""
     implements(
         ICanPublishPackages, IDistroSeries, IHasBugHeat, IHasBuildRecords,
-        IHasQueueItems, IHasTranslationTemplates)
+        IHasQueueItems)
 
     _table = 'DistroSeries'
     _defaultOrder = ['distribution', 'version']
@@ -1303,15 +1302,13 @@
         find_spec = (
             DistroSeriesPackageCache,
             BinaryPackageName,
-            SQL('rank(fti, ftq(%s)) AS rank' % sqlvalues(text))
-            )
+            SQL('rank(fti, ftq(%s)) AS rank' % sqlvalues(text)))
         origin = [
             DistroSeriesPackageCache,
             Join(
                 BinaryPackageName,
                 DistroSeriesPackageCache.binarypackagename ==
-                    BinaryPackageName.id
-                )
+                    BinaryPackageName.id),
             ]
 
         # Note: When attempting to convert the query below into straight
@@ -1325,7 +1322,7 @@
             DistroSeriesPackageCache.name ILIKE '%%' || %s || '%%')
             """ % (quote(self),
                    quote(self.distribution.all_distro_archive_ids),
-                   quote(text), quote_like(text))
+                   quote(text), quote_like(text)),
             ).config(distinct=True)
 
         # Create a function that will decorate the results, converting
@@ -1889,7 +1886,7 @@
         """See `IHasTranslationTemplates`."""
         result = POTemplate.selectBy(distroseries=self,
                                      orderBy=['-priority', 'name'])
-        return shortlist(result, 2000)
+        return result
 
     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""

=== modified file 'lib/lp/registry/model/productseries.py'
--- lib/lp/registry/model/productseries.py	2010-03-24 02:53:42 +0000
+++ lib/lp/registry/model/productseries.py	2010-06-03 16:14:30 +0000
@@ -53,7 +53,6 @@
 from canonical.launchpad.helpers import shortlist
 from canonical.launchpad.interfaces.launchpad import ILaunchpadCelebrities
 from lp.registry.interfaces.packaging import PackagingType
-from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 from lp.blueprints.interfaces.specification import (
     SpecificationDefinitionStatus, SpecificationFilter,
     SpecificationGoalStatus, SpecificationImplementationStatus,
@@ -84,7 +83,7 @@
                     HasTranslationImportsMixin, HasTranslationTemplatesMixin,
                     StructuralSubscriptionTargetMixin, SeriesMixin):
     """A series of product releases."""
-    implements(IHasBugHeat, IProductSeries, IHasTranslationTemplates)
+    implements(IHasBugHeat, IProductSeries)
 
     _table = 'ProductSeries'
 
@@ -428,7 +427,7 @@
         """See `IHasTranslationTemplates`."""
         result = POTemplate.selectBy(
             productseries=self, orderBy=['-priority', 'name'])
-        return shortlist(result, 300)
+        return result
 
     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""
@@ -614,4 +613,3 @@
                 import_mode != TranslationsBranchImportMode.NO_IMPORT)
 
         return Store.of(branch).find(ProductSeries, And(*conditions))
-

=== modified file 'lib/lp/registry/model/sourcepackage.py'
--- lib/lp/registry/model/sourcepackage.py	2010-04-14 18:31:51 +0000
+++ lib/lp/registry/model/sourcepackage.py	2010-06-03 16:14:30 +0000
@@ -54,7 +54,6 @@
 from canonical.launchpad.helpers import shortlist
 from lp.soyuz.interfaces.buildrecords import IHasBuildRecords
 from lp.registry.interfaces.packaging import PackagingType
-from lp.translations.interfaces.potemplate import IHasTranslationTemplates
 from lp.registry.interfaces.distribution import NoPartnerArchive
 from lp.registry.interfaces.pocket import PackagePublishingPocket
 from lp.soyuz.interfaces.publishing import PackagePublishingStatus
@@ -170,8 +169,7 @@
     """
 
     implements(
-        ISourcePackage, IHasBugHeat, IHasBuildRecords,
-        IHasTranslationTemplates, IQuestionTarget)
+        ISourcePackage, IHasBugHeat, IHasBuildRecords, IQuestionTarget)
 
     classProvides(ISourcePackageFactory)
 
@@ -604,7 +602,7 @@
         result = POTemplate.selectBy(
             distroseries=self.distroseries,
             sourcepackagename=self.sourcepackagename)
-        return shortlist(result.orderBy(['-priority', 'name']), 300)
+        return result.orderBy(['-priority', 'name'])
 
     def getCurrentTranslationTemplates(self, just_ids=False):
         """See `IHasTranslationTemplates`."""

=== modified file 'lib/lp/registry/stories/webservice/xx-distroseries.txt'
--- lib/lp/registry/stories/webservice/xx-distroseries.txt	2010-03-06 01:24:05 +0000
+++ lib/lp/registry/stories/webservice/xx-distroseries.txt	2010-06-03 16:14:30 +0000
@@ -1,4 +1,5 @@
-= Distribution Series =
+Distribution Series
+===================
 
 We can get a distroseries object via a distribution object in several ways:
 

=== modified file 'lib/lp/registry/stories/webservice/xx-project-registry.txt'
--- lib/lp/registry/stories/webservice/xx-project-registry.txt	2010-05-07 18:18:56 +0000
+++ lib/lp/registry/stories/webservice/xx-project-registry.txt	2010-06-03 16:14:30 +0000
@@ -858,8 +858,10 @@
     >>> babadoo_foobadoo = webservice.get('/babadoo/foobadoo').jsonBody()
     >>> pprint_entry(babadoo_foobadoo)
     active: True
-    active_milestones_collection_link: u'http://.../babadoo/foobadoo/active_milestones'
-    all_milestones_collection_link: u'http://.../babadoo/foobadoo/all_milestones'
+    active_milestones_collection_link:
+            u'http://.../babadoo/foobadoo/active_milestones'
+    all_milestones_collection_link:
+            u'http://.../babadoo/foobadoo/all_milestones'
     branch_link: u'http://.../~babadoo-owner/babadoo/fooey'
     bug_reporting_guidelines: None
     date_created: u'...'
@@ -1088,12 +1090,15 @@
     >>> pprint_entry(result)
     date_uploaded: u'2005-06-06T08:59:51.926792+00:00'
     description: None
-    file_link: u'http://.../firefox/trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz/file'
+    file_link:
+        u'http://.../firefox/trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz/file'
     file_type: u'Code Release Tarball'
     project_release_link: u'http://.../firefox/trunk/0.9.2'
     resource_type_link: u'http://.../#project_release_file'
-    self_link: u'http://.../firefox/trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz'
-    signature_link: u'http://.../firefox/trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz/signature'
+    self_link:
+        u'http://.../firefox/trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz'
+    signature_link:
+        u'http://.../trunk/0.9.2/+file/firefox_0.9.2.orig.tar.gz/signature'
 
 The actual file redirects to the librarian when accessed.
 

=== modified file 'lib/lp/translations/browser/potemplate.py'
--- lib/lp/translations/browser/potemplate.py	2010-04-22 17:07:56 +0000
+++ lib/lp/translations/browser/potemplate.py	2010-06-03 16:14:30 +0000
@@ -763,8 +763,8 @@
     def traverse(self, name):
         """Return the IPOTemplate associated with the given name."""
 
-        assert self.request.method in ['GET', 'HEAD', 'POST'], (
-            'We only know about GET, HEAD, and POST')
+        assert self.request.method in ['GET', 'HEAD', 'PATCH', 'POST'], (
+            'We only know about GET, HEAD, PATCH and POST')
 
         # Get the requested potemplate.
         potemplate = self.context.getPOTemplateByName(name)
@@ -774,18 +774,17 @@
 
         # Get whether the target for the requested template is officially
         # using Launchpad Translations.
-        if potemplate.distribution is not None:
-            official_rosetta = potemplate.distribution.official_rosetta
-        elif potemplate.product is not None:
-            official_rosetta = potemplate.product.official_rosetta
+        if potemplate.distribution is None:
+            product_or_distro = potemplate.productseries.product
         else:
-            raise AssertionError('Unknown context for %s' % potemplate.title)
+            product_or_distro = potemplate.distroseries.distribution
+        official_rosetta = product_or_distro.official_rosetta
 
-        if ((official_rosetta and potemplate.iscurrent) or
-            check_permission('launchpad.Edit', potemplate)):
-            # The target is using officially Launchpad Translations and the
-            # template is available to be translated, or the user is a is a
-            # Launchpad administrator in which case we show everything.
+        if official_rosetta and potemplate.iscurrent:
+            # This template is available for translation.
+            return potemplate
+        elif check_permission('launchpad.Edit', potemplate):
+            # User has Edit privileges for this template and can access it.
             return potemplate
         else:
             raise NotFoundError(name)

=== modified file 'lib/lp/translations/interfaces/pofile.py'
--- lib/lp/translations/interfaces/pofile.py	2010-01-08 12:39:51 +0000
+++ lib/lp/translations/interfaces/pofile.py	2010-06-03 16:14:30 +0000
@@ -19,6 +19,9 @@
 from zope.schema.vocabulary import (
     getVocabularyRegistry, SimpleTerm, SimpleVocabulary)
 
+from lazr.restful.declarations import (
+    exported, export_as_webservice_entry)
+
 from canonical.launchpad import _
 from canonical.launchpad.webapp.interfaces import ILaunchBag
 from lp.registry.interfaces.person import IPerson
@@ -33,8 +36,12 @@
 class IPOFile(IRosettaStats):
     """A translation file."""
 
-    id = Int(
-        title=_('The translation file id.'), required=True, readonly=True)
+    export_as_webservice_entry(
+        singular_name="translation_file",
+        plural_name="translation_files")
+
+    id = exported(Int(
+        title=_('The translation file id.'), required=True, readonly=True))
 
     potemplate = Object(
         title=_('The translation file template.'),
@@ -121,8 +128,8 @@
         required=False)
 
     translation_messages = Attribute(_(
-        'All `ITranslationMessage` objects related to this translation file.'
-        ))
+        "All `ITranslationMessage` objects related to this "
+        "translation file."))
 
     plural_forms = Int(
         title=_('Number of plural forms for the language of this PO file.'),
@@ -273,7 +280,7 @@
 
     def getTranslationRows():
         """Return exportable rows of translation data.
-        
+
         :return: a list of `VPOExport` objects.
         """
 

=== modified file 'lib/lp/translations/interfaces/potemplate.py'
--- lib/lp/translations/interfaces/potemplate.py	2009-11-27 12:50:16 +0000
+++ lib/lp/translations/interfaces/potemplate.py	2010-06-03 16:14:30 +0000
@@ -7,13 +7,15 @@
 from zope.schema import (
     Bool, Bytes, Choice, Datetime, Int, Object, Text, TextLine)
 from lazr.enum import DBEnumeratedType, DBItem
+from lazr.restful.fields import CollectionField, Reference
+from lazr.restful.declarations import (
+    exported, export_as_webservice_entry, export_read_operation,
+    operation_returns_collection_of)
 
+from canonical.launchpad.fields import ParticipatingPersonChoice
 from canonical.launchpad.interfaces.launchpad import NotFoundError
 from canonical.launchpad.interfaces.librarian import ILibraryFileAlias
 from lp.registry.interfaces.distribution import IDistribution
-from lp.registry.interfaces.distroseries import IDistroSeries
-from lp.registry.interfaces.product import IProduct
-from lp.registry.interfaces.productseries import IProductSeries
 from lp.translations.interfaces.rosettastats import IRosettaStats
 from lp.registry.interfaces.sourcepackagename import (
     ISourcePackageName)
@@ -74,95 +76,55 @@
         search or complete listing is requested by the user.  """)
 
 
-class IHasTranslationTemplates(Interface):
-    """An entity that has translation templates attached.
-
-    Examples include `ISourcePackage`, `IDistroSeries`, and `IProductSeries`.
-    """
-
-    has_current_translation_templates = Bool(
-        title=_("Does this object have current translation templates?"),
-        readonly=True)
-
-    def getCurrentTranslationTemplates(just_ids=False):
-        """Return an iterator over all active translation templates.
-
-        A translation template is considered active when both
-        `IPOTemplate`.iscurrent and parent official_rosetta flags
-        are set to True.
-        """
-
-    def getCurrentTranslationFiles(just_ids=False):
-        """Return an iterator over all active translation files.
-
-        A translation file is active if it's attached to an
-        active translation template.
-        """
-
-    def getObsoleteTranslationTemplates():
-        """Return an iterator over its not active translation templates.
-
-        A translation template is considered not active when any of
-        `IPOTemplate`.iscurrent or `IDistribution`.official_rosetta flags
-        are set to False.
-        """
-
-    def getTranslationTemplates():
-        """Return an iterator over all its translation templates.
-
-        The returned templates are either obsolete or current.
-        """
-
-    def getTranslationTemplateFormats():
-        """A list of native formats for all current translation templates.
-        """
-
-
 class IPOTemplate(IRosettaStats):
     """A translation template."""
 
-    id = Int(
+    export_as_webservice_entry(
+        singular_name='translation_template',
+        plural_name='translation_templates')
+
+    id = exported(Int(
         title=u"The translation template id.",
-        required=True, readonly=True)
+        required=True, readonly=True))
 
-    name = TextLine(
+    name = exported(TextLine(
         title=_("Template name"),
         description=_("The name of this PO template, for example "
             "'evolution-2.2'. Each translation template has a "
             "unique name in its package. It's important to get this "
             "correct, because Launchpad will recommend alternative "
             "translations based on the name."),
-        required=True)
+        required=True))
 
-    translation_domain = TextLine(
+    translation_domain = exported(TextLine(
         title=_("Translation domain"),
         description=_("The translation domain for a translation template. "
             "Used with PO file format when generating MO files for inclusion "
             "in language pack or MO tarball exports."),
-        required=True)
+        required=True))
 
-    description = Text(
+    description = exported(Text(
         title=_("Description"),
         description=_("Please provide a brief description of the content "
             "of this translation template, for example, telling translators "
             "if this template contains strings for end-users or other "
             "developers."),
-        required=False)
+        required=False))
 
     header = Text(
         title=_('Header'),
         description=_("The standard template header in its native format."),
         required=True)
 
-    iscurrent = Bool(
+    iscurrent = exported(Bool(
         title=_("Accept translations?"),
         description=_(
             "If unchecked, people can no longer change the template's "
             "translations."),
         required=True,
-        default=True)
+        default=True), exported_as='active')
 
-    owner = Choice(
+    owner = exported(ParticipatingPersonChoice(
         title=_("Owner"),
         required=True,
         description=_(
@@ -170,7 +132,7 @@
             "and change it's status, and can also upload new versions "
             "of the template when a new release is made or when the "
             "translation strings have been changed during development."),
-        vocabulary="ValidOwner")
+        vocabulary="ValidOwner"))
 
     productseries = Choice(
         title=_("Series"),
@@ -209,29 +171,29 @@
         required=False,
         vocabulary="BinaryPackageName")
 
-    languagepack = Bool(
+    languagepack = exported(Bool(
         title=_("Include translations for this template in language packs?"),
         description=_(
             "Check this box if this template is part of a language pack so "
             "its translations should be exported that way."),
         required=True,
-        default=False)
+        default=False), exported_as='exported_in_languagepacks')
 
-    path = TextLine(
+    path = exported(TextLine(
         title=_(
             "Path of the template in the source tree, including filename."),
-        required=False)
+        required=False))
 
     source_file = Object(
         title=_('Source file for this translation template'),
         readonly=True, schema=ILibraryFileAlias)
 
-    source_file_format = Choice(
+    source_file_format = exported(Choice(
         title=_("File format for the source file"),
         required=False,
-        vocabulary=TranslationFileFormat)
+        vocabulary=TranslationFileFormat), exported_as='format')
 
-    priority = Int(
+    priority = exported(Int(
         title=_('Priority'),
         required=True,
         default=0,
@@ -240,7 +202,7 @@
             'there are multiple templates, and you can use this as a way '
             'of indicating which are more important and should be '
             'translated first. Pick any number - higher priority '
-            'templates will generally be listed first.'))
+            'templates will generally be listed first.')))
 
     datecreated = Datetime(
         title=_('When this translation template was created.'), required=True,
@@ -265,8 +227,12 @@
             '''),
         vocabulary='TranslationPermission')
 
-    pofiles = Attribute(
-        _('All `IPOFile` that exist for this template.'))
+    pofiles = exported(
+        CollectionField(
+            title=_("All translation files that exist for this template."),
+            # Really IPOFile, see _schema_circular_imports.py.
+            value_type=Reference(schema=Interface)),
+        exported_as='translation_files')
 
     relatives_by_name = Attribute(
         _('All `IPOTemplate` objects that have the same name asa this one.'))
@@ -287,17 +253,24 @@
 
     product = Object(
         title=_('The `IProduct` to which this translation template belongs.'),
-        required=False, readonly=True, schema=IProduct)
+        required=False, readonly=True,
+        # Really IProduct, see _schema_circular_imports.py.
+        schema=Interface)
 
     distribution = Object(
         title=_(
-            'The `IDistribution` to which this translation template belongs.'
-            ),
+            'The `IDistribution` to which this translation template '
+            'belongs.'),
         readonly=True, schema=IDistribution)
 
-    language_count = Int(
+    messagecount = exported(Int(
+        title=_('The number of translation messages for this template.'),
+        required=True, readonly=True),
+        exported_as='message_count')
+
+    language_count = exported(Int(
         title=_('The number of languages for which we have translations.'),
-        required=True, readonly=True)
+        required=True, readonly=True))
 
     translationtarget = Attribute(
         _('''
@@ -305,9 +278,9 @@
             This will either be an `ISourcePackage` or an `IProductSeries`.
             '''))
 
-    date_last_updated = Datetime(
+    date_last_updated = exported(Datetime(
         title=_('Date for last update'),
-        required=True)
+        required=True))
 
     uses_english_msgids = Bool(
         title=_("Uses English strings as msgids"), readonly=True,
@@ -537,12 +510,14 @@
     distroseries = Object(
         title=_(
             'The `IDistroSeries` associated with this subset.'),
-        schema=IDistroSeries)
+        # Really IDistroSeries, see _schema_circular_imports.py.
+        schema=Interface)
 
     productseries = Object(
         title=_(
             'The `IProductSeries` associated with this subset.'),
-        schema=IProductSeries)
+        # Really IProductSeries, see _schema_circular_imports.py.
+        schema=Interface)
 
     iscurrent = Bool(
         title=_("Filter for iscurrent flag."),
@@ -599,9 +574,9 @@
     def getClosestPOTemplate(path):
         """Return a `IPOTemplate` with a path closer to given path, or None.
 
-        If there is no `IPOTemplate` with a common path with the given argument,
-        or if there are more than one `IPOTemplate` with the same common path,
-        and both are the closer ones, returns None.
+        If there is no `IPOTemplate` with a common path with the given,
+        argument or if there are more than one `IPOTemplate` with the same
+        common path, and both are the closer ones, returns None.
         """
 
     def findUniquePathlessMatch(filename):
@@ -677,7 +652,8 @@
     product = Object(
         title=_(
             'The `IProduct` associated with this subset.'),
-        schema=IProduct)
+        # Really IProduct, see _schema_circular_imports.py.
+        schema=Interface)
 
     sourcepackagename = Object(
         title=_(
@@ -722,3 +698,52 @@
     content = Bytes(
         title=_("PO Template File to Import"),
         required=True)
+
+
+class IHasTranslationTemplates(Interface):
+    """An entity that has translation templates attached.
+
+    Examples include `ISourcePackage`, `IDistroSeries`, and `IProductSeries`.
+    """
+
+    has_current_translation_templates = Bool(
+        title=_("Does this object have current translation templates?"),
+        readonly=True)
+
+    def getCurrentTranslationTemplates(just_ids=False):
+        """Return an iterator over all active translation templates.
+
+        A translation template is considered active when both
+        `IPOTemplate`.iscurrent and parent official_rosetta flags
+        are set to True.
+        """
+
+    def getCurrentTranslationFiles(just_ids=False):
+        """Return an iterator over all active translation files.
+
+        A translation file is active if it's attached to an
+        active translation template.
+        """
+
+    def getObsoleteTranslationTemplates():
+        """Return an iterator over its not active translation templates.
+
+        A translation template is considered not active when any of
+        `IPOTemplate`.iscurrent or `IDistribution`.official_rosetta flags
+        are set to False.
+        """
+
+    @export_read_operation()
+    @operation_returns_collection_of(IPOTemplate)
+    def getTranslationTemplates():
+        """Return an iterator over all its translation templates.
+
+        The returned templates are either obsolete or current.
+        """
+
+    def getTranslationTemplateFormats():
+        """A list of native formats for all current translation templates.
+        """
+
+# Monkey patch for circular import avoidance done in
+# _schema_circular_imports.py

=== modified file 'lib/lp/translations/interfaces/webservice.py'
--- lib/lp/translations/interfaces/webservice.py	2009-07-17 02:25:09 +0000
+++ lib/lp/translations/interfaces/webservice.py	2010-06-03 16:14:30 +0000
@@ -1,9 +1,24 @@
 # Copyright 2009 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
+# pylint: disable-msg=W0611
+
 """All the interfaces that are exposed through the webservice."""
 
+__all__ = [
+    'IHasTranslationImports',
+    'IPOFile',
+    'IPOTemplate',
+    'ITranslationImportQueue',
+    'ITranslationImportQueueEntry',
+    ]
+
 from lp.translations.interfaces.translationimportqueue import (
     IHasTranslationImports,
     ITranslationImportQueue,
     ITranslationImportQueueEntry)
+
+from lp.translations.interfaces.potemplate import (
+    IPOTemplate)
+from lp.translations.interfaces.pofile import (
+    IPOFile)

=== modified file 'lib/lp/translations/model/distroseries_translations_copy.py'
--- lib/lp/translations/model/distroseries_translations_copy.py	2009-07-17 00:26:05 +0000
+++ lib/lp/translations/model/distroseries_translations_copy.py	2010-06-03 16:14:30 +0000
@@ -44,7 +44,7 @@
     copier = MultiTableCopy(full_name, translation_tables, logger=logger)
 
     # Incremental copy of updates is no longer supported
-    assert len(child.getTranslationTemplates()) == 0, (
+    assert child.getTranslationTemplates().is_empty(), (
            "The child series must not yet have any translation templates.")
 
     logger.info(

=== modified file 'lib/lp/translations/model/potemplate.py'
--- lib/lp/translations/model/potemplate.py	2010-01-12 21:29:03 +0000
+++ lib/lp/translations/model/potemplate.py	2010-06-03 16:14:30 +0000
@@ -1297,8 +1297,8 @@
         elif sourcepackagename is None:
             # Multiple matches, and for a product not a package.
             logging.warn(
-                "Found %d templates with path '%s' for productseries %s" % (
-                    len(matches), path, productseries.title))
+                "Found %d templates with path '%s' for productseries %s",
+                len(matches), path, productseries.title)
             return None
         else:
             # Multiple matches, for a distribution package.  Prefer a
@@ -1316,9 +1316,9 @@
             else:
                 logging.warn(
                     "Found %d templates with path '%s' for package %s "
-                    "(%d matched on from_sourcepackagename)." % (
-                        len(matches), path, sourcepackagename.name,
-                        len(preferred_matches)))
+                    "(%d matched on from_sourcepackagename).",
+                    len(matches), path, sourcepackagename.name,
+                    len(preferred_matches))
                 return None
 
     @staticmethod
@@ -1510,10 +1510,6 @@
                     if flag
                     ])
 
-            # Store sequences so we can detect later whether we changed the
-            # message.
-            sequence = row.sequence
-
             # Store the message.
             messages.append(msgset)
 

=== added file 'lib/lp/translations/stories/webservice/xx-potemplate.txt'
--- lib/lp/translations/stories/webservice/xx-potemplate.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/translations/stories/webservice/xx-potemplate.txt	2010-06-03 16:14:30 +0000
@@ -0,0 +1,121 @@
+PO Template webservices
+=======================
+
+
+Getting the attributes of a POTemplate
+--------------------------------------
+
+Anonymous users have read access to PO templates attributes.
+
+    >>> from lazr.restful.testing.webservice import pprint_entry
+    >>> potemplate = anon_webservice.get(
+    ...     '/ubuntu/hoary/+source/pmount/+pots/pmount').jsonBody()
+    >>> pprint_entry(potemplate)
+    active: True
+    date_last_updated: u'2005-05-06T20:09:23.775993+00:00'
+    description: None
+    exported_in_languagepacks: True
+    format: u'PO format'
+    id: 2
+    language_count: 8
+    message_count: 63
+    name: u'pmount'
+    owner_link: u'http://.../~rosetta-admins'
+    path: u'po/template.pot'
+    priority: 0
+    resource_type_link: u'http://.../#translation_template'
+    self_link: u'http://.../ubuntu/hoary/+source/pmount/+pots/pmount'
+    translation_domain: u'pmount'
+    translation_files_collection_link:
+        u'http://.../pmount/+pots/pmount/translation_files'
+
+"translation_files" will list all POFiles associated with this template.
+
+    >>> translation_files = anon_webservice.get(
+    ...     potemplate['translation_files_collection_link']).jsonBody()
+    >>> print translation_files['total_size']
+    9
+    >>> print(translation_files['entries'][0]['resource_type_link'])
+    http://.../#translation_file
+
+
+Getting all potemplates for a distribution series
+-------------------------------------------------
+
+All templates associated to a distribution series are available from the
+'getTranslationTemplates' GET method.
+
+    >>> from zope.component import getUtility
+    >>> from canonical.launchpad.interfaces.launchpad import (
+    ...     ILaunchpadCelebrities)
+    >>> from lp.translations.interfaces.potemplate import IPOTemplateSet
+    >>> login('[e-mail]')
+    >>> hoary = getUtility(ILaunchpadCelebrities).ubuntu.getSeries('hoary')
+    >>> templates = getUtility(IPOTemplateSet).getSubset(distroseries=hoary)
+    >>> db_count = len(list(templates))
+    >>> logout()
+    >>> all_translation_templates = anon_webservice.named_get(
+    ...     '/ubuntu/hoary/', 'getTranslationTemplates').jsonBody()
+    >>> api_count = all_translation_templates['total_size']
+    >>> api_count == db_count
+    True
+    >>> print(all_translation_templates['entries'][0]['resource_type_link'])
+    http://.../#translation_template
+
+
+Getting all potemplates for a product series
+--------------------------------------------
+
+All translation templates for a product series are available using the
+'getTranslationTemplates' GET method.
+
+    >>> login('[e-mail]')
+    >>> productseries = factory.makeProductSeries()
+    >>> potemplate_1 = factory.makePOTemplate(productseries=productseries)
+    >>> potemplate_2 = factory.makePOTemplate(productseries=productseries)
+    >>> potemplate_count = 2
+    >>> logout()
+    >>> all_translation_templates = anon_webservice.named_get(
+    ...     '/%s/%s' % (
+    ...         productseries.product.name,
+    ...         productseries.name),
+    ...     'getTranslationTemplates'
+    ...     ).jsonBody()
+    >>> api_count = all_translation_templates['total_size']
+    >>> api_count == potemplate_count
+    True
+    >>> print(all_translation_templates['entries'][0]['resource_type_link'])
+    http://.../#translation_template
+
+
+Getting all translation templates for a source package
+------------------------------------------------------
+
+All translation templates for a source package are available using the
+'getTranslationTemplates' GET method.
+
+
+    >>> from zope.component import getUtility
+    >>> from canonical.launchpad.interfaces.launchpad import (
+    ...     ILaunchpadCelebrities)
+    >>> from lp.registry.interfaces.sourcepackagename import (
+    ...     ISourcePackageNameSet)
+    >>> from lp.translations.interfaces.potemplate import IPOTemplateSet
+    >>> login('[e-mail]')
+    >>> hoary = getUtility(ILaunchpadCelebrities).ubuntu.getSeries('hoary')
+    >>> evolution_package = getUtility(ISourcePackageNameSet)['evolution']
+    >>> templates = getUtility(
+    ...     IPOTemplateSet).getSubset(
+    ...         distroseries=hoary,
+    ...         sourcepackagename=evolution_package)
+    >>> db_count = len(list(templates))
+    >>> logout()
+    >>> all_translation_templates = anon_webservice.named_get(
+    ...     '/ubuntu/hoary/+source/evolution',
+    ...     'getTranslationTemplates').jsonBody()
+    >>> api_count = all_translation_templates['total_size']
+    >>> api_count == db_count
+    True
+    >>> print(all_translation_templates['entries'][0]['resource_type_link'])
+    http://.../#translation_template
+