Module polib
source code
**polib** allows you to manipulate, create, modify gettext files (pot,
po and mo files). You can load existing files, iterate through it's
entries, add, modify entries, comments or metadata, etc... or create new
po files from scratch.
**polib** provides a simple and pythonic API, exporting only three
convenience functions (*pofile*, *mofile* and *detect_encoding*), and the
four core classes, *POFile*, *MOFile*, *POEntry* and *MOEntry* for
creating new files/entries.
**Basic example**:
>>> import polib
>>>
>>> po = polib.pofile('tests/test_utf8.po')
>>> for entry in po:
...
... pass
>>>
>>> entry = polib.POEntry(msgid='Welcome', msgstr='Bienvenue')
>>> entry.occurrences = [('welcome.py', '12'), ('anotherfile.py', '34')]
>>> po.append(entry)
>>>
>>>
>>>
>>>
Version:
0.3.1
Author:
David JEAN LOUIS <izimobil@gmail.com>
|
_BaseFile
Common parent class for POFile and MOFile classes.
|
|
POFile
Po (or Pot) file reader/writer.
|
|
MOFile
Mo file reader/writer.
|
|
_BaseEntry
Base class for POEntry or MOEntry objects.
|
|
POEntry
Represents a po file entry.
|
|
MOEntry
Represents a mo file entry.
|
|
_POFileParser
A finite state machine to parse efficiently and correctly po file
format.
|
|
_MOFileParser
A class to parse binary mo files.
|
D[k] if k in D, else d
|
|
|
_listappend(L,
object)
append object to end |
|
|
item
|
_listpop(L,
index=...)
remove and return item at index (default last) |
|
|
string
|
_strjoin(S,
sequence)
Return a string which is the concatenation of the strings in the
sequence. |
source code
|
|
list of strings
|
_strsplit(S,
sep=... ,
maxsplit=...)
Return a list of the words in the string S, using sep as the
delimiter string. |
source code
|
|
string or unicode
|
_strstrip(S,
chars=...)
Return a copy of the string S with leading and trailing whitespace
removed. |
source code
|
|
|
|
|
pofile(fpath,
**kwargs)
Convenience function that parse the po/pot file *fpath* and return a
POFile instance. |
source code
|
|
|
mofile(fpath,
**kwargs)
Convenience function that parse the mo file *fpath* and return a
MOFile instance. |
source code
|
|
|
|
|
|
|
|
|
default_encoding = ' utf-8 '
|
Return a string which is the concatenation of the strings in the
sequence. The separator between elements is S.
- Returns: string
|
Return a list of the words in the string S, using sep as the delimiter
string. If maxsplit is given, at most maxsplit splits are done. If sep
is not specified or is None, any whitespace string is a separator.
- Returns: list of strings
|
Return a copy of the string S with leading and trailing whitespace
removed. If chars is given and not None, remove characters in chars
instead. If chars is unicode, S will be converted to unicode before
stripping
- Returns: string or unicode
|
S.replace (old, new[, count]) -> string
Return a copy of string S with all occurrences of substring old
replaced by new. If the optional argument count is given, only the first
count occurrences are replaced.
|
Convenience function that parse the po/pot file *fpath* and return a
POFile instance.
**Keyword arguments**:
-
*fpath*: string, full or relative path to the po/pot file to parse
-
*wrapwidth*: integer, the wrap width, only useful when -w option was
passed to xgettext (optional, default to 78)
-
*autodetect_encoding*: boolean, if set to False the function will not
try to detect the po file encoding (optional, default to True)
-
*encoding*: string, an encoding, only relevant if autodetect_encoding
is set to False
**Example**:
>>> import polib
>>> po = polib.pofile('tests/test_utf8.po')
>>> po
<POFile instance at ...>
>>> import os, tempfile
>>> for fname in ['test_iso-8859-15.po', 'test_utf8.po']:
... orig_po = polib.pofile('tests/'+fname)
... tmpf = tempfile.NamedTemporaryFile().name
... orig_po.save(tmpf)
... try:
... new_po = polib.pofile(tmpf)
... for old, new in zip(orig_po, new_po):
... if old.msgid != new.msgid:
... old.msgid
... new.msgid
... if old.msgstr != new.msgstr:
... old.msgid
... new.msgid
... finally:
... os.unlink(tmpf)
|
Convenience function that parse the mo file *fpath* and return a
MOFile instance.
**Keyword arguments**:
-
*fpath*: string, full or relative path to the mo file to parse
-
*wrapwidth*: integer, the wrap width, only useful when -w option was
passed to xgettext to generate the po file that was used to format
the mo file (optional, default to 78)
-
*autodetect_encoding*: boolean, if set to False the function will not
try to detect the po file encoding (optional, default to True)
-
*encoding*: string, an encoding, only relevant if autodetect_encoding
is set to False
**Example**:
>>> import polib
>>> mo = polib.mofile('tests/test_utf8.mo')
>>> mo
<MOFile instance at ...>
>>> import os, tempfile
>>> for fname in ['test_iso-8859-15.mo', 'test_utf8.mo']:
... orig_mo = polib.mofile('tests/'+fname)
... tmpf = tempfile.NamedTemporaryFile().name
... orig_mo.save(tmpf)
... try:
... new_mo = polib.mofile(tmpf)
... for old, new in zip(orig_mo, new_mo):
... if old.msgid != new.msgid:
... old.msgstr
... new.msgstr
... finally:
... os.unlink(tmpf)
|
Try to detect the encoding used by the file *fpath*. The function will
return polib default *encoding* if it's unable to detect it.
**Keyword argument**:
-
*fpath*: string, full or relative path to the mo file to parse.
**Examples**:
>>> print(detect_encoding('tests/test_noencoding.po'))
utf-8
>>> print(detect_encoding('tests/test_utf8.po'))
UTF-8
>>> print(detect_encoding('tests/test_utf8.mo'))
UTF-8
>>> print(detect_encoding('tests/test_iso-8859-15.po'))
ISO_8859-15
>>> print(detect_encoding('tests/test_iso-8859-15.mo'))
ISO_8859-15
|
Escape special chars and return the given string *st*.
**Examples**:
>>> escape('\t and \n and \r and " and \\')
'\\t and \\n and \\r and \\" and \\\\'
|
Unescape special chars and return the given string *st*.
**Examples**:
>>> unescape('\\t and \\n and \\r and \\" and \\\\')
'\t and \n and \r and " and \\'
|