From: Aarni Koskela <akx@iki.fi>
Date: Fri, 29 Jan 2016 12:47:30 +0000 (+0200)
Subject: pofile: refactor message sorting into helper fn
X-Git-Tag: 2.3.1~23^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F300%2Fhead;p=thirdparty%2Fbabel.git

pofile: refactor message sorting into helper fn
---

diff --git a/babel/messages/pofile.py b/babel/messages/pofile.py
index 3c18226d..1fb2c1c3 100644
--- a/babel/messages/pofile.py
+++ b/babel/messages/pofile.py
@@ -427,13 +427,13 @@ def write_po(fileobj, catalog, width=76, no_location=False, omit_header=False,
                 prefix, _normalize(message.string or '', prefix)
             ))
 
-    messages = list(catalog)
+    sort_by = None
     if sort_output:
-        messages.sort()
+        sort_by = "message"
     elif sort_by_file:
-        messages.sort(key=lambda m: m.locations)
+        sort_by = "location"
 
-    for message in messages:
+    for message in _sort_messages(catalog, sort_by=sort_by):
         if not message.id: # This is the header "message"
             if omit_header:
                 continue
@@ -474,14 +474,29 @@ def write_po(fileobj, catalog, width=76, no_location=False, omit_header=False,
         _write('\n')
 
     if not ignore_obsolete:
-        obsolete = list(catalog.obsolete.values())
-        if sort_output:
-            obsolete.sort()
-        elif sort_by_file:
-            obsolete.sort(key=lambda m: m.locations)
-
-        for message in obsolete:
+        for message in _sort_messages(
+            catalog.obsolete.values(),
+            sort_by=sort_by
+        ):
             for comment in message.user_comments:
                 _write_comment(comment)
             _write_message(message, prefix='#~ ')
             _write('\n')
+
+
+def _sort_messages(messages, sort_by):
+    """
+    Sort the given message iterable by the given criteria.
+
+    Always returns a list.
+
+    :param messages: An iterable of Messages.
+    :param sort_by: Sort by which criteria? Options are `message` and `location`.
+    :return: list[Message]
+    """
+    messages = list(messages)
+    if sort_by == "message":
+        messages.sort()
+    elif sort_by == "location":
+        messages.sort(key=lambda m: m.locations)
+    return messages