Adjust catalog commands to support forwarding options to babel

The following tweaks the catalog wrapper commands used to call babel's
`pofile`/`mofile` functions to support forwarding any keyword argument.
This can provide flexibility to callers which may wish to utilize
additional options provided by babel, without needing to add an explicit
option in the catalog wrapper calls.

A compatibility adjustment was added to `dump_po` to help map an
original argument `line_width` to babel's `width` argument. This is to
ensure callers which still use the `line_width` argument can
appropriately configure the babel call to impose the provided width.

Signed-off-by: James Knight <[email protected]>

Author: jdknight

sphinx_intl/basic.py

@@ -61,15 +61,15 @@ def update(locale_dir, pot_dir, languages, line_width=76):
                         status['update'] += 1
                         click.echo('Update: {0} +{1}, -{2}'.format(
                             po_file, len(added), len(deleted)))
-                        c.dump_po(po_file, cat, line_width)
+                        c.dump_po(po_file, cat, width=line_width)
                     else:
                         status['notchanged'] += 1
                         click.echo('Not Changed: {0}'.format(po_file))
                 else:  # new po file
                     status['create'] += 1
                     click.echo('Create: {0}'.format(po_file))
                     cat_pot.locale = lang
-                    c.dump_po(po_file, cat_pot, line_width)
+                    c.dump_po(po_file, cat_pot, width=line_width)
 
     return status
 

sphinx_intl/catalog.py

@@ -6,10 +6,11 @@
 from babel.messages import pofile, mofile
 
 
-def load_po(filename):
+def load_po(filename, **kwargs):
     """read po/pot file and return catalog object
 
     :param unicode filename: path to po/pot file
+    :param kwargs: keyword arguments to forward to babel's read_po call
     :return: catalog object
     """
     # pre-read to get charset
@@ -20,27 +21,36 @@ def load_po(filename):
     # To decode lines by babel, read po file as binary mode and specify charset for
     # read_po function.
     with io.open(filename, 'rb') as f:  # FIXME: encoding VS charset
-        return pofile.read_po(f, charset=charset)
+        return pofile.read_po(f, charset=charset, **kwargs)
 
 
-def dump_po(filename, catalog, line_width=76):
+def dump_po(filename, catalog, **kwargs):
     """write po/pot file from catalog object
 
     :param unicode filename: path to po file
     :param catalog: catalog object
-    :param line_width: maximum line wdith of po files
+    :param kwargs: keyword arguments to forward to babel's write_po call; also
+                    accepts a deprecated `line_width` option to forward to
+                    write_po's `width` option
     :return: None
     """
     dirname = os.path.dirname(filename)
     if not os.path.exists(dirname):
         os.makedirs(dirname)
 
+    # (compatibility) line_width was the original argument used to forward
+    # line width hints into write_po's `width` argument; if provided,
+    # set/override the width value
+    if 'line_width' in kwargs:
+        kwargs['width'] = kwargs['line_width']
+        del kwargs['line_width']
+
     # Because babel automatically encode strings, file should be open as binary mode.
     with io.open(filename, 'wb') as f:
-        pofile.write_po(f, catalog, line_width)
+        pofile.write_po(f, catalog, **kwargs)
 
 
-def write_mo(filename, catalog):
+def write_mo(filename, catalog, **kwargs):
     """write mo file from catalog object
 
     :param unicode filename: path to mo file
@@ -51,7 +61,7 @@ def write_mo(filename, catalog):
     if not os.path.exists(dirname):
         os.makedirs(dirname)
     with io.open(filename, 'wb') as f:
-        mofile.write_mo(f, catalog)
+        mofile.write_mo(f, catalog, **kwargs)
 
 
 def translated_entries(catalog):