Merge lp:~rachidbm/ubuntu-l10n-tools/pot-priority into lp:ubuntu-l10n-tools

[Rachid]

Retrieve active series from Launchpad
Added class to handle the stuff regarding POT and Launchpad
Prioritise just one template or give an CSV file
Edit 1 pot over several distro codenames

Removed unnecessary has_header check in CSV reader
Removed obsolete imports

[David Planella (dpm)]

Looks good, thanks Rachid!

Just a couple of things

* On ul10n_tools/lp_set_pot_priority/__init__.py the "The missing bits from the API are the traversal bits where you'd be able to walk" line and others introduce unnecessary trailing space. Please try to look at the diff before sending future merge proposals
* The new test.csv file has a line with an invalid prioritiy (72a00). Is this intentional?
* It'd be great to start adding automated tests for all tools, and move away this .csv file to be part of the tests. Some background info: https://wiki.ubuntu.com/MeetingLogs/appdevweek1104/RockSolidPython
* I'd suggest moving the PotUtil module somewhere else rather than inside ul10n_tools/lp_set_pot_priority/, as in principle it should be not directly related to setting the priority, but rather in the future it should be able to set any template properties-

These are not blockers, so I'll merge the branch now. Good work!

review: Approve

[Rachid (rachidbm)]

Thanks for the review. I agree with your remarks.

The invalid property in test.csv was intentional for testing the NON happy flow. This can be removed when we have proper automatic tests.

=== added file 'ul10n_tools/lp_set_pot_priority/PotUtil.py'
--- ul10n_tools/lp_set_pot_priority/PotUtil.py	1970-01-01 00:00:00 +0000
+++ ul10n_tools/lp_set_pot_priority/PotUtil.py	2011-06-09 13:54:16 +0000
@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Original author: Rachid BM <[e-mail]>
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+import sys
+import csv
+
+class PotUtil(object):
+    """
+    Utility class for changing properties of po templates
+    """
+
+
+    def __init__(self, launchpad, releases):
+        self.launchpad = launchpad
+        self.releases = releases
+        self.api_url = self.launchpad.distributions['ubuntu']
+        logging.debug("API URL: {0}".format(self.api_url))
+
+
+    def set_priority(self, source, template, priority):
+        """
+        Sets the priority of a template
+
+        Keyword arguments:
+        source -- the source package
+        template -- the name of the template
+        priority -- the new priority 
+        """
+        print "Setting {0}/{1}'s priority to {2}...".format(source, template, 
+            priority)
+
+        for release in self.releases: 
+            URL = '{0}/{1}/+source/{2}/+pots/{3}'.format(self.api_url, release,
+                source, template)
+            logging.debug("API URL: {0}".format(URL))
+            pot = self.launchpad.load(URL)
+            try:
+                pot.priority = int(priority)
+            except:
+                print >> sys.stderr, 'ERROR: {0} is not a valid integer as ' \
+                    'priority.'.format(priority)
+                sys.exit(1)
+            pot.lp_save()
+
+
+    def set_priorities_csv(self, csv_filename):
+        """
+        Read templates/priorities from the CSV file
+        and set the priority of each template
+        
+        Keyword arguments:
+        csv_filename -- the filename of the CSV file to read
+        """
+        # Read the CSV file
+        with open(csv_filename, 'rb') as f:
+            reader = csv.DictReader(f)
+            prio_key, srcpkg_key, pot_key = reader.fieldnames
+            for row in reader:
+                priority = row[prio_key]
+                source = row[srcpkg_key].strip()
+                template = row[pot_key].strip()
+                self.set_priority(source, template, priority)
+
+
+    def set_name(self, source, template, new_name):
+        # TODO
+        pass
 
=== modified file 'ul10n_tools/lp_set_pot_priority/__init__.py'
--- ul10n_tools/lp_set_pot_priority/__init__.py	2011-06-08 11:28:20 +0000
+++ ul10n_tools/lp_set_pot_priority/__init__.py	2011-06-09 13:54:16 +0000
@@ -7,12 +7,10 @@
 #
 #  https://translations.launchpad.net/ubuntu/natty/+templates
 #
-# (for the staging server)
-#
-# Note that we cannot fully use the LP API in a nice way, but the current script
+# Note that we cannot fully use the LP API in a nice way, but the current script 
 # uses a workaround that works pretty well.
-# The missing bits from the API are the traversal bits where you'd be able to walk
-# the templates from within already exposed objects, instead of using
+# The missing bits from the API are the traversal bits where you'd be able to walk 
+# the templates from within already exposed objects, instead of using 
 # "launchpad.load()" directly
 
 # TODO: Generalize the script to be able to:
@@ -20,36 +18,47 @@
 #       - Disable templates (active, exported_in_languagepacks properties)
 
 import sys
-import csv
 import logging
 import optparse
-from ul10n_tools.utils.launchpadmanager import get_launchpad
+import platform
+from ul10n_tools.utils.launchpadmanager import (get_launchpad, 
+    get_distro_codenames)
+from ul10n_tools.lp_set_pot_priority.PotUtil import PotUtil
 
 LEVELS = (  logging.ERROR,
             logging.WARNING,
             logging.INFO,
             logging.DEBUG,
             )
+DEFAULT_DISTRO_CODENAME = platform.dist()[2]    # Codename of current system.
 
 def main():
     # Support for command line options.
-    # TODO: allow the script to be called without a CSV file, i.e.
-    # specifying --source, --template and --priority
-    # TODO: allow specifying a comma- or whitespace-separated list of distro
-    # series over which to loop over and set priorities
     USAGE = """%prog [OPTIONS] FILE
 
-    Sets the priorities of translatable templates in Launchpad according to the
-    given CSV file"""
+    Sets the properties of translatable templates in Launchpad"""
     parser = optparse.OptionParser(usage = USAGE)
+    parser.add_option("-c", "--distro-codenames", dest="distro_codenames",
+        help="Specify one or more distro's codenames. Default is the version of your system. Comma-seperated when specifying more than one.")
     parser.add_option('-d', '--debug', dest='debug_mode', action='store_true',
         help = 'Print the maximum debugging info (implies -vvv)')
+    parser.add_option('-f', '--csv-file', dest='csv_file',
+        help = 'Specify a CSV file with templates and their desired priorities')
+    parser.add_option('-l', '--use-production', dest='use_staging', 
+        action='store_false',
+        help = 'Use the launchpad "production" server. Default is "staging"')
+    parser.add_option('-p', '--priority', dest='priority',
+        help = 'Set priority. Use this in conjunction with -t and -s')
+    parser.add_option('-s', '--source', dest='source',
+        help = 'Source package. Use this in conjunction with -t')
+    parser.add_option('-t', '--template', dest='template',
+        help = 'Template name. Use this in conjunction with -s')
     parser.add_option('-v', '--verbose', dest='logging_level', action='count',
         help = 'Set error_level output to warning, info, and then debug')
-    parser.add_option('-p', '--use-production', dest='use_staging', action='store_false',
-        help = 'Use the launchpad "production" server. Default is "staging"')
 
-    parser.set_defaults(logging_level = 0, use_staging = True)
+    parser.set_defaults(logging_level = 0,
+                        use_staging = True,
+                        distro_codenames = DEFAULT_DISTRO_CODENAME)
     (options, args) = parser.parse_args()
 
     # Set the verbosity
@@ -58,38 +67,27 @@
     logging.basicConfig(level = LEVELS[options.logging_level],
                         format = '%(asctime)s %(levelname)s %(message)s')
 
-    # TODO: this should be an option (see TODO above)
-    UBUNTU_RELEASE = 'natty'
-
-    # Error checking (the pattern must be specified)
-    # TODO: do this checking only if --source or --template haven't been specified
-    # TODO: when implementing this, check that whenever --source or --template are
-    # specified, the other one is as well
-    if len(args) < 1:
-        print >> sys.stderr, 'ERROR: Not enough arguments, a CSV file must be specified'
+    # Log into Launchpad
+    launchpad = get_launchpad(options.use_staging)
+
+    releases = options.distro_codenames.strip().split(',')
+    logging.debug("Use staging: {0}".format(options.use_staging))
+    logging.debug("Specified releases: {0}".format(', '.join(releases)))
+
+    # Validate specified distro's codenames
+    for rel in releases:
+        if not rel in get_distro_codenames(launchpad):
+            print >> sys.stderr, "ERROR: {0} is not a valid Ubuntu release " \
+            "name.".format(rel)
+            sys.exit(1)
+
+    pot_util = PotUtil(launchpad, releases)
+
+    if options.source and options.template and options.priority: 
+        pot_util.set_priority(options.source, options.template, options.priority)
+    elif options.csv_file:
+        pot_util.set_priorities_csv(options.csv_file)
+    else:
+        print >> sys.stderr, 'ERROR: Not enough arguments. Either specify a' \
+        ' CSV file  with -f or the parameters -s, -t and -p must be specified.'
         sys.exit(1)
-    else:
-        priorities_file = args[0]
-        logging.debug("Using CSV file: {0}".format(priorities_file))
-
-    logging.debug("Use staging: %s" % (options.use_staging))
-
-    launchpad = get_launchpad(options.use_staging)
-
-    with open(priorities_file, 'rb') as f:
-        reader = csv.DictReader(f)
-        prio_key, srcpkg_key, pot_key = reader.fieldnames
-        for row in reader:
-            priority = int(row[prio_key])
-            srcpkg = row[srcpkg_key].strip()
-            pot = row[pot_key].strip()
-
-        print "Setting {0}/{1}'s priority to {2}...".format(srcpkg, pot,
-                                                            priority)
-        template = launchpad.load(
-            # TODO: make the 'natty' part a command line option (e.g. --distro natty)
-            'https://api.launchpad.net/1.0/ubuntu/' +
-            '{0}/+source/{1}/+pots/{2}'.format(UBUNTU_RELEASE, srcpkg, pot))
-        template.priority = priority
-        template.lp_save()
-
 
=== added file 'ul10n_tools/lp_set_pot_priority/test.csv'
--- ul10n_tools/lp_set_pot_priority/test.csv	1970-01-01 00:00:00 +0000
+++ ul10n_tools/lp_set_pot_priority/test.csv	2011-06-09 13:54:16 +0000
@@ -0,0 +1,4 @@
+Priority,Source package,Template name
+9010,sessioninstaller,sessioninstaller
+7200,gnome-user-share,gnome-user-share
+72a00,gsettings-desktop-schemas,gsettings-desktop-schemas
 
=== modified file 'ul10n_tools/ul10n_toolsconfig.py'
--- ul10n_tools/ul10n_toolsconfig.py	2011-04-09 08:51:51 +0000
+++ ul10n_tools/ul10n_toolsconfig.py	2011-06-09 13:54:16 +0000
@@ -26,6 +26,7 @@
 from gettext import gettext as _
 gettext.textdomain('ul10n-tools')
 
+
 class project_path_not_found(Exception):
     """Raised when we can't find the project directory."""
 
 
=== modified file 'ul10n_tools/utils/launchpadmanager.py'
--- ul10n_tools/utils/launchpadmanager.py	2011-05-30 08:41:38 +0000
+++ ul10n_tools/utils/launchpadmanager.py	2011-06-09 13:54:16 +0000
@@ -31,3 +31,9 @@
 
     return launchpad
 
+
+def get_distro_codenames(launchpad):
+    """Returns a list of active distro series retrieved from Launchpad"""
+    ubuntu = launchpad.distributions['ubuntu']
+    ubuntu_series = ubuntu.series_collection
+    return [series.name for series in ubuntu.series_collection if series.active]