Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 1.2
2 Name: polib
3 Version: 1.2.0
4 Summary: A library to manipulate gettext files (po and mo files).
5 Home-page: https://github.com/izimobil/polib/
6 Author: David Jean Louis
7 Author-email: [email protected]
8 Maintainer: David Jean Louis
9 Maintainer-email: [email protected]
10 License: MIT
11 Download-URL: https://pypi.python.org/packages/source/p/polib/polib-1.2.0.tar.gz
12 Description:
13 =====
14 polib
15 =====
16
17 |pypi-version| |pypi-stats| |build-status-image| |codecov-image| |documentation-status-image| |py-versions|
18
19 Overview
20 --------
21
22 polib is a library to manipulate, create, modify gettext files (pot, po and mo
23 files). You can load existing files, iterate through it's entries, add, modify
24 entries, comments or metadata, etc... or create new po files from scratch.
25
26 polib supports out of the box any version of python ranging from 2.7 to latest
27 3.X version.
28
29 polib is pretty stable now and is used by many
30 `opensource projects <http://polib.readthedocs.org/en/latest/projects.html>`_.
31
32 The project code and bugtracker is hosted on
33 `Github <https://github.com/izimobil/polib/>`_.
34
35 polib is generously documented, you can `browse the documentation online
36 <http://polib.readthedocs.org/>`_, a good start is to read
37 `the quickstart guide <http://polib.readthedocs.org/en/latest/quickstart.html>`_.
38
39
40 Installation
41 ~~~~~~~~~~~~
42
43 Just use ``pip``:
44
45 .. code:: bash
46
47 $ pip install polib
48
49
50 Basic example
51 ~~~~~~~~~~~~~
52
53 .. code:: python
54
55 import polib
56
57 pofile = polib.pofile('/path/to/pofile.po')
58
59 for entry in pofile:
60 print(entry.msgid, entry.msgstr)
61
62
63 .. |build-status-image| image:: https://api.travis-ci.com/izimobil/polib.svg?branch=master
64 :target: https://app.travis-ci.com/github/izimobil/polib
65 :alt: Travis build
66
67 .. |codecov-image| image:: https://codecov.io/gh/izimobil/polib/branch/master/graph/badge.svg
68 :target: https://codecov.io/gh/izimobil/polib
69
70 .. |pypi-version| image:: https://img.shields.io/pypi/v/polib.svg
71 :target: https://pypi.python.org/pypi/polib
72 :alt: Pypi version
73
74 .. |pypi-stats| image:: https://img.shields.io/pypi/dm/polib.svg
75 :target: https://pypistats.org/packages/polib
76 :alt: Pypi downloads
77
78 .. |documentation-status-image| image:: https://readthedocs.org/projects/polib/badge/?version=latest
79 :target: http://polib.readthedocs.io/en/latest/?badge=latest
80 :alt: Documentation Status
81
82 .. |py-versions| image:: https://img.shields.io/pypi/pyversions/polib.svg
83 :target: https://img.shields.io/pypi/pyversions/polib.svg
84 :alt: Python versions
85
86
87 =========
88 Changelog
89 =========
90
91 Version 1.2.0 (2023/02/23)
92 --------------------------
93 - Added setter for the fuzzy property
94 - Escape/unescape \v, \b and \f
95 - Added path to error message processing parser symbols
96 - Ensure empty previous values for msgid and msgstr are properly saved
97 - Fixed relative ordering of comments and translator comments
98 - Do not count obsolete entries in fuzzy() method
99 - Close files properly
100 - Fixed support for loading mo files from bytes object
101 - Fixed msgstr_plural comparison
102 - Simplified python version check
103 - Updated docs
104
105 Version 1.1.1 (2021/03/26)
106 --------------------------
107 - Strip UTF-16 BOM (U+FEFF) from start of file
108 - Message context (msgctxt) support for MO files
109 - Dropped Python < 2.7 support
110 - Updated docs and README after switch from Bitbucket to Github
111
112 Version 1.1.0 (2017/11/27)
113 --------------------------
114 - Fixed entries sorting when generating mo file (Fixes #78)
115 - Fixed find method (Fixes #84)
116 - Refactored POEntry.__cmp__ method (this should fix issues #60, #65 and #79)
117 - Fixed duplicated entries when merging po file with pot file (fixes #68)
118 - Fixed "None" string being outputted when polib deals with syntax error in string (Fixes issue #66)
119 - Added a fuzzy property to entries (Fixes #76)
120 - Take into account the message context when comparing entries
121 - Leave occurence untouched if line number is not a number (fixes #80 and #90)
122 - Fixed test for mo files that was failing because since gettext version 0.19.8.1, msgfmt skips the "POT-Creation-Date" metadata entry (Fixes #86)
123 - Fixed major revision number comparison
124 - Dropped python 2.4 support
125
126 Version 1.0.8 (2016/11/21)
127 --------------------------
128 - Fixed issue #70 (occurrences parsing for windows pathes)
129 - Fixed issue #71 (tcomment and flags not saved for obsolete entries)
130 - Fixed issue #72 (wrong metadata ordering)
131 - Fixed issue #73 (can't always unpickle POFile)
132 - Use natural sorting for additional headers (metadata)
133 - Fixed typos in various documents
134
135 Version 1.0.7 (2015/07/08)
136 --------------------------
137 - Fixed bad parsing of indented msgstr_plural
138 - Fixed ordering of "Language" metadata entry
139 - Removed space after "#" in header if comment line is empty (like gettext tools)
140 - Fixed typos / grammar errors (thanks Jakub Wilk)
141 - Take into account msgid_plural if needed when comparing entries (thanks Leonardo Constantino Oliveira)
142 - Fixed issue #63 (str() on a bytes instance when using python3) (thanks Jakub Wilk)
143
144 Version 1.0.6 (2015/01/04)
145 --------------------------
146 - Wheel support
147 - Add missing 'Language' and 'Plural-Forms' to metadata ordering
148 - More accurate float operation for POFile.percent_translated()
149
150 Version 1.0.5 (2014/08/22)
151 --------------------------
152 - Fixed issue #59: tokens variable referenced before assignment
153 - Implemented feature request #56: line number information in PO entries
154 - Fixed issue #61: polib does not handle previous msgid on multilines properly
155
156 Version 1.0.4 (2014/02/19)
157 --------------------------
158 - Fixed issue #43: improved check that determine if polib is dealing with a filepath or unicode content
159 - Fixed issue #44: polib now checks MO files revision number and throws an error if the number is unexpected
160 - Fixed issue #45: parse properly mo files with no header entry
161 - Fixed issue #47: added flags attribute for MOEntry to be consistent with POEntry
162 - Fixed issue #49: use integers rather than strings for msgstr_plural keys
163 - Fixed issue #51: if a PO file ends with a comment, polib adds a spurious empty entry at the end
164 - Fixed issue #52: bad magic number written on big endian platforms
165 - Fixed issue #53: added a __hash__() method to POEntry and MOEntry classes
166 - Fixed issue #54: use lowercase for state identifiers. This fixes issues with certain locales and string.lower()
167 - Fixed issue #58: use io.open() instead of codecs.open() because the latter doesn't handle very well universal line endings
168 - Make sure the mo file is closed at garbage collection, this prevents warnings on unclosed file when running tests with python >= 3.2
169 - Better way to test endianness
170 - polib download URL is now on Pypi
171
172 Version 1.0.3 (2013/02/09)
173 --------------------------
174 - Fixed issue #38: POFile.append() raised a duplicate exception when you tried to add a new entry with the same msgid and a different msgctxt (only when check_for_duplicates option is set to True)
175 - Fixed issue #39: Added __init__.py file for convenience
176 - Fixed issue #41: UnicodeDecodeError when running setup.py build on python3 with C locale
177 - polib is now fully PEP8 compliant
178 - Small improvements: remove unused "typ" var (thanks Rodrigo Silva), improved Makefile, Make sure _BaseFile.__contains__ returns a boolean value
179
180 Version 1.0.2 (2012/10/23)
181 --------------------------
182 - allow empty comments, flags or occurrences lines
183
184 Version 1.0.1 (2012/09/11)
185 --------------------------
186 - speed up POFile.merge method (thanks @encukou)
187 - allow comments starting with two '#' characters (thanks @goibhniu)
188
189 Version 1.0.0 (2012/06/08)
190 --------------------------
191 Yeah... after nearly 6 years, polib reaches the stable state :)
192 Changes and fixes in this release :
193
194 - polib.pofile and polib.mofile functions can now return a custom class (thanks Craig Blaszczyk)
195 - polib now can find the metadata entry no matter where it is located (thanks François Poirotte)
196 - fixed issue #28 (IOError on reading obsolete "previous msgid" entries) (thanks James Ni)
197
198 Version 0.7.0 (2011/07/14)
199 --------------------------
200 This version adds support for python 3 (thanks to Vinay Sajip).
201 polib now supports out-of-the-box any version of python ranging from 2.4 to latest 3.X version.
202 polib is now 5 years old ;) so the 0.7.X branch will be the last before the 1.X stable branch.
203
204 Version 0.6.4 (2011/07/13)
205 --------------------------
206 - Better api, autodetected_encoding is no longer required to explicitly set the encoding (fixes issue #23),
207 - Fixed issue #24 Support indented PO files (thanks to François Poirotte).
208
209 Version 0.6.3 (2011/02/19)
210 --------------------------
211 - Fixed issue #19 (Disappearing newline characters due to textwrap module),
212 - ensure wrapping works as expected.
213
214 Version 0.6.2 (2011/02/09)
215 --------------------------
216 - Backported textwrap.TextWrapper._wrap_chunks that has support for the drop_whitespace parameter added in Python 2.6 (Fixes #18: broken compatibility with python 2.5, thanks @jezdez).
217
218 Version 0.6.1 (2011/02/09)
219 --------------------------
220 - fixed regression that prevented POFile initialization from data to work (issue #17).
221
222 Version 0.6.0 (2011/02/07)
223 --------------------------
224 - polib is now `fully documented <http://polib.readthedocs.org>`_,
225 - switched from doctests to unit tests to keep the polib.py file clean,
226 - fixed issue #7 (wrapping issues, thanks @jezdez),
227 - added a __eq__ method to _BaseFile (thanks @kost BebiX),
228 - handle msgctxt correctly when compiling mo files,
229 - compiled mo files are now exactly the same as those compiled by msgfmt without using hash tables.
230
231 Version 0.5.5 (2010/10/30)
232 --------------------------
233 - Removed multiline handling code, it was a mess and was the source of potential bugs like issue #11,
234 - Fixed typo in README and CHANGELOG, fixes issue #13.
235
236 Version 0.5.4 (2010/10/02)
237 --------------------------
238 - fixed an issue with detect_encoding(), in some cases it could return an invalid charset.
239
240 Version 0.5.3 (2010/08/29)
241 --------------------------
242 - correctly unescape lines containing both \\\\n and \\n (thanks to Martin Geisler),
243 - fixed issue #6: __str__() methods are returning unicode instead of str,
244 - fixed issue #8: POFile.merge error when an entry is obsolete in a .po, that this entry reappears in the .pot and that we merge the two,
245 - added support to instantiate POFile objects using data instead of file path (thanks to Diego Búrigo Zacarão),
246 - fixed issue #9: POFile.merge drop fuzzy attributes from translations (thanks to Tim Gerundt),
247 - fixed issue #10: Finding entries with the same msgid and different context (msgctxt).
248
249 Version 0.5.2 (2010/06/09)
250 --------------------------
251 - fixed issue #1: untranslated_entries() also show fuzzy message,
252 - write back the fuzzy header if present in the pofile,
253 - added support for previous msgctxt, previous msgid and previous msgid_plural comments (fixes issue #5),
254 - better handling of lines wrapping.
255
256 Version 0.5.1 (2009/12/14)
257 --------------------------
258 - fixed issue #0025: setup.py requires CHANGELOG but it's not present in polib-0.5.0-tar.gz
259
260 Version 0.5.0 (2009/12/13)
261 --------------------------
262 - fixed issue #0017: UnicodeDecodeError while writing a mo-file,
263 - fixed issue #0018: implemented support for msgctxt,
264 - fixed bug when compiling plural msgids/strs,
265 - API docs are no longer included, hopefully next release will ship with sphinx documentation,
266 - parse msg plural entries correctly when reading mo files,
267 - fixed issue #0020 and #0021: added ability to check for duplicate when adding entries to po/mo files, this is optional and not enabled by default because it slows down considerably the library,
268 - fixed issue #0022: unescaping code is insufficient,
269 - fixed issue #0023: encoding error when saving mo file as po file (thanks to sebastien.sable for the patch !).
270
271 Version 0.4.2 (2009/06/05)
272 --------------------------
273 - fixed issue #0007: use the codecs module to open files,
274 - fixed issue #0014: plural forms are not saved correctly in the mo file (thanks lorenzo.gil.sanchez for the patch),
275 - fixed issue #0015: no LICENSE file included in tarball,
276 - removed Version/Date from README,
277 - added test pot files to MANIFEST.in,
278 - performance improvement in find() method (thanks Thomas !).
279
280 Version 0.4.1 (2009/03/04)
281 --------------------------
282 - fixed issue #0006: plural msgstrs were saved unsorted,
283 - fixed issue #0008: long comment lines broke 'save()' method,
284 - removed performance shortcuts: they were in fact inefficient, I was mislead by the python profile module, kudos to Thomas for making me realise that,
285 - fixed issue #0010: wrong polib version number,
286 - fixed issue #0011: occurrences parsing is now more robust and can handle weird references formats (like in eToys OLPC po files),
287 - fixed issue #0012: improved merge() method.
288
289 Version 0.4.0 (2008/11/26)
290 --------------------------
291 - fixed bug #0005: percent_translated divide by 0 on empty po files,
292 - fixed bug #0004: occurrences that have hyphens are wrapped when they should not,
293 - changes in how encoding is handled,
294 - remove deprecation warnings for typo on "occurrences",
295 - added POEntry.__cmp__() method to sort entries like gettext does,
296 - fixed POEntry.transalated(),
297 - added a merge() method to POFile class, that behaves like the gettext msgmerge utility,
298 - obsolete entries are now written at the end of the file and with only msgid/msgstr like gettext does,
299 - fixed some bugs in mo files parsing,
300 - renamed quote/unquote functions to escape/unescape,
301 - various cosmetic changes.
302
303 Version 0.3.1 (2007/12/13)
304 --------------------------
305 - fixed bug #0002: typo on "occurrences",
306 - fixed bug #0003: mismatch in exception instance names,
307 - removed deprecation warnings,
308 - removed unused charset() method in POFile/MOFile objects,
309 - fixed bug in multibytes string length (added regression tests),
310 - fixed a bug in detect_encoding(),
311 - added a find() method to _BaseFile class,
312 - proper handling of quoting and unquoting,
313 - proper handling of multiline strings in metadata
314
315 Version 0.3.0 (2007/10/17)
316 --------------------------
317 - speed improvements,
318 - polib can now compile mo files,
319 - unicode support,
320 - fixed bug #0001: global name 'sorted' is not defined" on python 2.3.
321
322 Version 0.1.0 (2006-08-08)
323 --------------------------
324 Initial release
325
326
327 Platform: posix
328 Classifier: Development Status :: 5 - Production/Stable
329 Classifier: Environment :: Console
330 Classifier: Environment :: Web Environment
331 Classifier: Intended Audience :: Developers
332 Classifier: Intended Audience :: System Administrators
333 Classifier: License :: OSI Approved :: MIT License
334 Classifier: Operating System :: OS Independent
335 Classifier: Programming Language :: Python
336 Classifier: Programming Language :: Python :: 2
337 Classifier: Programming Language :: Python :: 2.7
338 Classifier: Programming Language :: Python :: 3
339 Classifier: Programming Language :: Python :: 3.6
340 Classifier: Programming Language :: Python :: 3.7
341 Classifier: Programming Language :: Python :: 3.8
342 Classifier: Programming Language :: Python :: 3.9
343 Classifier: Programming Language :: Python :: 3.10
344 Classifier: Programming Language :: Python :: 3.11
345 Classifier: Programming Language :: Python :: Implementation :: PyPy
346 Classifier: Topic :: Software Development :: Libraries :: Python Modules
347 Classifier: Topic :: Software Development :: Internationalization
348 Classifier: Topic :: Software Development :: Localization
349 Classifier: Topic :: Text Processing :: Linguistic