annotate babel/messages/frontend.py @ 523:81e35b223dd6

shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
author fschwarz
date Sat, 05 Mar 2011 14:53:03 +0000
parents 36856816299a
children 85e1beadacb0
rev   line source
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1 #!/usr/bin/env python
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
2 # -*- coding: utf-8 -*-
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
3 #
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 331
diff changeset
4 # Copyright (C) 2007-2008 Edgewall Software
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
5 # All rights reserved.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
6 #
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
7 # This software is licensed as described in the file COPYING, which
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
8 # you should have received as part of this distribution. The terms
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
9 # are also available at http://babel.edgewall.org/wiki/License.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
10 #
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
11 # This software consists of voluntary contributions made by many
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
12 # individuals. For the exact contribution history, see the revision
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
13 # history and logs, available at http://babel.edgewall.org/log/.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
14
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
15 """Frontends for the message extraction functionality."""
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
16
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
17 from ConfigParser import RawConfigParser
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
18 from datetime import datetime
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
19 from distutils import log
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
20 from distutils.cmd import Command
49
daf35e2ad044 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 48
diff changeset
21 from distutils.errors import DistutilsOptionError, DistutilsSetupError
298
257534b131bd When using sys.stdout with a pipe or redirection the sys.stdout.encoding value
jruigrok
parents: 290
diff changeset
22 from locale import getpreferredencoding
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
23 import logging
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
24 from optparse import OptionParser
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
25 import os
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
26 import re
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
27 import shutil
49
daf35e2ad044 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 48
diff changeset
28 from StringIO import StringIO
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
29 import sys
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
30 import tempfile
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
31
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
32 from babel import __version__ as VERSION
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
33 from babel import Locale, localedata
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
34 from babel.core import UnknownLocaleError
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents: 55
diff changeset
35 from babel.messages.catalog import Catalog
54
b3395b285104 Rename the `babel.catalog` package to `babel.messages` for consistency with the other package names.
cmlenz
parents: 52
diff changeset
36 from babel.messages.extract import extract_from_dir, DEFAULT_KEYWORDS, \
b3395b285104 Rename the `babel.catalog` package to `babel.messages` for consistency with the other package names.
cmlenz
parents: 52
diff changeset
37 DEFAULT_MAPPING
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
38 from babel.messages.mofile import write_mo
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
39 from babel.messages.pofile import read_po, write_po
54
b3395b285104 Rename the `babel.catalog` package to `babel.messages` for consistency with the other package names.
cmlenz
parents: 52
diff changeset
40 from babel.messages.plurals import PLURALS
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
41 from babel.util import odict, LOCALTZ
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
42
178
4407c6d1b7d7 Minor change to what symbols are ?exported?, primarily for the generated docs.
cmlenz
parents: 177
diff changeset
43 __all__ = ['CommandLineInterface', 'compile_catalog', 'extract_messages',
234
ada322f472ca Add more `since` tags to stuff added in trunk.
cmlenz
parents: 232
diff changeset
44 'init_catalog', 'check_message_extractors', 'update_catalog']
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
45 __docformat__ = 'restructuredtext en'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
46
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
47
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
48 class compile_catalog(Command):
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
49 """Catalog compilation command for use in ``setup.py`` scripts.
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
50
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
51 If correctly installed, this command is available to Setuptools-using
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
52 setup scripts automatically. For projects using plain old ``distutils``,
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
53 the command needs to be registered explicitly in ``setup.py``::
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
54
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
55 from babel.messages.frontend import compile_catalog
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
56
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
57 setup(
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
58 ...
169
792510b0c77c Typo fix.
palgarvio
parents: 165
diff changeset
59 cmdclass = {'compile_catalog': compile_catalog}
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
60 )
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
61
234
ada322f472ca Add more `since` tags to stuff added in trunk.
cmlenz
parents: 232
diff changeset
62 :since: version 0.9
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
63 :see: `Integrating new distutils commands <http://docs.python.org/dist/node32.html>`_
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
64 :see: `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
65 """
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
66
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
67 description = 'compile message catalogs to binary MO files'
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
68 user_options = [
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
69 ('domain=', 'D',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
70 "domain of PO file (default 'messages')"),
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
71 ('directory=', 'd',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
72 'path to base directory containing the catalogs'),
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
73 ('input-file=', 'i',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
74 'name of the input file'),
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
75 ('output-file=', 'o',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
76 "name of the output file (default "
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
77 "'<output_dir>/<locale>/LC_MESSAGES/<domain>.po')"),
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
78 ('locale=', 'l',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
79 'locale of the catalog to compile'),
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
80 ('use-fuzzy', 'f',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
81 'also include fuzzy translations'),
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
82 ('statistics', None,
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
83 'print statistics about translations')
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
84 ]
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
85 boolean_options = ['use-fuzzy', 'statistics']
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
86
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
87 def initialize_options(self):
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
88 self.domain = 'messages'
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
89 self.directory = None
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
90 self.input_file = None
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
91 self.output_file = None
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
92 self.locale = None
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
93 self.use_fuzzy = False
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
94 self.statistics = False
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
95
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
96 def finalize_options(self):
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
97 if not self.input_file and not self.directory:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
98 raise DistutilsOptionError('you must specify either the input file '
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
99 'or the base directory')
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
100 if not self.output_file and not self.directory:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
101 raise DistutilsOptionError('you must specify either the input file '
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
102 'or the base directory')
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
103
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
104 def run(self):
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
105 po_files = []
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
106 mo_files = []
175
3c4718fb7435 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 170
diff changeset
107
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
108 if not self.input_file:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
109 if self.locale:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
110 po_files.append((self.locale,
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
111 os.path.join(self.directory, self.locale,
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
112 'LC_MESSAGES',
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
113 self.domain + '.po')))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
114 mo_files.append(os.path.join(self.directory, self.locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
115 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
116 self.domain + '.mo'))
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
117 else:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
118 for locale in os.listdir(self.directory):
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
119 po_file = os.path.join(self.directory, locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
120 'LC_MESSAGES', self.domain + '.po')
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
121 if os.path.exists(po_file):
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
122 po_files.append((locale, po_file))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
123 mo_files.append(os.path.join(self.directory, locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
124 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
125 self.domain + '.mo'))
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
126 else:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
127 po_files.append((self.locale, self.input_file))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
128 if self.output_file:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
129 mo_files.append(self.output_file)
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
130 else:
288
f919257d4fc7 Fix error in `compile_catalog` distutils command. Closes #65.
cmlenz
parents: 279
diff changeset
131 mo_files.append(os.path.join(self.directory, self.locale,
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
132 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
133 self.domain + '.mo'))
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
134
208
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
135 if not po_files:
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
136 raise DistutilsOptionError('no message catalogs found')
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
137
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
138 for idx, (locale, po_file) in enumerate(po_files):
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
139 mo_file = mo_files[idx]
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
140 infile = open(po_file, 'r')
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
141 try:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
142 catalog = read_po(infile, locale)
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
143 finally:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
144 infile.close()
175
3c4718fb7435 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 170
diff changeset
145
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
146 if self.statistics:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
147 translated = 0
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
148 for message in list(catalog)[1:]:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
149 if message.string:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
150 translated +=1
317
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
151 percentage = 0
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
152 if len(catalog):
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
153 percentage = translated * 100 // len(catalog)
231
772739bbd2e8 Use proper logging in distutils `compile_catalog` command.
cmlenz
parents: 220
diff changeset
154 log.info('%d of %d messages (%d%%) translated in %r',
317
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
155 translated, len(catalog), percentage, po_file)
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
156
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
157 if catalog.fuzzy and not self.use_fuzzy:
231
772739bbd2e8 Use proper logging in distutils `compile_catalog` command.
cmlenz
parents: 220
diff changeset
158 log.warn('catalog %r is marked as fuzzy, skipping', po_file)
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
159 continue
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
160
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
161 for message, errors in catalog.check():
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
162 for error in errors:
231
772739bbd2e8 Use proper logging in distutils `compile_catalog` command.
cmlenz
parents: 220
diff changeset
163 log.error('error: %s:%d: %s', po_file, message.lineno,
772739bbd2e8 Use proper logging in distutils `compile_catalog` command.
cmlenz
parents: 220
diff changeset
164 error)
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
165
231
772739bbd2e8 Use proper logging in distutils `compile_catalog` command.
cmlenz
parents: 220
diff changeset
166 log.info('compiling catalog %r to %r', po_file, mo_file)
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
167
279
7730086e47d9 Write PO files in binary mode. Closes #61.
cmlenz
parents: 267
diff changeset
168 outfile = open(mo_file, 'wb')
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
169 try:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
170 write_mo(outfile, catalog, use_fuzzy=self.use_fuzzy)
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
171 finally:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
172 outfile.close()
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
173
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
174
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
175 class extract_messages(Command):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
176 """Message extraction command for use in ``setup.py`` scripts.
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
177
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
178 If correctly installed, this command is available to Setuptools-using
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
179 setup scripts automatically. For projects using plain old ``distutils``,
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
180 the command needs to be registered explicitly in ``setup.py``::
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
181
54
b3395b285104 Rename the `babel.catalog` package to `babel.messages` for consistency with the other package names.
cmlenz
parents: 52
diff changeset
182 from babel.messages.frontend import extract_messages
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
183
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
184 setup(
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
185 ...
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
186 cmdclass = {'extract_messages': extract_messages}
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
187 )
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
188
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
189 :see: `Integrating new distutils commands <http://docs.python.org/dist/node32.html>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
190 :see: `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
191 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
192
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
193 description = 'extract localizable strings from the project code'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
194 user_options = [
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
195 ('charset=', None,
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
196 'charset to use in the output file'),
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
197 ('keywords=', 'k',
10
b24987f7318d Both Babel's [source:trunk/babel/catalog/frontend.py frontend] and [source:trunk/babel/catalog/extract.py extract] now handle keyword indices. Also added an extra boolean flag so that the default keywords defined by Babel are not included in the keywords to search for when extracting strings.
palgarvio
parents: 7
diff changeset
198 'space-separated list of keywords to look for in addition to the '
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
199 'defaults'),
10
b24987f7318d Both Babel's [source:trunk/babel/catalog/frontend.py frontend] and [source:trunk/babel/catalog/extract.py extract] now handle keyword indices. Also added an extra boolean flag so that the default keywords defined by Babel are not included in the keywords to search for when extracting strings.
palgarvio
parents: 7
diff changeset
200 ('no-default-keywords', None,
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
201 'do not include the default keywords'),
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
202 ('mapping-file=', 'F',
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
203 'path to the mapping configuration file'),
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
204 ('no-location', None,
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
205 'do not include location comments with filename and line number'),
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
206 ('omit-header', None,
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
207 'do not include msgid "" entry in header'),
5
50ad95bee876 * The creation-date header in generated PO files now includes the timezone offset.
cmlenz
parents: 1
diff changeset
208 ('output-file=', 'o',
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
209 'name of the output file'),
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
210 ('width=', 'w',
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
211 'set output line width (default 76)'),
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
212 ('no-wrap', None,
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
213 'do not break long message lines, longer than the output line width, '
58
dcd8ceccf416 Fix typo in [58].
cmlenz
parents: 57
diff changeset
214 'into several lines'),
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
215 ('sort-output', None,
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
216 'generate sorted output (default False)'),
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
217 ('sort-by-file', None,
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
218 'sort output by file location (default False)'),
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
219 ('msgid-bugs-address=', None,
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
220 'set report address for msgid'),
79
9a05230571f8 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
221 ('copyright-holder=', None,
9a05230571f8 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
222 'set copyright holder in output'),
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
223 ('add-comments=', 'c',
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
224 'place comment block with TAG (or those preceding keyword lines) in '
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
225 'output file. Seperate multiple TAGs with commas(,)'),
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
226 ('strip-comments', None,
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
227 'strip the comment TAGs from the comments.'),
59
5b5d35117a73 Fix 2nd typo of [58].
palgarvio
parents: 58
diff changeset
228 ('input-dirs=', None,
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
229 'directories that should be scanned for messages'),
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
230 ]
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
231 boolean_options = [
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
232 'no-default-keywords', 'no-location', 'omit-header', 'no-wrap',
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
233 'sort-output', 'sort-by-file', 'strip-comments'
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
234 ]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
235
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
236 def initialize_options(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
237 self.charset = 'utf-8'
117
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
238 self.keywords = ''
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
239 self._keywords = DEFAULT_KEYWORDS.copy()
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
240 self.no_default_keywords = False
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
241 self.mapping_file = None
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
242 self.no_location = False
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
243 self.omit_header = False
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
244 self.output_file = None
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
245 self.input_dirs = None
423
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
246 self.width = None
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
247 self.no_wrap = False
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
248 self.sort_output = False
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
249 self.sort_by_file = False
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
250 self.msgid_bugs_address = None
79
9a05230571f8 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
251 self.copyright_holder = None
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
252 self.add_comments = None
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 90
diff changeset
253 self._add_comments = []
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
254 self.strip_comments = False
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
255
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
256 def finalize_options(self):
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
257 if self.no_default_keywords and not self.keywords:
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
258 raise DistutilsOptionError('you must specify new keywords if you '
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
259 'disable the default ones')
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
260 if self.no_default_keywords:
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
261 self._keywords = {}
117
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
262 if self.keywords:
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
263 self._keywords.update(parse_keywords(self.keywords.split()))
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
264
117
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
265 if not self.output_file:
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
266 raise DistutilsOptionError('no output file specified')
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
267 if self.no_wrap and self.width:
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
268 raise DistutilsOptionError("'--no-wrap' and '--width' are mutually "
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
269 "exclusive")
423
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
270 if not self.no_wrap and not self.width:
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
271 self.width = 76
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
272 elif self.width is not None:
23
bd45ff425485 Added line-wrap support for `write_po`.
palgarvio
parents: 12
diff changeset
273 self.width = int(self.width)
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 90
diff changeset
274
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
275 if self.sort_output and self.sort_by_file:
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
276 raise DistutilsOptionError("'--sort-output' and '--sort-by-file' "
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
277 "are mutually exclusive")
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
278
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
279 if not self.input_dirs:
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
280 self.input_dirs = dict.fromkeys([k.split('.',1)[0]
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
281 for k in self.distribution.packages
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
282 ]).keys()
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 90
diff changeset
283
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
284 if self.add_comments:
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
285 self._add_comments = self.add_comments.split(',')
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
286
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
287 def run(self):
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
288 mappings = self._get_mappings()
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
289 outfile = open(self.output_file, 'w')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
290 try:
102
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
291 catalog = Catalog(project=self.distribution.get_name(),
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
292 version=self.distribution.get_version(),
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
293 msgid_bugs_address=self.msgid_bugs_address,
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
294 copyright_holder=self.copyright_holder,
102
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
295 charset=self.charset)
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
296
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
297 for dirname, (method_map, options_map) in mappings.items():
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
298 def callback(filename, method, options):
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
299 if method == 'ignore':
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
300 return
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
301 filepath = os.path.normpath(os.path.join(dirname, filename))
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
302 optstr = ''
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
303 if options:
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
304 optstr = ' (%s)' % ', '.join(['%s="%s"' % (k, v) for
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
305 k, v in options.items()])
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
306 log.info('extracting messages from %s%s', filepath, optstr)
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
307
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
308 extracted = extract_from_dir(dirname, method_map, options_map,
117
41506e62701f Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 112
diff changeset
309 keywords=self._keywords,
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
310 comment_tags=self._add_comments,
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
311 callback=callback,
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
312 strip_comment_tags=
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
313 self.strip_comments)
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
314 for filename, lineno, message, comments in extracted:
57
a6183d300a6e * The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories.
cmlenz
parents: 56
diff changeset
315 filepath = os.path.normpath(os.path.join(dirname, filename))
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
316 catalog.add(message, None, [(filepath, lineno)],
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
317 auto_comments=comments)
24
4fad20ab7cca Reimplement line wrapping for PO writing (as the `textwrap` module is too destructive with white space) and move it to the `normalize` function (which was already doing some handling of line breaks).
cmlenz
parents: 23
diff changeset
318
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
319 log.info('writing PO template file to %s' % self.output_file)
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
320 write_po(outfile, catalog, width=self.width,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
321 no_location=self.no_location,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
322 omit_header=self.omit_header,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
323 sort_output=self.sort_output,
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
324 sort_by_file=self.sort_by_file)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
325 finally:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
326 outfile.close()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
327
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
328 def _get_mappings(self):
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
329 mappings = {}
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
330
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
331 if self.mapping_file:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
332 fileobj = open(self.mapping_file, 'U')
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
333 try:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
334 method_map, options_map = parse_mapping(fileobj)
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
335 for dirname in self.input_dirs:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
336 mappings[dirname] = method_map, options_map
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
337 finally:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
338 fileobj.close()
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
339
123
c38b2cb52528 Make the check for the `message_extractors` setup keyword more robst.
cmlenz
parents: 120
diff changeset
340 elif getattr(self.distribution, 'message_extractors', None):
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
341 message_extractors = self.distribution.message_extractors
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
342 for dirname, mapping in message_extractors.items():
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
343 if isinstance(mapping, basestring):
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
344 method_map, options_map = parse_mapping(StringIO(mapping))
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
345 else:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
346 method_map, options_map = [], {}
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
347 for pattern, method, options in mapping:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
348 method_map.append((pattern, method))
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
349 options_map[pattern] = options or {}
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
350 mappings[dirname] = method_map, options_map
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
351
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
352 else:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
353 for dirname in self.input_dirs:
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
354 mappings[dirname] = DEFAULT_MAPPING, {}
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
355
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
356 return mappings
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
357
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
358
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
359 def check_message_extractors(dist, name, value):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
360 """Validate the ``message_extractors`` keyword argument to ``setup()``.
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
361
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
362 :param dist: the distutils/setuptools ``Distribution`` object
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
363 :param name: the name of the keyword argument (should always be
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
364 "message_extractors")
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
365 :param value: the value of the keyword argument
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
366 :raise `DistutilsSetupError`: if the value is not valid
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
367 :see: `Adding setup() arguments
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
368 <http://peak.telecommunity.com/DevCenter/setuptools#adding-setup-arguments>`_
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
369 """
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
370 assert name == 'message_extractors'
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
371 if not isinstance(value, dict):
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
372 raise DistutilsSetupError('the value of the "message_extractors" '
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
373 'parameter must be a dictionary')
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
374
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
375
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
376 class init_catalog(Command):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
377 """New catalog initialization command for use in ``setup.py`` scripts.
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
378
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
379 If correctly installed, this command is available to Setuptools-using
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
380 setup scripts automatically. For projects using plain old ``distutils``,
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
381 the command needs to be registered explicitly in ``setup.py``::
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
382
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
383 from babel.messages.frontend import init_catalog
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
384
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
385 setup(
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
386 ...
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
387 cmdclass = {'init_catalog': init_catalog}
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
388 )
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
389
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
390 :see: `Integrating new distutils commands <http://docs.python.org/dist/node32.html>`_
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
391 :see: `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
392 """
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
393
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
394 description = 'create a new catalog based on a POT file'
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
395 user_options = [
55
c3291ad6b010 `new_catalog` now accepts another argument, `--domain`, which is used to build the output file path, which now is of the form `<output_dir>/<locale>/<domain>.po`, the correct form.
palgarvio
parents: 54
diff changeset
396 ('domain=', 'D',
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
397 "domain of PO file (default 'messages')"),
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
398 ('input-file=', 'i',
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
399 'name of the input file'),
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
400 ('output-dir=', 'd',
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
401 'path to output directory'),
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
402 ('output-file=', 'o',
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
403 "name of the output file (default "
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
404 "'<output_dir>/<locale>/LC_MESSAGES/<domain>.po')"),
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
405 ('locale=', 'l',
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
406 'locale for the new localized catalog'),
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
407 ]
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
408
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
409 def initialize_options(self):
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
410 self.output_dir = None
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
411 self.output_file = None
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
412 self.input_file = None
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
413 self.locale = None
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
414 self.domain = 'messages'
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
415
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
416 def finalize_options(self):
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
417 if not self.input_file:
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
418 raise DistutilsOptionError('you must specify the input file')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
419
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
420 if not self.locale:
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
421 raise DistutilsOptionError('you must provide a locale for the '
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
422 'new catalog')
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
423 try:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
424 self._locale = Locale.parse(self.locale)
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
425 except UnknownLocaleError, e:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
426 raise DistutilsOptionError(e)
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
427
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
428 if not self.output_file and not self.output_dir:
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
429 raise DistutilsOptionError('you must specify the output directory')
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
430 if not self.output_file:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
431 self.output_file = os.path.join(self.output_dir, self.locale,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
432 'LC_MESSAGES', self.domain + '.po')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
433
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
434 if not os.path.exists(os.path.dirname(self.output_file)):
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
435 os.makedirs(os.path.dirname(self.output_file))
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
436
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
437 def run(self):
90
e43bb7dc7eec Some doc improvements on distutils integration.
cmlenz
parents: 88
diff changeset
438 log.info('creating catalog %r based on %r', self.output_file,
55
c3291ad6b010 `new_catalog` now accepts another argument, `--domain`, which is used to build the output file path, which now is of the form `<output_dir>/<locale>/<domain>.po`, the correct form.
palgarvio
parents: 54
diff changeset
439 self.input_file)
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
440
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
441 infile = open(self.input_file, 'r')
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
442 try:
370
6129d2e770bc We no longer neglect `catalog.plurals`. Added tests for it. Fixes #120.
palgarvio
parents: 338
diff changeset
443 # Although reading from the catalog template, read_po must be fed
6129d2e770bc We no longer neglect `catalog.plurals`. Added tests for it. Fixes #120.
palgarvio
parents: 338
diff changeset
444 # the locale in order to correcly calculate plurals
6129d2e770bc We no longer neglect `catalog.plurals`. Added tests for it. Fixes #120.
palgarvio
parents: 338
diff changeset
445 catalog = read_po(infile, locale=self.locale)
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
446 finally:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
447 infile.close()
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
448
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
449 catalog.locale = self._locale
251
9ff28f838ff7 don't init new catalogs as fuzzy
pjenvey
parents: 250
diff changeset
450 catalog.fuzzy = False
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
451
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
452 outfile = open(self.output_file, 'w')
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
453 try:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
454 write_po(outfile, catalog)
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
455 finally:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
456 outfile.close()
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
457
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
458
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
459 class update_catalog(Command):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
460 """Catalog merging command for use in ``setup.py`` scripts.
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
461
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
462 If correctly installed, this command is available to Setuptools-using
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
463 setup scripts automatically. For projects using plain old ``distutils``,
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
464 the command needs to be registered explicitly in ``setup.py``::
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
465
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
466 from babel.messages.frontend import update_catalog
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
467
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
468 setup(
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
469 ...
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
470 cmdclass = {'update_catalog': update_catalog}
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
471 )
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
472
234
ada322f472ca Add more `since` tags to stuff added in trunk.
cmlenz
parents: 232
diff changeset
473 :since: version 0.9
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
474 :see: `Integrating new distutils commands <http://docs.python.org/dist/node32.html>`_
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
475 :see: `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
476 """
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
477
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
478 description = 'update message catalogs from a POT file'
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
479 user_options = [
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
480 ('domain=', 'D',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
481 "domain of PO file (default 'messages')"),
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
482 ('input-file=', 'i',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
483 'name of the input file'),
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
484 ('output-dir=', 'd',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
485 'path to base directory containing the catalogs'),
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
486 ('output-file=', 'o',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
487 "name of the output file (default "
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
488 "'<output_dir>/<locale>/LC_MESSAGES/<domain>.po')"),
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
489 ('locale=', 'l',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
490 'locale of the catalog to compile'),
191
cf09490f22b3 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 185
diff changeset
491 ('ignore-obsolete=', None,
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
492 'whether to omit obsolete messages from the output'),
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
493 ('no-fuzzy-matching', 'N',
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
494 'do not use fuzzy matching'),
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
495 ('previous', None,
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
496 'keep previous msgids of translated messages')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
497 ]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
498 boolean_options = ['ignore_obsolete', 'no_fuzzy_matching', 'previous']
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
499
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
500 def initialize_options(self):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
501 self.domain = 'messages'
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
502 self.input_file = None
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
503 self.output_dir = None
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
504 self.output_file = None
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
505 self.locale = None
191
cf09490f22b3 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 185
diff changeset
506 self.ignore_obsolete = False
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
507 self.no_fuzzy_matching = False
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
508 self.previous = False
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
509
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
510 def finalize_options(self):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
511 if not self.input_file:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
512 raise DistutilsOptionError('you must specify the input file')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
513 if not self.output_file and not self.output_dir:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
514 raise DistutilsOptionError('you must specify the output file or '
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
515 'directory')
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
516 if self.output_file and not self.locale:
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
517 raise DistutilsOptionError('you must specify the locale')
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
518 if self.no_fuzzy_matching and self.previous:
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
519 self.previous = False
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
520
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
521 def run(self):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
522 po_files = []
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
523 if not self.output_file:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
524 if self.locale:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
525 po_files.append((self.locale,
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
526 os.path.join(self.output_dir, self.locale,
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
527 'LC_MESSAGES',
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
528 self.domain + '.po')))
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
529 else:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
530 for locale in os.listdir(self.output_dir):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
531 po_file = os.path.join(self.output_dir, locale,
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
532 'LC_MESSAGES',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
533 self.domain + '.po')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
534 if os.path.exists(po_file):
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
535 po_files.append((locale, po_file))
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
536 else:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
537 po_files.append((self.locale, self.output_file))
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
538
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
539 domain = self.domain
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
540 if not domain:
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
541 domain = os.path.splitext(os.path.basename(self.input_file))[0]
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
542
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
543 infile = open(self.input_file, 'U')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
544 try:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
545 template = read_po(infile)
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
546 finally:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
547 infile.close()
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
548
208
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
549 if not po_files:
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
550 raise DistutilsOptionError('no message catalogs found')
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
551
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
552 for locale, filename in po_files:
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
553 log.info('updating catalog %r based on %r', filename,
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
554 self.input_file)
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
555 infile = open(filename, 'U')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
556 try:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
557 catalog = read_po(infile, locale=locale, domain=domain)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
558 finally:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
559 infile.close()
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
560
204
5e87b68f1c13 Fix for bug introduced in [208]. Closes #37.
cmlenz
parents: 200
diff changeset
561 catalog.update(template, self.no_fuzzy_matching)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
562
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
563 tmpname = os.path.join(os.path.dirname(filename),
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
564 tempfile.gettempprefix() +
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
565 os.path.basename(filename))
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
566 tmpfile = open(tmpname, 'w')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
567 try:
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
568 try:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
569 write_po(tmpfile, catalog,
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
570 ignore_obsolete=self.ignore_obsolete,
205
0e36a03b4bdf Fix another bug introduced in [208].
cmlenz
parents: 204
diff changeset
571 include_previous=self.previous)
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
572 finally:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
573 tmpfile.close()
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
574 except:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
575 os.remove(tmpname)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
576 raise
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
577
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
578 try:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
579 os.rename(tmpname, filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
580 except OSError:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
581 # We're probably on Windows, which doesn't support atomic
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
582 # renames, at least not through Python
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
583 # If the error is in fact due to a permissions problem, that
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
584 # same error is going to be raised from one of the following
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
585 # operations
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
586 os.remove(filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
587 shutil.copy(tmpname, filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
588 os.remove(tmpname)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
589
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
590
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
591 class CommandLineInterface(object):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
592 """Command-line interface.
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
593
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
594 This class provides a simple command-line interface to the message
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
595 extraction and PO file generation functionality.
51
7f61453c1bea Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 49
diff changeset
596 """
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
597
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
598 usage = '%%prog %s [options] %s'
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
599 version = '%%prog %s' % VERSION
161
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
600 commands = {
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
601 'compile': 'compile message catalogs to MO files',
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
602 'extract': 'extract messages from source files and generate a POT file',
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
603 'init': 'create new message catalogs from a POT file',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
604 'update': 'update existing message catalogs from a POT file'
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
605 }
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
606
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
607 def run(self, argv=sys.argv):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
608 """Main entry point of the command-line interface.
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
609
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
610 :param argv: list of arguments passed on the command-line
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
611 """
127
0f3a08b1c7ae Add a couple of CLI tests.
cmlenz
parents: 123
diff changeset
612 self.parser = OptionParser(usage=self.usage % ('command', '[args]'),
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
613 version=self.version)
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
614 self.parser.disable_interspersed_args()
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
615 self.parser.print_help = self._help
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
616 self.parser.add_option('--list-locales', dest='list_locales',
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
617 action='store_true',
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
618 help="print all known locales and exit")
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
619 self.parser.add_option('-v', '--verbose', action='store_const',
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
620 dest='loglevel', const=logging.DEBUG,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
621 help='print as much as possible')
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
622 self.parser.add_option('-q', '--quiet', action='store_const',
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
623 dest='loglevel', const=logging.ERROR,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
624 help='print as little as possible')
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
625 self.parser.set_defaults(list_locales=False, loglevel=logging.INFO)
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
626
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
627 options, args = self.parser.parse_args(argv[1:])
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
628
523
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
629 self._configure_logging(options.loglevel)
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
630 if options.list_locales:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
631 identifiers = localedata.list()
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
632 longest = max([len(identifier) for identifier in identifiers])
440
b1c8cc751458 remove sorted and don't assume dict ordering (Python 2.3 & Jython compat)
pjenvey
parents: 429
diff changeset
633 identifiers.sort()
210
6c8b69e150a9 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 209
diff changeset
634 format = u'%%-%ds %%s' % (longest + 1)
440
b1c8cc751458 remove sorted and don't assume dict ordering (Python 2.3 & Jython compat)
pjenvey
parents: 429
diff changeset
635 for identifier in identifiers:
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
636 locale = Locale.parse(identifier)
267
044a47d2f020 Default the encoding of output by the `pybabel --list-locales` command to ASCII with errors replaced, if the output stream has no encoding set. For a reason unknown to me I got an encoding error, but only when when running the output through a pipe on the shell.
cmlenz
parents: 251
diff changeset
637 output = format % (identifier, locale.english_name)
298
257534b131bd When using sys.stdout with a pipe or redirection the sys.stdout.encoding value
jruigrok
parents: 290
diff changeset
638 print output.encode(sys.stdout.encoding or
257534b131bd When using sys.stdout with a pipe or redirection the sys.stdout.encoding value
jruigrok
parents: 290
diff changeset
639 getpreferredencoding() or
257534b131bd When using sys.stdout with a pipe or redirection the sys.stdout.encoding value
jruigrok
parents: 290
diff changeset
640 'ascii', 'replace')
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
641 return 0
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
642
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
643 if not args:
424
6f86eb8f54ce Use a more explicit error message if no option or argument(command) is passed to `pybabel`. Fixes #81.
palgarvio
parents: 423
diff changeset
644 self.parser.error('no valid command or option passed. '
6f86eb8f54ce Use a more explicit error message if no option or argument(command) is passed to `pybabel`. Fixes #81.
palgarvio
parents: 423
diff changeset
645 'Try the -h/--help option for more information.')
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
646
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
647 cmdname = args[0]
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
648 if cmdname not in self.commands:
127
0f3a08b1c7ae Add a couple of CLI tests.
cmlenz
parents: 123
diff changeset
649 self.parser.error('unknown command "%s"' % cmdname)
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
650
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
651 return getattr(self, cmdname)(args[1:])
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
652
523
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
653 def _configure_logging(self, loglevel):
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
654 self.log = logging.getLogger('babel')
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
655 self.log.setLevel(loglevel)
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
656 # Don't add a new handler for every instance initialization (#227), this
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
657 # would cause duplicated output when the CommandLineInterface as an
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
658 # normal Python class.
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
659 if self.log.handlers:
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
660 handler = self.log.handlers[0]
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
661 else:
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
662 handler = logging.StreamHandler()
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
663 self.log.addHandler(handler)
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
664 handler.setLevel(loglevel)
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
665 formatter = logging.Formatter('%(message)s')
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
666 handler.setFormatter(formatter)
81e35b223dd6 shorten the __init__() method of !CommandLineInterface by extracting the logging configuration into another method
fschwarz
parents: 521
diff changeset
667
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
668 def _help(self):
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
669 print self.parser.format_help()
127
0f3a08b1c7ae Add a couple of CLI tests.
cmlenz
parents: 123
diff changeset
670 print "commands:"
63
ac684a515b72 Added the available commands list to the `--help` output of Babel's binary.
palgarvio
parents: 62
diff changeset
671 longest = max([len(command) for command in self.commands])
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
672 format = " %%-%ds %%s" % max(8, longest + 1)
161
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
673 commands = self.commands.items()
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
674 commands.sort()
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
675 for name, description in commands:
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
676 print format % (name, description)
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
677
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
678 def compile(self, argv):
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
679 """Subcommand for compiling a message catalog to a MO file.
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
680
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
681 :param argv: the command arguments
234
ada322f472ca Add more `since` tags to stuff added in trunk.
cmlenz
parents: 232
diff changeset
682 :since: version 0.9
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
683 """
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
684 parser = OptionParser(usage=self.usage % ('compile', ''),
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
685 description=self.commands['compile'])
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
686 parser.add_option('--domain', '-D', dest='domain',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
687 help="domain of MO and PO files (default '%default')")
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
688 parser.add_option('--directory', '-d', dest='directory',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
689 metavar='DIR', help='base directory of catalog files')
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
690 parser.add_option('--locale', '-l', dest='locale', metavar='LOCALE',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
691 help='locale of the catalog')
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
692 parser.add_option('--input-file', '-i', dest='input_file',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
693 metavar='FILE', help='name of the input file')
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
694 parser.add_option('--output-file', '-o', dest='output_file',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
695 metavar='FILE',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
696 help="name of the output file (default "
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
697 "'<output_dir>/<locale>/LC_MESSAGES/"
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
698 "<domain>.mo')")
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
699 parser.add_option('--use-fuzzy', '-f', dest='use_fuzzy',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
700 action='store_true',
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
701 help='also include fuzzy translations (default '
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
702 '%default)')
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
703 parser.add_option('--statistics', dest='statistics',
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
704 action='store_true',
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
705 help='print statistics about translations')
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
706
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
707 parser.set_defaults(domain='messages', use_fuzzy=False,
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
708 compile_all=False, statistics=False)
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
709 options, args = parser.parse_args(argv)
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
710
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
711 po_files = []
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
712 mo_files = []
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
713 if not options.input_file:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
714 if not options.directory:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
715 parser.error('you must specify either the input file or the '
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
716 'base directory')
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
717 if options.locale:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
718 po_files.append((options.locale,
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
719 os.path.join(options.directory,
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
720 options.locale, 'LC_MESSAGES',
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
721 options.domain + '.po')))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
722 mo_files.append(os.path.join(options.directory, options.locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
723 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
724 options.domain + '.mo'))
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
725 else:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
726 for locale in os.listdir(options.directory):
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
727 po_file = os.path.join(options.directory, locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
728 'LC_MESSAGES', options.domain + '.po')
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
729 if os.path.exists(po_file):
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
730 po_files.append((locale, po_file))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
731 mo_files.append(os.path.join(options.directory, locale,
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
732 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
733 options.domain + '.mo'))
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
734 else:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
735 po_files.append((options.locale, options.input_file))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
736 if options.output_file:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
737 mo_files.append(options.output_file)
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
738 else:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
739 if not options.directory:
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
740 parser.error('you must specify either the input file or '
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
741 'the base directory')
290
d0c6014c46a1 we must mean options.locale here
pjenvey
parents: 288
diff changeset
742 mo_files.append(os.path.join(options.directory, options.locale,
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
743 'LC_MESSAGES',
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
744 options.domain + '.mo'))
208
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
745 if not po_files:
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
746 parser.error('no message catalogs found')
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
747
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
748 for idx, (locale, po_file) in enumerate(po_files):
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
749 mo_file = mo_files[idx]
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
750 infile = open(po_file, 'r')
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
751 try:
331
aa3a4c57511e Fix message catalog compilation for locales with more than two plural forms. Closes #95. Many thanks to Victor Safronovich for the patch.
cmlenz
parents: 317
diff changeset
752 catalog = read_po(infile, locale)
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
753 finally:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
754 infile.close()
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
755
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
756 if options.statistics:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
757 translated = 0
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
758 for message in list(catalog)[1:]:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
759 if message.string:
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
760 translated +=1
317
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
761 percentage = 0
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
762 if len(catalog):
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
763 percentage = translated * 100 // len(catalog)
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
764 self.log.info("%d of %d messages (%d%%) translated in %r",
317
1837758b02be Fix for #60.
cmlenz
parents: 315
diff changeset
765 translated, len(catalog), percentage, po_file)
207
c0b9679daf88 Implement translations statistics, closes #18.
palgarvio
parents: 205
diff changeset
766
175
3c4718fb7435 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 170
diff changeset
767 if catalog.fuzzy and not options.use_fuzzy:
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
768 self.log.warn('catalog %r is marked as fuzzy, skipping',
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
769 po_file)
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
770 continue
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
771
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
772 for message, errors in catalog.check():
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
773 for error in errors:
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
774 self.log.error('error: %s:%d: %s', po_file, message.lineno,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
775 error)
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
776
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
777 self.log.info('compiling catalog %r to %r', po_file, mo_file)
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
778
279
7730086e47d9 Write PO files in binary mode. Closes #61.
cmlenz
parents: 267
diff changeset
779 outfile = open(mo_file, 'wb')
170
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
780 try:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
781 write_mo(outfile, catalog, use_fuzzy=options.use_fuzzy)
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
782 finally:
804af3799b18 Allow the compile catalog frontends to compile all available locales.
palgarvio
parents: 169
diff changeset
783 outfile.close()
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
784
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
785 def extract(self, argv):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
786 """Subcommand for extracting messages from source files and generating
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
787 a POT file.
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
788
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
789 :param argv: the command arguments
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
790 """
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
791 parser = OptionParser(usage=self.usage % ('extract', 'dir1 <dir2> ...'),
161
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
792 description=self.commands['extract'])
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
793 parser.add_option('--charset', dest='charset',
160
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
794 help='charset to use in the output (default '
80e51aabc440 Add MO file generation. Closes #21.
cmlenz
parents: 144
diff changeset
795 '"%default")')
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
796 parser.add_option('-k', '--keyword', dest='keywords', action='append',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
797 help='keywords to look for in addition to the '
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
798 'defaults. You can specify multiple -k flags on '
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
799 'the command line.')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
800 parser.add_option('--no-default-keywords', dest='no_default_keywords',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
801 action='store_true',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
802 help="do not include the default keywords")
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
803 parser.add_option('--mapping', '-F', dest='mapping_file',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
804 help='path to the extraction mapping file')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
805 parser.add_option('--no-location', dest='no_location',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
806 action='store_true',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
807 help='do not include location comments with filename '
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
808 'and line number')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
809 parser.add_option('--omit-header', dest='omit_header',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
810 action='store_true',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
811 help='do not include msgid "" entry in header')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
812 parser.add_option('-o', '--output', dest='output',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
813 help='path to the output POT file')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
814 parser.add_option('-w', '--width', dest='width', type='int',
423
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
815 help="set output line width (default 76)")
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
816 parser.add_option('--no-wrap', dest='no_wrap', action = 'store_true',
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
817 help='do not break long message lines, longer than '
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
818 'the output line width, into several lines')
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
819 parser.add_option('--sort-output', dest='sort_output',
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
820 action='store_true',
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
821 help='generate sorted output (default False)')
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
822 parser.add_option('--sort-by-file', dest='sort_by_file',
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
823 action='store_true',
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
824 help='sort output by file location (default False)')
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
825 parser.add_option('--msgid-bugs-address', dest='msgid_bugs_address',
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
826 metavar='EMAIL@ADDRESS',
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 71
diff changeset
827 help='set report address for msgid')
79
9a05230571f8 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
828 parser.add_option('--copyright-holder', dest='copyright_holder',
9a05230571f8 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
829 help='set copyright holder in output')
429
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
830 parser.add_option('--project', dest='project',
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
831 help='set project name in output')
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
832 parser.add_option('--version', dest='version',
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
833 help='set project version in output')
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 90
diff changeset
834 parser.add_option('--add-comments', '-c', dest='comment_tags',
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
835 metavar='TAG', action='append',
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
836 help='place comment block with TAG (or those '
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
837 'preceding keyword lines) in output file. One '
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
838 'TAG per argument call')
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
839 parser.add_option('--strip-comment-tags', '-s',
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
840 dest='strip_comment_tags', action='store_true',
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
841 help='Strip the comment tags from the comments.')
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
842
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
843 parser.set_defaults(charset='utf-8', keywords=[],
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
844 no_default_keywords=False, no_location=False,
423
8f91314df0b9 Now, the `--width` option, although with a default value of 76, it's not set to any value initially so that the `--no-wrap` option can be passed without throwing an error. Fixes #145.
palgarvio
parents: 417
diff changeset
845 omit_header = False, width=None, no_wrap=False,
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
846 sort_output=False, sort_by_file=False,
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
847 comment_tags=[], strip_comment_tags=False)
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
848 options, args = parser.parse_args(argv)
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
849 if not args:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
850 parser.error('incorrect number of arguments')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
851
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
852 if options.output not in (None, '-'):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
853 outfile = open(options.output, 'w')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
854 else:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
855 outfile = sys.stdout
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
856
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
857 keywords = DEFAULT_KEYWORDS.copy()
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
858 if options.no_default_keywords:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
859 if not options.keywords:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
860 parser.error('you must specify new keywords if you disable the '
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
861 'default ones')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
862 keywords = {}
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
863 if options.keywords:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
864 keywords.update(parse_keywords(options.keywords))
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
865
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
866 if options.mapping_file:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
867 fileobj = open(options.mapping_file, 'U')
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
868 try:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
869 method_map, options_map = parse_mapping(fileobj)
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
870 finally:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
871 fileobj.close()
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
872 else:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
873 method_map = DEFAULT_MAPPING
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
874 options_map = {}
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
875
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
876 if options.width and options.no_wrap:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
877 parser.error("'--no-wrap' and '--width' are mutually exclusive.")
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
878 elif not options.width and not options.no_wrap:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
879 options.width = 76
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
880
71
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
881 if options.sort_output and options.sort_by_file:
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
882 parser.error("'--sort-output' and '--sort-by-file' are mutually "
ea4cb904df8f Implemented message sorting, see #7.
palgarvio
parents: 66
diff changeset
883 "exclusive")
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
884
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
885 try:
429
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
886 catalog = Catalog(project=options.project,
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
887 version=options.version,
622c4ecce7f7 add `--project` and `--version` options for commandline (fixes #173)
dfraser
parents: 424
diff changeset
888 msgid_bugs_address=options.msgid_bugs_address,
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
889 copyright_holder=options.copyright_holder,
102
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
890 charset=options.charset)
eb0d9591d555 Project name and version, and the charset are available via the `Catalog` object, and do not need to be passed to `write_pot()`.
cmlenz
parents: 95
diff changeset
891
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
892 for dirname in args:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
893 if not os.path.isdir(dirname):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
894 parser.error('%r is not a directory' % dirname)
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
895
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
896 def callback(filename, method, options):
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
897 if method == 'ignore':
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
898 return
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
899 filepath = os.path.normpath(os.path.join(dirname, filename))
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
900 optstr = ''
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
901 if options:
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
902 optstr = ' (%s)' % ', '.join(['%s="%s"' % (k, v) for
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
903 k, v in options.items()])
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
904 self.log.info('extracting messages from %s%s', filepath,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
905 optstr)
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
906
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 90
diff changeset
907 extracted = extract_from_dir(dirname, method_map, options_map,
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
908 keywords, options.comment_tags,
338
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
909 callback=callback,
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
910 strip_comment_tags=
6fe060286ff0 Stripping of comment tags is optional now. If enabled it will strip the tags from all lines of a comment now.
aronacher
parents: 335
diff changeset
911 options.strip_comment_tags)
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
912 for filename, lineno, message, comments in extracted:
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
913 filepath = os.path.normpath(os.path.join(dirname, filename))
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
914 catalog.add(message, None, [(filepath, lineno)],
110
d4bb649b3849 fixed old comments kwarg to auto_comments
pjenvey
parents: 105
diff changeset
915 auto_comments=comments)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents: 55
diff changeset
916
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
917 if options.output not in (None, '-'):
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
918 self.log.info('writing PO template file to %s' % options.output)
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
919 write_po(outfile, catalog, width=options.width,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
920 no_location=options.no_location,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
921 omit_header=options.omit_header,
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
922 sort_output=options.sort_output,
112
f01ae81a7919 copyright_holder arg is no longer needed for write_po
pjenvey
parents: 110
diff changeset
923 sort_by_file=options.sort_by_file)
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
924 finally:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
925 if options.output:
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
926 outfile.close()
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
927
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
928 def init(self, argv):
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
929 """Subcommand for creating new message catalogs from a template.
177
a7766f92f944 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 176
diff changeset
930
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
931 :param argv: the command arguments
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
932 """
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 161
diff changeset
933 parser = OptionParser(usage=self.usage % ('init', ''),
161
04c56e82c98b Slightly simplified CLI-frontend class.
cmlenz
parents: 160
diff changeset
934 description=self.commands['init'])
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
935 parser.add_option('--domain', '-D', dest='domain',
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
936 help="domain of PO file (default '%default')")
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
937 parser.add_option('--input-file', '-i', dest='input_file',
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
938 metavar='FILE', help='name of the input file')
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
939 parser.add_option('--output-dir', '-d', dest='output_dir',
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
940 metavar='DIR', help='path to output directory')
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
941 parser.add_option('--output-file', '-o', dest='output_file',
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
942 metavar='FILE',
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
943 help="name of the output file (default "
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
944 "'<output_dir>/<locale>/LC_MESSAGES/"
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
945 "<domain>.po')")
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
946 parser.add_option('--locale', '-l', dest='locale', metavar='LOCALE',
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
947 help='locale for the new localized catalog')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
948
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
949 parser.set_defaults(domain='messages')
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
950 options, args = parser.parse_args(argv)
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
951
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
952 if not options.locale:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
953 parser.error('you must provide a locale for the new catalog')
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
954 try:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
955 locale = Locale.parse(options.locale)
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
956 except UnknownLocaleError, e:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
957 parser.error(e)
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
958
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
959 if not options.input_file:
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
960 parser.error('you must specify the input file')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
961
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
962 if not options.output_file and not options.output_dir:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
963 parser.error('you must specify the output file or directory')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
964
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
965 if not options.output_file:
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
966 options.output_file = os.path.join(options.output_dir,
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
967 options.locale, 'LC_MESSAGES',
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
968 options.domain + '.po')
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
969 if not os.path.exists(os.path.dirname(options.output_file)):
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
970 os.makedirs(os.path.dirname(options.output_file))
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
971
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
972 infile = open(options.input_file, 'r')
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
973 try:
371
ffde26d66af1 Include fix of [407] in `pybabel`.
palgarvio
parents: 370
diff changeset
974 # Although reading from the catalog template, read_po must be fed
ffde26d66af1 Include fix of [407] in `pybabel`.
palgarvio
parents: 370
diff changeset
975 # the locale in order to correcly calculate plurals
ffde26d66af1 Include fix of [407] in `pybabel`.
palgarvio
parents: 370
diff changeset
976 catalog = read_po(infile, locale=options.locale)
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
977 finally:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
978 infile.close()
87
f259182f9baf Fixed a bug on Catalog. `__setitem__` was not updating the translator comments. Thanks pjenvey!
palgarvio
parents: 86
diff changeset
979
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
980 catalog.locale = locale
132
59ccb974a4ef Set explicit local timezone for CLI `init` command.
cmlenz
parents: 127
diff changeset
981 catalog.revision_date = datetime.now(LOCALTZ)
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
982
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
983 self.log.info('creating catalog %r based on %r', options.output_file,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
984 options.input_file)
66
72e43f6881a9 Implemented the `init` subcommand, aka, `new_catalog` for the distutils/setuptools implmentation.
palgarvio
parents: 63
diff changeset
985
104
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
986 outfile = open(options.output_file, 'w')
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
987 try:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
988 write_po(outfile, catalog)
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
989 finally:
22f222e23b86 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 103
diff changeset
990 outfile.close()
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
991
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
992 def update(self, argv):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
993 """Subcommand for updating existing message catalogs from a template.
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
994
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
995 :param argv: the command arguments
234
ada322f472ca Add more `since` tags to stuff added in trunk.
cmlenz
parents: 232
diff changeset
996 :since: version 0.9
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
997 """
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
998 parser = OptionParser(usage=self.usage % ('update', ''),
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
999 description=self.commands['update'])
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1000 parser.add_option('--domain', '-D', dest='domain',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1001 help="domain of PO file (default '%default')")
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1002 parser.add_option('--input-file', '-i', dest='input_file',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1003 metavar='FILE', help='name of the input file')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1004 parser.add_option('--output-dir', '-d', dest='output_dir',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1005 metavar='DIR', help='path to output directory')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1006 parser.add_option('--output-file', '-o', dest='output_file',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1007 metavar='FILE',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1008 help="name of the output file (default "
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1009 "'<output_dir>/<locale>/LC_MESSAGES/"
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1010 "<domain>.po')")
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1011 parser.add_option('--locale', '-l', dest='locale', metavar='LOCALE',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1012 help='locale of the translations catalog')
191
cf09490f22b3 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 185
diff changeset
1013 parser.add_option('--ignore-obsolete', dest='ignore_obsolete',
cf09490f22b3 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 185
diff changeset
1014 action='store_true',
cf09490f22b3 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 185
diff changeset
1015 help='do not include obsolete messages in the output '
417
1352648e2dac Typo's and sorted output of `list-locales`.
palgarvio
parents: 414
diff changeset
1016 '(default %default)')
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1017 parser.add_option('--no-fuzzy-matching', '-N', dest='no_fuzzy_matching',
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1018 action='store_true',
417
1352648e2dac Typo's and sorted output of `list-locales`.
palgarvio
parents: 414
diff changeset
1019 help='do not use fuzzy matching (default %default)')
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1020 parser.add_option('--previous', dest='previous', action='store_true',
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1021 help='keep previous msgids of translated messages '
417
1352648e2dac Typo's and sorted output of `list-locales`.
palgarvio
parents: 414
diff changeset
1022 '(default %default)')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1023
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1024 parser.set_defaults(domain='messages', ignore_obsolete=False,
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1025 no_fuzzy_matching=False, previous=False)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1026 options, args = parser.parse_args(argv)
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1027
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1028 if not options.input_file:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1029 parser.error('you must specify the input file')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1030 if not options.output_file and not options.output_dir:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1031 parser.error('you must specify the output file or directory')
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1032 if options.output_file and not options.locale:
417
1352648e2dac Typo's and sorted output of `list-locales`.
palgarvio
parents: 414
diff changeset
1033 parser.error('you must specify the locale')
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1034 if options.no_fuzzy_matching and options.previous:
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1035 options.previous = False
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1036
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1037 po_files = []
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1038 if not options.output_file:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1039 if options.locale:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1040 po_files.append((options.locale,
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1041 os.path.join(options.output_dir,
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1042 options.locale, 'LC_MESSAGES',
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1043 options.domain + '.po')))
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1044 else:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1045 for locale in os.listdir(options.output_dir):
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1046 po_file = os.path.join(options.output_dir, locale,
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1047 'LC_MESSAGES',
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1048 options.domain + '.po')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1049 if os.path.exists(po_file):
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1050 po_files.append((locale, po_file))
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1051 else:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1052 po_files.append((options.locale, options.output_file))
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1053
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1054 domain = options.domain
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1055 if not domain:
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1056 domain = os.path.splitext(os.path.basename(options.input_file))[0]
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1057
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1058 infile = open(options.input_file, 'U')
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1059 try:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1060 template = read_po(infile)
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1061 finally:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1062 infile.close()
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1063
208
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
1064 if not po_files:
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
1065 parser.error('no message catalogs found')
3119bf035694 Make frontends that make use of a ''loop all'' fail if no message catalogs are found.
palgarvio
parents: 207
diff changeset
1066
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1067 for locale, filename in po_files:
232
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
1068 self.log.info('updating catalog %r based on %r', filename,
0e5c33776833 Use logging module for output from CLI frontend.
cmlenz
parents: 231
diff changeset
1069 options.input_file)
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1070 infile = open(filename, 'U')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1071 try:
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 191
diff changeset
1072 catalog = read_po(infile, locale=locale, domain=domain)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1073 finally:
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1074 infile.close()
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1075
204
5e87b68f1c13 Fix for bug introduced in [208]. Closes #37.
cmlenz
parents: 200
diff changeset
1076 catalog.update(template, options.no_fuzzy_matching)
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1077
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1078 tmpname = os.path.join(os.path.dirname(filename),
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1079 tempfile.gettempprefix() +
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1080 os.path.basename(filename))
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1081 tmpfile = open(tmpname, 'w')
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1082 try:
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1083 try:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1084 write_po(tmpfile, catalog,
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 197
diff changeset
1085 ignore_obsolete=options.ignore_obsolete,
205
0e36a03b4bdf Fix another bug introduced in [208].
cmlenz
parents: 204
diff changeset
1086 include_previous=options.previous)
197
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1087 finally:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1088 tmpfile.close()
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1089 except:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1090 os.remove(tmpname)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1091 raise
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1092
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1093 try:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1094 os.rename(tmpname, filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1095 except OSError:
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1096 # We're probably on Windows, which doesn't support atomic
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1097 # renames, at least not through Python
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1098 # If the error is in fact due to a permissions problem, that
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1099 # same error is going to be raised from one of the following
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1100 # operations
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1101 os.remove(filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1102 shutil.copy(tmpname, filename)
52746440c300 Fix for #36: avoid corrupting the catalog on update when there's an error in the writing process.
cmlenz
parents: 196
diff changeset
1103 os.remove(tmpname)
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 178
diff changeset
1104
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 161
diff changeset
1105
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1106 def main():
185
170cffc66554 Add a command-line option that prints out all available locales. Closes #24.
cmlenz
parents: 181
diff changeset
1107 return CommandLineInterface().run(sys.argv)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
1108
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1109 def parse_mapping(fileobj, filename=None):
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1110 """Parse an extraction method mapping from a file-like object.
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1111
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1112 >>> buf = StringIO('''
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1113 ... [extractors]
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1114 ... custom = mypackage.module:myfunc
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1115 ...
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1116 ... # Python source files
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1117 ... [python: **.py]
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1118 ...
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1119 ... # Genshi templates
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1120 ... [genshi: **/templates/**.html]
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1121 ... include_attrs =
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1122 ... [genshi: **/templates/**.txt]
144
a5914ba672d1 Some doc fixes.
cmlenz
parents: 132
diff changeset
1123 ... template_class = genshi.template:TextTemplate
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1124 ... encoding = latin-1
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1125 ...
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1126 ... # Some custom extractor
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1127 ... [custom: **/custom/*.*]
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1128 ... ''')
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1129
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1130 >>> method_map, options_map = parse_mapping(buf)
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1131 >>> len(method_map)
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1132 4
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1133
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1134 >>> method_map[0]
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1135 ('**.py', 'python')
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1136 >>> options_map['**.py']
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1137 {}
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1138 >>> method_map[1]
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1139 ('**/templates/**.html', 'genshi')
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1140 >>> options_map['**/templates/**.html']['include_attrs']
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1141 ''
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1142 >>> method_map[2]
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1143 ('**/templates/**.txt', 'genshi')
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1144 >>> options_map['**/templates/**.txt']['template_class']
144
a5914ba672d1 Some doc fixes.
cmlenz
parents: 132
diff changeset
1145 'genshi.template:TextTemplate'
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1146 >>> options_map['**/templates/**.txt']['encoding']
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1147 'latin-1'
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1148
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1149 >>> method_map[3]
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1150 ('**/custom/*.*', 'mypackage.module:myfunc')
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1151 >>> options_map['**/custom/*.*']
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1152 {}
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1153
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1154 :param fileobj: a readable file-like object containing the configuration
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1155 text to parse
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1156 :return: a `(method_map, options_map)` tuple
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1157 :rtype: `tuple`
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1158 :see: `extract_from_directory`
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1159 """
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1160 extractors = {}
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1161 method_map = []
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1162 options_map = {}
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1163
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1164 parser = RawConfigParser()
62
84d400066b71 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 59
diff changeset
1165 parser._sections = odict(parser._sections) # We need ordered sections
48
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1166 parser.readfp(fileobj, filename)
bd647e3760e0 Move the mapping configuration file format to `ConfigParser`, and add some more documentation about it.
cmlenz
parents: 47
diff changeset
1167 for section in parser.sections():
250
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1168 if section == 'extractors':
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1169 extractors = dict(parser.items(section))
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1170 else:
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1171 method, pattern = [part.strip() for part in section.split(':', 1)]
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1172 method_map.append((pattern, method))
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1173 options_map[pattern] = dict(parser.items(section))
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1174
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1175 if extractors:
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1176 for idx, (pattern, method) in enumerate(method_map):
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1177 if method in extractors:
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1178 method = extractors[method]
cd7e378b8190 Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 234
diff changeset
1179 method_map[idx] = (pattern, method)
47
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1180
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1181 return (method_map, options_map)
76381d4b3635 Support passing extraction method mapping and options from the frontends (see #4). No distutils/setuptools keyword supported yet, but the rest seems to be working okay.
cmlenz
parents: 24
diff changeset
1182
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1183 def parse_keywords(strings=[]):
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1184 """Parse keywords specifications from the given list of strings.
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1185
414
ea0da9db79ef fix Python 2.3 compat: rearrange set/itemgetter/rsplit/sorted/unicode.decode
pjenvey
parents: 371
diff changeset
1186 >>> kw = parse_keywords(['_', 'dgettext:2', 'dngettext:2,3']).items()
ea0da9db79ef fix Python 2.3 compat: rearrange set/itemgetter/rsplit/sorted/unicode.decode
pjenvey
parents: 371
diff changeset
1187 >>> kw.sort()
ea0da9db79ef fix Python 2.3 compat: rearrange set/itemgetter/rsplit/sorted/unicode.decode
pjenvey
parents: 371
diff changeset
1188 >>> for keyword, indices in kw:
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1189 ... print (keyword, indices)
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1190 ('_', None)
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1191 ('dgettext', (2,))
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1192 ('dngettext', (2, 3))
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1193 """
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1194 keywords = {}
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1195 for string in strings:
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1196 if ':' in string:
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1197 funcname, indices = string.split(':')
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1198 else:
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1199 funcname, indices = string, None
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1200 if funcname not in keywords:
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1201 if indices:
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1202 indices = tuple([(int(x)) for x in indices.split(',')])
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1203 keywords[funcname] = indices
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1204 return keywords
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 10
diff changeset
1205
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 51
diff changeset
1206
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
1207 if __name__ == '__main__':
55
c3291ad6b010 `new_catalog` now accepts another argument, `--domain`, which is used to build the output file path, which now is of the form `<output_dir>/<locale>/<domain>.po`, the correct form.
palgarvio
parents: 54
diff changeset
1208 main()
Copyright (C) 2012-2017 Edgewall Software