Classes that represent various storage formats for localization.
Base classes for storage interfaces.
Base class for stores for multiple translation units of type UnitClass.
A list of file extentions associated with this store type
A list of MIME types associated with this store type
The human usable name of this store type
The class of units that will be instantiated and used by this class
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parser to process the given source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Indicates if format can store suggestions and alternative translation for a unit
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Base class for translation units.
Our concept of a translation unit is influenced heavily by XLIFF.
As such most of the method- and variable names borrows from XLIFF terminology.
A translation unit consists of the following:
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
A list of functions to use for parsing a string into a rich string tree.
See also
See also
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Forces derived classes to override method.
class to aid in benchmarking Translate Toolkit stores
removes the given directory
creates sample files for benchmarking
parses all the files in the test directory into memory
parses placeables
Represents a translate project bundle (zip archive).
Append the given file to the project with the given filename, marked to be of type ftype (‘src’, ‘trans’, ‘tgt’).
| Parameters: | delete_orig – If True, as set by convert_forward(), afile is deleted after appending, if possible. |
|---|
Note
For this implementation, the appended file will be deleted from disk if delete_orig is True.
Clean up our mess: remove temporary files.
Retrieve a project file (source, translation or target file) from the project archive.
Get the type of file (‘src’, ‘trans’, ‘tgt’) with the given name.
Try and find a project file name for the given real file name.
Load the bundle project from the zip file of the given name.
Remove the file with the given project name from the project.
Save all project files to the bundle zip file.
Read-only access to self._sourcefiles.
Read-only access to self._targetfiles.
Read-only access to self._transfiles.
Updates the file with the given project file name with the contents of infile.
| Returns: | the results from BundleProjStore.append_file(). |
|---|
Manage the Haiku catkeys translation format
The Haiku catkeys format is the translation format used for localisation of the Haiku operating system.
It is a bilingual base class derived format with CatkeysFile and CatkeysUnit providing file and unit level access. The file format is described here: http://www.haiku-os.org/blog/pulkomandy/2009-09-24_haiku_locale_kit_translator_handbook
The implementation covers the full requirements of a catkeys file. The files are simple Tab Separated Value (TSV) files that can be read by Microsoft Excel and other spreadsheet programs. They use the .txt extension which does make it more difficult to automatically identify such files.
The dialect of the TSV files is specified by CatkeysDialect.
catkeys seem to escape things like in C++ (strings are just extracted from the source code unchanged, it seems.
Functions allow for _escape() and _unescape().
Describe the properties of a catkeys generated TAB-delimited file.
A catkeys translation memory file
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parsse the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A catkeys translation memory header
Set a human readable target language
A catkeys translation memory unit
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the dictionary of values for a catkeys line
Get the dictionary of values for a catkeys line
Get all error messages.
| Return type: | Dictionary |
|---|
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Make a unit obsolete
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Set the dictionary of values for a catkeys line
| Parameters: | newdict (Dict) – a new dictionary with catkeys line elements |
|---|
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Iterator that only returns this unit.
Field names for a catkeys TU
Field names for the catkeys header
Default or minimum header entries for a catkeys file
Classes that hold units of .po files (pounit) or entire files (pofile).
Gettext-style .po (or .pot) files are used in translations for KDE, GNOME and many other projects.
This uses libgettextpo from the gettext package. Any version before 0.17 will at least cause some subtle bugs or may not work at all. Developers might want to have a look at gettext-tools/libgettextpo/gettext-po.h from the gettext package for the public API of the library.
Returns the libgettextpo version
| Return type: | three-value tuple |
|---|---|
| Returns: | libgettextpo version in the following format:: (major version, minor version, subminor version) |
Separator for #: entries
classes that hold units of comma-separated values (.csv) files (csvunit) or entire files (csvfile) for use with localisation
This class represents a .csv file with various lines. The default format contains three columns: location, source, target
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Test if file has a header or not, also returns number of columns in first row
check if fieldnames are valid
This module provides functionality to work with directories.
This class represents a directory.
Iterator over (dir, filename) for all files in this directory.
Returns a list of (dir, filename) tuples for all the file names in this directory.
List of all the units in all the files in this directory.
Populate the internal file data.
Iterator over all the units in all the files in this directory.
Classes that hold units of .dtd files (dtdunit) or entire files (dtdfile).
These are specific .dtd files for localisation used by mozilla.
The following information is provided by Mozilla:
There is a grammar for entity definitions, which isn’t really precise, as the spec says. There’s no formal specification for DTD files, it’s just “whatever makes this work” basically. The whole piece is clearly not the strongest point of the xml spec
XML elements are allowed in entity values. A number of things that are allowed will just break the resulting document, Mozilla forbids these in their DTD parser.
There are two dialects:
Both dialects are similar, but the Android DTD uses some particular escapes that regular DTDs don’t have.
In DTD usually there are characters escaped in the entities. In order to ease the translation some of those escaped characters are unescaped when reading from, or converting, the DTD, and that are escaped again when saving, or converting to a DTD.
In regular DTD the following characters are usually or sometimes escaped:
Besides the previous ones there are a lot of escapes for a huge number of characters. This escapes usually have the form of &#NUMBER; where NUMBER represents the numerical code for the character.
There are a few particularities in DTD escaping. Some of the escapes are not yet implemented since they are not really necessary, or because its implementation is too hard.
A special case is the ‘ escaping using ' which doesn’t provide a full roundtrip conversion in order to support some special Mozilla DTD files.
Also the ” character is never escaped in the case that the previous character is = (the sequence =” is present on the string) in order to avoid escaping the ” character indicating an attribute assignment, for example in a href attribute for an a tag in HTML (anchor tag).
It has the sames escapes as in regular DTD, plus this ones:
Accesskey Suffixes: entries with this suffix may be combined with labels ending in labelsuffixes into accelerator notation
A .dtd file made up of dtdunits.
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
convert the units back to source
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
makes self.id_index dictionary keyed on entities
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
read the source code of a dtd file in and include them as dtdunits in self.units
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
An entity definition from a DTD file (and any associated comments).
Adds an error message to this unit.
| Parameters: |
|---|
Set the entity to the given “location”.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Return the entity as location (identifier).
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
convert the dtd entity back to string form
gets the unquoted source string
gets the unquoted target string
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
returns whether this dtdunit doesn’t actually have an entity definition
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
read the first dtd element from the source code into this object, return linesprocessed
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the definition to the quoted value of source
Sets the definition to the quoted value of target
gets the unquoted source string
gets the unquoted target string
Iterator that only returns this unit.
Label suffixes: entries with this suffix are able to be comibed with accesskeys found in in entries ending with accesskeysuffixes
Escapes a line for Android DTD files.
Quotes and escapes a line for regular DTD files.
Find and remove ampersands that are not part of an entity definition.
A stray & in a DTD file can break an application’s ability to parse the file. In Mozilla localisation this is very important and these can break the parsing of files used in XUL and thus break interface rendering. Tracking down the problem is very difficult, thus by removing potential broken ampersand and warning the users we can ensure that the output DTD will always be parsable.
| Parameters: |
|
|---|---|
| Return type: | String |
| Returns: | Entity value without bad ampersands |
Unquotes a quoted Android DTD definition.
unquotes a quoted dtd definition
Py2exe can’t find stuff that we import dynamically, so we have this file just for the sake of the Windows installer to easily pick up all the stuff that we need and ensure they make it into the installer.
factory methods to build real storage objects that conform to base.py
Dictionary of file extensions and the names of their associated class.
Used for dynamic lazy loading of modules. _ext is a pseudo extension, that is their is no real extension by that name.
Factory that returns the applicable class for the type of file presented. Specify ignore to ignore some part at the back of the name (like .gz).
Factory that returns a usable object for the type of file presented.
| Parameters: | storefile (file or str) – File object or file name. |
|---|
Specify ignore to ignore some part at the back of the name (like .gz).
Returns data about all supported files
| Returns: | list of type that include (name, extensions, mimetypes) |
|---|---|
| Return type: | list |
Classes for the support of Gettext .po and .pot files.
This implementation assumes that cpo is working. This should not be used directly, but can be used once cpo has been established to work.
Separator for #: entries
A .po file containing various units
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
Deprecated: changes the encoding on the file.
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
Returns the nplural and plural values from the header.
return a list of unit ids
Return the project based on information in the header.
Get the source language for this store.
Return the target language based on information in the header.
Return a list of all units in this store.
Returns the header element, or None. Only the first element is allowed to be a header. Note that this could still return an empty header element, if present.
sets default values for po headers
Return True if the object doesn’t contain any translation units.
Create a header for the given filename.
Check .makeheaderdict() for information on parameters.
Create a header dictionary with useful defaults.
pot_creation_date can be None (current date) or a value (datetime or string) po_revision_date can be None (form), False (=pot_creation_date), True (=now), or a value (datetime or string)
| Returns: | Dictionary with the header items |
|---|---|
| Return type: | dict |
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
Merges another header with this header.
This header is assumed to be the template.
Parses the given file or file source string.
Reads the given file (or opens the given filename) and parses back to an object.
Parses the PO header and returns the interpreted values as a dictionary.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
Make sure each msgid is unique ; merge comments etc from duplicates into original
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project in the header.
| Parameters: | project_style (str) – the new project |
|---|
Set the source language for this store.
Set the target language in the header.
This removes any custom Poedit headers if they exist.
| Parameters: | lang (str) – the new target language code |
|---|
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Add contribution comments if necessary.
Updates the fields in the PO style header.
This will create a header if add == True.
Update the Plural-Form PO header.
module for parsing html files for translation
A unit of translatable/localisable HTML content
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the target string to the given value.
Iterator that only returns this unit.
Remove double spaces from HTML snippets
Escape &, < and >
Strip unnecessary html from the text.
HTML tags are deemed unnecessary if it fully encloses the translatable text, eg. ‘<a href=”index.html”>Home Page</a>’.
HTML tags that occurs within the normal flow of text will not be removed, eg. ‘This is a link to the <a href=”index.html”>Home Page</a>.’
Class that manages iCalender files for translation.
iCalendar files follow the RFC2445 specification.
The iCalendar specification uses the following naming conventions:
The following are localisable in this implementation:
While other items could be localised this is not seen as important until use cases arise. In such a case simply adjusting the component.name and property.name lists to include these will allow expanded localisation.
An ical file
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
An ical entry that is translatable
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Class that manages .ini files for translation
# a comment ; a comment
[Section] a = a string b : a string
Base class for differentiating dialect options and functions
An INI file
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Parse the given file or file source string.
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A INI file entry
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Decorator that registers the dialect.
Class that manages JSON data files for translation
JSON is an acronym for JavaScript Object Notation, it is an open standard designed for human-readable data interchange.
JSON basic types:
Example:
{
"firstName": "John",
"lastName": "Smith",
"age": 25,
"address": {
"streetAddress": "21 2nd Street",
"city": "New York",
"state": "NY",
"postalCode": "10021"
},
"phoneNumber": [
{
"type": "home",
"number": "212 555-1234"
},
{
"type": "fax",
"number": "646 555-4567"
}
]
}
TODO:
A JSON file
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A JSON entry
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Iterator that only returns this unit.
Parent class for LISA standards (TMX, TBX, XLIFF)
A class representing a file store for one of the LISA file formats.
Add a unit to source and location idexes
Method to be overridden to initialise headers, etc.
Adds and returns a new unit with the given string as first entry.
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Initialises self.body so it never needs to be retrieved from the XML again.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A single unit in the file. Provisional work is done to make several languages possible.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Create the text node in parent containing all the ph tags
Returns a xml Element setup with given parameters to represent a single language entry. Has to be overridden.
Retrieves the term from the given languageNode.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Retrieves a languageNode either by language or by index.
Returns a list of all nodes that contain per language information.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the “target” string (second language), or alternatively appends to the list
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Iterator that only returns this unit.
Module for parsing Gettext .mo files for translation.
The coding of .mo files was produced from Gettext documentation, Pythons msgfmt.py and by observing and testing existing .mo files in the wild.
The hash algorithm is implemented for MO files, this should result in faster access of the MO file. The hash is optional for Gettext and is not needed for reading or writing MO files, in this implementation it is always on and does produce sometimes different results to Gettext in very small files.
A class representing a .mo file.
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
Returns the nplural and plural values from the header.
return a list of unit ids
Return the project based on information in the header.
Get the source language for this store.
Return the target language based on information in the header.
Return a list of all units in this store.
Returns the header element, or None. Only the first element is allowed to be a header. Note that this could still return an empty header element, if present.
sets default values for po headers
Return True if the object doesn’t contain any translation units.
Create a header for the given filename.
Check .makeheaderdict() for information on parameters.
Create a header dictionary with useful defaults.
pot_creation_date can be None (current date) or a value (datetime or string) po_revision_date can be None (form), False (=pot_creation_date), True (=now), or a value (datetime or string)
| Returns: | Dictionary with the header items |
|---|---|
| Return type: | dict |
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Merges another header with this header.
This header is assumed to be the template.
parses the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Parses the PO header and returns the interpreted values as a dictionary.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project in the header.
| Parameters: | project_style (str) – the new project |
|---|
Set the source language for this store.
Set the target language in the header.
This removes any custom Poedit headers if they exist.
| Parameters: | lang (str) – the new target language code |
|---|
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Add contribution comments if necessary.
Updates the fields in the PO style header.
This will create a header if add == True.
Update the Plural-Form PO header.
A class representing a .mo translation message.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Is this a header entry?
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Is this message translateable?
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Helper to unpack Gettext MO files into a Python string
A class to manage Mozilla .lang files.
We extend TxtFile, since that has a lot of useful stuff for encoding
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Convert the units back to blocks
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
This is just a normal unit with a weird string output
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Manage the OmegaT glossary format
OmegaT glossary format is used by the OmegaT computer aided translation tool.
It is a bilingual base class derived format with OmegaTFile and OmegaTUnit providing file and unit level access.
The OmegaT glossary format is a simple Tab Separated Value (TSV) file with the columns: source, target, comment.
The dialect of the TSV files is specified by OmegaTDialect.
Field names for an OmegaT glossary unit
Describe the properties of an OmegaT generated TAB-delimited glossary file.
An OmegaT glossary file
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parsese the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
An OmegaT glossary file in the default system encoding
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parsese the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
An OmegaT glossary unit
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Build a native unit from a foreign unit, preserving as much information as possible.
Get the dictionary of values for a OmegaT line
Get the message context.
Get the dictionary of values for a OmegaT line
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Set the dictionary of values for a OmegaT line
| Parameters: | newdict (Dict) – a new dictionary with OmegaT line elements |
|---|
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Iterator that only returns this unit.
Classes that hold units of .oo files (oounit) or entire files (oofile).
These are specific .oo files for localisation exported by OpenOffice.org - SDF format (previously knows as GSI files).
The behaviour in terms of escaping is explained in detail in the programming comments.
Encode a Unicode string the the specified encoding
Escapes the help text as it would be in an SDF file.
<, >, ” are only escaped in <[[:lower:]]> tags. Some HTML tags make it in in lowercase so those are dealt with. Some OpenOffice.org help tags are not escaped.
Escapes SDF text to be suitable for unit consumption.
converts an oo key tuple into a unique identifier
| Parameters: |
|
|---|---|
| Return type: | str |
| Returns: | unique ascii identifier |
converts any non-alphanumeric (standard roman) characters to _
this represents an entire .oo file
adds a parsed line to the file
converts all the lines back to tab-delimited form
parses lines and adds them to the file
this represents one line, one translation in an .oo file
get the key that identifies the resource
return a line in tab-delimited form
return a list of parts in this line
Obtains the text column and handle escaping.
create a line from its tab-delimited parts
Sets the text column and handle escaping.
Obtains the text column and handle escaping.
this takes a huge GSI file and represents it as multiple smaller files...
reads in all the lines and works out the subfiles
returns an oofile built up from the given subfile’s lines
looks up the subfile name for the line
returns the list of lines matching the subfile
returns a list of subfiles in the file
returns a pseudo-file object for the given subfile
returns a pseudo-file object for the given subfile
this represents a number of translations of a resource
add a line to the oounit
return the lines in tab-delimited form
Unescapes normal text to be suitable for writing to the SDF file.
Unescapes SDF text to be suitable for unit consumption.
This module implements basic functionality to support placeables.
Substitutions
For example, in ODF, footnotes appear in the ODF XML where they are defined; so if we extract a paragraph with some footnotes, the translator will have a lot of additional XML to with; so we separate the footnotes out into separate translation units and mark their positions in the original text with placeables.
Hiding of inline formatting data
The translator doesn’t want to have to deal with all the weird formatting conventions of wherever the text came from.
Marking variables
This is an old issue - translators translate variable names which should remain untranslated. We can wrap placeables around variable names to avoid this.
The placeables model follows the XLIFF standard’s list of placeables. Please refer to the XLIFF specification to get a better understanding.
Contains base placeable classes with names based on XLIFF placeables. See the XLIFF standard for more information about what the names mean.
Contains general placeable implementations. That is placeables that does not fit into any other sub-category.
Placeable for the “alt=...” attributes inside XML tags.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
A parser method to extract placeables from a string based on a regular expression. Use this function as the @parse() method of a placeable class.
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Placeable handling XML entities (&xxxxx;-style entities).
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
A parser method to extract placeables from a string based on a regular expression. Use this function as the @parse() method of a placeable class.
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Placeable handling XML tags.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
A parser method to extract placeables from a string based on a regular expression. Use this function as the @parse() method of a placeable class.
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Base class for all placeables.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Contains the parse function that parses normal strings into StringElem- based “rich” string element trees.
Parse placeables from the given string or sub-tree by using the parsing functions provided.
The output of this function is heavily dependent on the order of the parsing functions. This is because of the algorithm used.
An over-simplification of the algorithm: the leaves in the StringElem tree are expanded to the output of the first parsing function in parse_funcs. The next level of recursion is then started on the new set of leaves with the used parsing function removed from parse_funcs.
| Parameters: | tree (unicode|StringElem) – The string or string element sub-tree to parse. |
|---|
Contains the base StringElem class that represents a node in a parsed rich-string tree. It is the base class of all placeables.
This class represents a sub-tree of a string parsed into a rich structure. It is also the base class of all placeables.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Whether this string can have sub-elements.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether this string should be changable by the user. Not used at the moment.
Whether this element should be deleted in its entirety when partially deleted. Only checked when iseditable = False
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Whether this string is translatable into other languages.
Whether this string should be visible to the user. Not used at the moment.
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
Parse an instance of this class from the start of the given string. This method should be implemented by any sub-class that wants to parseable by translate.storage.placeables.parse.
| Parameters: | pstr (unicode) – The string to parse into an instance of this class. |
|---|---|
| Returns: | An instance of the current class, or None if the string not parseable by this class. |
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
An optional function that returns the Unicode representation of the string.
The sub-elements that make up this this string.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Contains the placeable that represents a terminology term.
Terminology distinguished from the rest of a string by being a placeable.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
A list of matcher objects to use to identify terminology.
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
The available translations for this placeable.
Contains XLIFF-specific placeables.
Placeable for unrecognized or umimplemented XML nodes. It’s main purpose is to preserve all associated XML data.
Apply f to all actual strings in the tree.
| Parameters: | f – Must take one (str or unicode) argument and return a string or unicode. |
|---|
Returns a copy of the sub-tree. This should be overridden in sub-classes with more data.
Note
self.renderer is not copied.
Delete the text in the range given by the string-indexes start_index and end_index.
Partial nodes will only be removed if they are editable.
| Returns: | A StringElem representing the removed sub-string, the parent node from which it was deleted as well as the offset at which it was deleted from. None is returned for the parent value if the root was deleted. If the parent and offset values are not None, parent.insert(offset, deleted) effectively undoes the delete. |
|---|
Returns a list of the nodes in the tree in depth-first order.
Get the StringElem in the tree that contains the string rendered at the given offset.
Find the offset of elem in the current tree.
This cannot be reliably used if self.renderer is used and even less so if the rendering function renders the string differently upon different calls. In Virtaal the StringElemGUI.index() method is used as replacement for this one.
| Returns: | The string index where element e starts, or -1 if e was not found. |
|---|
More unicode class emulation.
Find sub-string x in this string tree and return the position at which it starts.
Find all elements in the current sub-tree containing x.
Flatten the tree by returning a depth-first search over the tree’s leaves.
Get info about the specified range in the tree.
| Returns: | A dictionary with the following items:
|
|---|
Searches the current sub-tree for and returns the parent of the child element.
Insert the given text at the specified offset of this string-tree’s string (Unicode) representation.
Insert the given text between the two parameter StringElems.
Whether or not this instance is a leaf node in the StringElem tree.
A node is a leaf node if it is a StringElem (not a sub-class) and contains only sub-elements of type str or unicode.
| Return type: | bool |
|---|
Iterate through the nodes in the tree in dept-first order.
Apply f to all nodes for which filter returned True (optional).
Parse an instance of this class from the start of the given string. This method should be implemented by any sub-class that wants to parseable by translate.storage.placeables.parse.
| Parameters: | pstr (unicode) – The string to parse into an instance of this class. |
|---|---|
| Returns: | An instance of the current class, or None if the string not parseable by this class. |
Print the tree from the current instance’s point in an indented manner.
Remove unnecessary nodes to make the tree optimal.
Replace nodes with type ptype with base StringElems, containing the same sub-elements. This is only applicable to elements below the element tree root node.
Transform the sub-tree according to some class-specific needs. This method should be either overridden in implementing sub-classes or dynamically replaced by specific applications.
| Returns: | The transformed Unicode string representing the sub-tree. |
|---|
Classes that hold units of PHP localisation files phpunit or entire files phpfile. These files are used in translating many PHP based applications.
Only PHP files written with these conventions are supported:
<?php
$lang['item'] = "vale"; # Array of values
$some_entity = "value"; # Named variables
define("ENTITY", "value");
$lang = array(
'item1' => 'value1' , #Supports space before comma
'item2' => 'value2',
);
$lang = array( # Nested arrays
'item1' => 'value1',
'item2' => array(
'key' => 'value' , #Supports space before comma
'key2' => 'value2',
),
);
Nested arrays without key for nested array are not supported:
<?php
$lang = array(array('key' => 'value'));
The working of PHP strings and specifically the escaping conventions which differ between single quote (‘) and double quote (”) characters are implemented as outlined in the PHP documentation for the String type.
Convert PHP escaped string to a Python string.
Convert Python string to PHP escaping.
The encoding is implemented for ‘single quote’ and “double quote” syntax.
heredoc and nowdoc are not implemented and it is not certain whether this would ever be needed for PHP localisation needs.
This class represents a PHP file, made up of phpunits.
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Read the source of a PHP file in and include them as units.
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A unit of a PHP file: a name, a value, and any comments associated.
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Convert the unit back into formatted lines for a php file.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Return whether this is a blank element, containing only comments.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source AND the target to be equal.
Iterator that only returns this unit.
Tests whether the given encoding is known in the python runtime, or returns utf-8. This function is used to ensure that a valid encoding is always used.
The one definitive way to extract a msgid comment out of an unescaped unicode string that might contain it.
| Return type: | unicode |
|---|
Quote the query fragment of a URL; replacing ‘ ‘ with ‘+’
unquote(‘%7e/abc+def’) -> ‘~/abc def’
class that handles all header functions for a header in a po file
Parses an input string with the definition of a PO header and returns the interpreted values as a dictionary.
This class implements functionality for manipulation of po file headers. This class is a mix-in class and useless on its own. It must be used from all classes which represent a po file
Returns the nplural and plural values from the header.
Return the project based on information in the header.
Return the target language based on information in the header.
Returns the header element, or None. Only the first element is allowed to be a header. Note that this could still return an empty header element, if present.
sets default values for po headers
Create a header for the given filename.
Check .makeheaderdict() for information on parameters.
Create a header dictionary with useful defaults.
pot_creation_date can be None (current date) or a value (datetime or string) po_revision_date can be None (form), False (=pot_creation_date), True (=now), or a value (datetime or string)
| Returns: | Dictionary with the header items |
|---|---|
| Return type: | dict |
Merges another header with this header.
This header is assumed to be the template.
Parses the PO header and returns the interpreted values as a dictionary.
Set the project in the header.
| Parameters: | project_style (str) – the new project |
|---|
Set the target language in the header.
This removes any custom Poedit headers if they exist.
| Parameters: | lang (str) – the new target language code |
|---|
Add contribution comments if necessary.
Updates the fields in the PO style header.
This will create a header if add == True.
Update the Plural-Form PO header.
Returns the timezone as a string in the format [+-]0000, eg +0200.
| Return type: | str |
|---|
Update an existing header dictionary with the values in kwargs, adding new values only if add is true.
| Returns: | Updated dictionary of header entries |
|---|---|
| Return type: | dict |
Read all the lines belonging to the current unit if obsolete.
Read all the lines belonging starting with #|. These lines contain the previous msgid and msgctxt info. We strip away the leading ‘#| ‘ and read until we stop seeing #|.
A class loader that will load C or Python implementations of the PO class depending on the USECPO variable.
Use the environment variable USECPO=2 (or 1) to choose the C implementation which uses Gettext’s libgettextpo for high parsing speed. Otherise the local Python based parser is used (slower but very well tested).
XLIFF classes specifically suited for handling the PO representation in XLIFF.
This way the API supports plurals as if it was a PO file, for example.
a file for the po variant of Xliff files
alias of PoXliffUnit
Add a unit to source and location idexes
Initialise the file header.
This method should now be unnecessary, but is left for reference
adds the given trans-unit to the last used body node if the filename has changed it uses the slow method instead (will create the nodes required if asked). Returns success
adds a group tag into the specified file
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
finds the body node for the given filenode
Returns the datatype of the stored file. If no filename is given, the datatype of the first file is given.
Returns the date attribute for the file.
If no filename is given, the date of the first file is given. If the date attribute is not specified, None is returned.
| Returns: | Date attribute of file |
|---|---|
| Return type: | Date or None |
returns the name of the given file
returns all filenames in this XLIFF file
finds the filenode with the given name
finds the header node for the given filenode
Returns the nplural and plural values from the header.
Get the project type for this store.
Return a list of all units in this store.
Returns the header element, or None. Only the first element is allowed to be a header. Note that this could still return an empty header element, if present.
sets default values for po headers
Return True if the object doesn’t contain any translation units.
Create a header for the given filename.
Check .makeheaderdict() for information on parameters.
Create a header dictionary with useful defaults.
pot_creation_date can be None (current date) or a value (datetime or string) po_revision_date can be None (form), False (=pot_creation_date), True (=now), or a value (datetime or string)
| Returns: | Dictionary with the header items |
|---|---|
| Return type: | dict |
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Merges another header with this header.
This header is assumed to be the template.
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Parses the PO header and returns the interpreted values as a dictionary.
Parses the string to return the correct file object
Remove a unit from source and locaton indexes
We want to remove the default file-tag as soon as possible if we know if still present and empty.
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
set the name of the given file
Set the project type for this store.
Adds the given trans-unit (will create the nodes required if asked).
| Returns: | Success |
|---|---|
| Return type: | Boolean |
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Add contribution comments if necessary.
Updates the fields in the PO style header.
This will create a header if add == True.
Update the Plural-Form PO header.
A class to specifically handle the plural units created from a po file.
Adds an alt-trans tag and alt-trans components to the unit.
| Parameters: | txt (String) – Alternative translation of the source text. |
|---|
Adds an error message to this unit.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Add a note specifically in a “note” tag
Build a native unit from a foreign unit, preserving as much information as possible.
Check against node tag’s origin (e.g note or alt-trans)
Create the text node in parent containing all the ph tags
Add the context group to the trans-unit with contexts a list with (type, text) tuples describing each context.
Returns an xml Element setup with given parameters.
Removes the supplied alternative from the list of alt-trans tags
Retrieves the term from the given languageNode.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns <alt-trans> for the given origin as a list of units. No origin means all alternatives.
Returns the automatic comments (x-po-autocomment), which corresponds to the #. style po comments.
Get the message context.
Returns the contexts in the context groups with the specified name
Get all error messages.
Retrieves a languageNode either by language or by index.
We override this to get source and target nodes.
Returns all the references (source locations)
returns the restype attribute in the trans-unit tag
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
Returns the translator comments (x-po-trancomment), which corresponds to the # style po comments.
This unit in a list.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
States whether this unit is approved.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
indicate whether a unit is obsolete
States whether this unit needs to be reviewed
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Mark this unit as approved.
Marks the unit to indicate whether it needs review.
Adds an optional explanation as a note.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Iterator that only returns this unit.
Manages a project store as well as the processes involved in a project workflow.
Proxy for self.store.append_sourcefile().
Convenience method that calls add_source() and convert_forward() and returns the results from both.
Proxy for self.store.close().
Convert the given input file to the next type in the process:
Source document (eg. ODT) -> Translation file (eg. XLIFF) -> Translated document (eg. ODT).
| Parameters: |
|
|---|---|
| Returns 2-tuple: | |
the converted file object and its project name. |
|
Export the file with the specified filename to the given destination. This method will raise FileNotInProjectError via the call to get_file() if fname is not found in the project.
Proxy for self.store.get_file().
Proxy for self.store.get_proj_filename().
Try and find a real file name for the given project file name.
Proxy for self.store.remove_file().
Proxy for self.store.save().
Proxy for self.store.update_file().
Basic project file container.
Append the given file to the project with the given filename, marked to be of type ftype (‘src’, ‘trans’, ‘tgt’).
| Parameters: | delete_orig (bool) – Whether or not the original (given) file should be deleted after being appended. This is set to True by convert_forward() . Not used in this class. |
|---|
Retrieve the file with the given name from the project store.
The file is looked up in the self._files dictionary. The values in this dictionary may be None, to indicate that the file is not cacheable and needs to be retrieved in a special way. This special way must be defined in this method of sub-classes. The value may also be a string, which indicates that it is a real file accessible via open.
| Parameters: | mode (str) – The mode in which to re-open the file (if it is closed). |
|---|
Get the type of file (‘src’, ‘trans’, ‘tgt’) with the given name.
Try and find a project file name for the given real file name.
Load the project in some way. Undefined for this (base) class.
Remove the file with the given project name from the project. If the file type (‘src’, ‘trans’ or ‘tgt’) is not given, it is guessed.
Save the project in some way. Undefined for this (base) class.
Read-only access to self._sourcefiles.
Read-only access to self._targetfiles.
Read-only access to self._transfiles.
Remove the project file with name pfname and add the contents from infile to the project under the same file name.
| Returns: | the results from ProjectStore.append_file(). |
|---|
Classes that hold units of .properties, and similar, files that are used in translating Java, Mozilla, MacOS and other software.
The propfile class is a monolingual class with propunit providing unit level access.
The .properties store has become a general key value pair class with Dialect providing the ability to change the behaviour of the parsing and handling of the various dialects.
Currently we support:
The following provides references and descriptions of the various dialects supported:
Java .properties are supported completely except for the ability to drop pairs that are not translated.
The following .properties file description gives a good references to the .properties specification.
Properties file may also hold Java MessageFormat messages. No special handling is provided in this storage class for MessageFormat, but this may be implemented in future.
All delimiter types, comments, line continuations and spaces handling in delimeters are supported.
A simple summary of what is permissible follows.
Comments supported:
# a comment
! a comment
// a comment (only at the beginning of a line)
/* a comment (not across multiple lines) */
Name and Value pairs:
# Delimiters
key = value
key : value
key value
# Space in key and around value
\ key\ = \ value
# Note that the b and c are escaped for reST rendering
b = a string with escape sequences \t \n \r \\ \" \' \ (space) \u0123
c = a string with a continuation line \
continuation line
# Special cases
# key with no value
key
# value no key (extractable in prop2po but not mergeable in po2prop)
=value
# .strings specific
"key" = "value";
Settings for the various behaviours in key=value files.
Encode the string
Find the delimiter
Strip unneeded characters from the key
Strip unneeded characters from the value
Accesskey Suffixes: entries with this suffix may be combined with labels ending in labelsuffixes into accelerator notation
Misspelled function that is kept around in case someone relies on it.
Deprecated since version 1.7.0: Use find_delimiter() instead
Determine whether a line ends a new multi-line comment.
| Parameters: | line (unicode) – A properties line |
|---|---|
| Returns: | True if line ends a new multi-line comment |
| Return type: | bool |
Determine whether a line is a one-line comment.
| Parameters: | line (unicode) – A properties line |
|---|---|
| Returns: | True if line is a one-line comment |
| Return type: | bool |
Determine whether a line starts a new multi-line comment.
| Parameters: | line (unicode) – A properties line |
|---|---|
| Returns: | True if line starts a new multi-line comment |
| Return type: | bool |
Determine whether line has a line continuation marker.
.properties files can be terminated with a backslash () indicating that the ‘value’ continues on the next line. Continuation is only valid if there are an odd number of backslashses (an even number would result in a set of N/2 slashes not an escape)
| Parameters: | line (str) – A properties line |
|---|---|
| Returns: | Does line end with a line continuation |
| Return type: | Boolean |
Label suffixes: entries with this suffix are able to be comibed with accesskeys found in in entries ending with accesskeysuffixes
this class represents a .properties file, made up of propunits
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Read the source of a properties file in and include them as units.
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
An element of a properties file i.e. a name and value, and any comments associated.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Convert the element back into formatted lines for a .properties file
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
returns whether this is a blank element, containing only comments.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Iterator that only returns this unit.
Decorator that registers the dialect.
Classes that hold units of Gettext .po files (pounit) or entire files (pofile).
Escapes a line for po format. assumes no occurs in the line.
param line: unescaped text
Remove quote and unescape line from po file.
| Parameters: | line – a quoted line from a po file (msgid or msgstr) |
|---|
Deprecated since version 1.10: Replaced by unescape(). extractpoline() is kept to allow tests of correctness, and in case of external users.
Separator for #: entries
A .po file containing various units
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
decode any non-unicode strings in lines with self._encoding
encode any unicode strings in lines in self._encoding
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
Returns the nplural and plural values from the header.
return a list of unit ids
Return the project based on information in the header.
Get the source language for this store.
Return the target language based on information in the header.
Return a list of all units in this store.
Returns the header element, or None. Only the first element is allowed to be a header. Note that this could still return an empty header element, if present.
sets default values for po headers
Return True if the object doesn’t contain any translation units.
Create a header for the given filename.
Check .makeheaderdict() for information on parameters.
Create a header dictionary with useful defaults.
pot_creation_date can be None (current date) or a value (datetime or string) po_revision_date can be None (form), False (=pot_creation_date), True (=now), or a value (datetime or string)
| Returns: | Dictionary with the header items |
|---|---|
| Return type: | dict |
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
Merges another header with this header.
This header is assumed to be the template.
Parses the given file or file source string.
Reads the given file (or opens the given filename) and parses back to an object.
Parses the PO header and returns the interpreted values as a dictionary.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
Make sure each msgid is unique ; merge comments etc from duplicates into original
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project in the header.
| Parameters: | project_style (str) – the new project |
|---|
Set the source language for this store.
Set the target language in the header.
This removes any custom Poedit headers if they exist.
| Parameters: | lang (str) – the new target language code |
|---|
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Add contribution comments if necessary.
Updates the fields in the PO style header.
This will create a header if add == True.
Update the Plural-Form PO header.
Quotes the given text for a PO file, returning quoted and escaped lines
Unescape the given line.
Quotes on either side should already have been removed.
Module for parsing Qt .qm files.
Note
Based on documentation from Gettext’s .qm implementation (see write-qt.c) and on observation of the output of lrelease.
Note
Certain deprecated section tags are not implemented. These will break and print out the missing tag. They are easy to implement and should follow the structure in 03 (Translation). We could find no examples that use these so we’d rather leave it unimplemented until we actually have test data.
Note
Many .qm files are unable to be parsed as they do not have the source text. We assume that since they use a hash table to lookup the data there is actually no need for the source text. It seems however that in Qt4’s lrelease all data is included in the resultant .qm file.
Note
We can only parse, not create, a .qm file. The main issue is that we need to implement the hashing algorithm (which seems to be identical to the Gettext hash algorithm). Unlike Gettext it seems that the hash is required, but that has not been validated.
Note
The code can parse files correctly. But it could be cleaned up to be more readable, especially the part that breaks the file into sections.
http://qt.gitorious.org/+kde-developers/qt/kde-qt/blobs/master/tools/linguist/shared/qm.cpp Plural information QLocale languages
A class representing a .qm file.
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Parses the given file or file source string.
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A class representing a .qm translation message.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Helper to unpack Qt .qm files into a Python string
Module for handling Qt Linguist Phrase Book (.qph) files.
Extract from the Qt Linguist Manual: Translators: .qph Qt Phrase Book Files are human-readable XML files containing standard phrases and their translations. These files are created and updated by Qt Linguist and may be used by any number of projects and applications.
A DTD to define the format does not seem to exist, but the following code provides the reference implementation for the Qt Linguist product.
Class representing a QPH file store.
Add a unit to source and location idexes
Method to be overridden to initialise headers, etc.
Adds and returns a new unit with the given string as first entry.
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this .qph file.
We don’t implement setsourcelanguage as users really shouldn’t be altering the source language in .qph files, it should be set correctly by the extraction tools.
| Returns: | ISO code e.g. af, fr, pt_BR |
|---|---|
| Return type: | String |
Get the target language for this .qph file.
| Returns: | ISO code e.g. af, fr, pt_BR |
|---|---|
| Return type: | String |
Return a list of all units in this store.
Initialises self.body so it never needs to be retrieved from the XML again.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this .qph file to targetlanguage.
| Parameters: | targetlanguage (String) – ISO code e.g. af, fr, pt_BR |
|---|
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A single term in the qph file.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Add a note specifically in a “definition” tag
Build a native unit from a foreign unit, preserving as much information as possible.
Create the text node in parent containing all the ph tags
Returns an xml Element setup with given parameters.
Retrieves the term from the given languageNode.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Retrieves a languageNode either by language or by index.
We override this to get source and target nodes.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the “target” string (second language), or alternatively appends to the list
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Iterator that only returns this unit.
Classes that hold units of .rc files (rcunit) or entire files (rcfile) used in translating Windows Resources.
Escape a given .rc string into a valid Python string.
Escape a given Python string into a valid .rc string.
This class represents a .rc file, made up of rcunits.
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Read the source of a .rc file in and include them as units.
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A unit of an rc file
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Convert the element back into formatted lines for a .rc file.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Returns whether this is a blank element, containing only comments.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the source AND the target to be equal
Note
This also sets the .source attribute!
Iterator that only returns this unit.
Module to provide statistics and related functionality.
Manages statistics for storage objects.
Returns a list of the classes that the unit belongs to.
| Parameters: | unit – the unit to classify |
|---|
Makes a dictionary of which units fall into which classifications.
This method iterates over all units.
Counts the source and target words in each of the units.
Returns the number of fuzzy units.
Return a list of fuzzy units.
Joins the unit source strings in a single string of text.
Returns a list of all units in this object.
Updates the classification of a unit in self.classification.
| Parameters: | item – an integer that is an index in .getunits(). |
|---|
Returns the number of words in the source text.
Returns the number of translated units.
Return a list of translated units.
Returns the number of translated words in this object.
Returns the number of untranslated units.
Return a list of untranslated units.
Returns the number of untranslated words in this object.
Returns the number of words in the given text.
Module to provide a cache of statistics in a database.
An object instantiated as a singleton for each statsfile that provides access to the database cache from a pool of StatsCache objects.
This cache’s connection
The current cursor
Retrieves the error statistics for the given file if possible, otherwise delegates to cachestorechecks().
Return a dictionary of unit stats mapping sets of unit indices with those states
Return a dictionary of property names mapping sets of unit indices with those properties.
Retrieves the statistics for the given file if possible, otherwise delegates to cachestore().
Return a dictionary of property names mapping to arrays which map unit indices to property values.
Please note that this is different from filestats, since filestats supplies sets of unit indices with a given property, whereas this method supplies arrays which map unit indices to given values.
Returns a dictionary with all statistics initalised to 0.
Returns the numeric database state for the unit.
Modifies f to commit database changes if it executes without exceptions. Otherwise it rolls back the database.
ALL publicly accessible methods in StatsCache MUST be decorated with this decorator.
Counts the words in the unit’s source and target, taking plurals into account. The target words are only counted if the unit is translated.
Class that manages subtitle files for translation.
This class makes use of the subtitle functionality of gaupol.
See also
gaupol/agents/open.py::open_main
A patch to gaupol is required to open utf-8 files successfully.
specialized class for SubRipFile’s only
alias of SubtitleUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
specialized class for SubRipFile’s only
alias of SubtitleUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
specialized class for SubRipFile’s only
alias of SubtitleUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
specialized class for SubRipFile’s only
alias of SubtitleUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A subtitle file
alias of SubtitleUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parse the given file
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A subtitle entry that is translatable
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
module for handling TBX glossary files
Class representing a TBX file store.
Add a unit to source and location idexes
Initialise headers with TBX specific things.
Adds and returns a new unit with the given string as first entry.
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Initialises self.body so it never needs to be retrieved from the XML again.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A single term in the TBX file. Provisional work is done to make several languages possible.
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Create the text node in parent containing all the ph tags
returns a langset xml Element setup with given parameters
Retrieves the term from the given languageNode.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
Retrieves a languageNode either by language or by index.
Returns a list of all nodes that contain per language information.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the “target” string (second language), or alternatively appends to the list
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Iterator that only returns this unit.
Class that manages TikiWiki files for translation. Tiki files are <strike>ugly and inconsistent</strike> formatted as a single large PHP array with several special sections identified by comments. Example current as of 2008-12-01:
<?php
// Many comments at the top
$lang=Array(
// ### Start of unused words
"aaa" => "zzz",
// ### end of unused words
// ### start of untranslated words
// "bbb" => "yyy",
// ### end of untranslated words
// ### start of possibly untranslated words
"ccc" => "xxx",
// ### end of possibly untranslated words
"ddd" => "www",
"###end###"=>"###end###");
?>
In addition there are several auto-generated //-style comments scattered through the page and array, some of which matter when being parsed.
This has all been gleaned from the TikiWiki source. As far as I know no detailed documentation exists for the tiki language.php files.
Represents a tiki language.php file.
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Parse the given input into source units.
| Parameters: | input – the source, either a string or filehandle |
|---|
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A tiki unit entry.
Adds an error message to this unit.
| Parameters: |
|---|
Location is defined by the comments in the file. This function will only set valid locations.
| Parameters: | location – Where the string is located in the file. Must be a valid location. |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns the a list of the location(s) of the string.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Set the source string to the given value.
Set the target string to the given value.
Iterator that only returns this unit.
Module to provide a translation memory database.
module for parsing TMX translation memeory files
Class representing a TMX file store.
Add a unit to source and location idexes
Adds and returns a new unit with the given string as first entry.
addtranslation method for testing old unit tests
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Initialises self.body so it never needs to be retrieved from the XML again.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
method to test old unit tests
Iterator over all the units in this store.
A single unit in the TMX file.
Adds an error message to this unit.
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Add a note specifically in a “note” tag.
The origin parameter is ignored
Build a native unit from a foreign unit, preserving as much information as possible.
Make a copy of the translation unit.
We don’t want to make a deep copy - this could duplicate the whole XML tree. For now we just serialise and reparse the unit’s XML.
Create the text node in parent containing all the ph tags
returns a langset xml Element setup with given parameters
Retrieves the term from the given languageNode.
Get the message context.
Get all error messages.
Returns the identifier for this unit. The optional tuid property is used if available, otherwise we inherit .getid(). Note that the tuid property is only mandated to be unique from TMX 2.0.
Retrieves a languageNode either by language or by index.
Returns a list of all nodes that contain per language information.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the “target” string (second language), or alternatively appends to the list
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Iterator that only returns this unit.
Manage the Trados .txt Translation Memory format
A Trados file looks like this:
<TrU>
<CrD>18012000, 13:18:35
<CrU>CAROL-ANN
<UsC>0
<Seg L=EN_GB>Association for Road Safety \endash Conference
<Seg L=DE_DE>Tagung der Gesellschaft für Verkehrssicherheit
</TrU>
<TrU>
<CrD>18012000, 13:19:14
<CrU>CAROL-ANN
<UsC>0
<Seg L=EN_GB>Road Safety Education in our Schools
<Seg L=DE_DE>Verkehrserziehung an Schulen
</TrU>
RTF control to Unicode map. See http://msdn.microsoft.com/en-us/library/aa140283(v=office.10).aspx
Time format used by Trados .txt
Manages the timestamps in the Trados .txt format of DDMMYYY, hh:mm:ss
Get the time_struct object
Get the time in the Trados time format
Set the time_struct object
| Parameters: | newtime (time.time_struct) – a new time object |
|---|
Set the time_struct object using a Trados time formated string
| Parameters: | timestring (String) – A Trados time string (DDMMYYYY, hh:mm:ss) |
|---|
Get the time_struct object
Get the time in the Trados time format
A Trados translation memory file
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Convert Unicode string to Trodas escapes
Convert Trados text to normal Unicode string
Module for handling Qt linguist (.ts) files.
This will eventually replace the older ts.py which only supports the older format. While converters haven’t been updated to use this module, we retain both.
TS file format 4.3, 4.8, 5.0. Example.
Specification of the valid variable entries, 2
Class representing a TS file store.
Add a unit to source and location idexes
Method to be overridden to initialise headers, etc.
Adds and returns a new unit with the given string as first entry.
Adds the given unit to the last used body node (current context).
If the contextname is specified, switch to that context (creating it if allowed by createifmissing).
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this .ts file.
The ‘sourcelanguage’ attribute was only added to the TS format in Qt v4.5. We return ‘en’ if there is no sourcelanguage set.
We don’t implement setsourcelanguage as users really shouldn’t be altering the source language in .ts files, it should be set correctly by the extraction tools.
| Returns: | ISO code e.g. af, fr, pt_BR |
|---|---|
| Return type: | String |
Get the target language for this .ts file.
| Returns: | ISO code e.g. af, fr, pt_BR |
|---|---|
| Return type: | String |
Return a list of all units in this store.
Initialises self.body.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this .ts file to targetlanguage.
| Parameters: | targetlanguage (String) – ISO code e.g. af, fr, pt_BR |
|---|
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A single term in the TS file.
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Add a note specifically in the appropriate comment tag
Build a native unit from a foreign unit, preserving as much information as possible.
Create the text node in parent containing all the ph tags
Returns an xml Element setup with given parameters.
Retrieves the term from the given languageNode.
Get all error messages.
| Return type: | Dictionary |
|---|
Retrieves a languageNode either by language or by index.
We override this to get source and target nodes.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is a header.
States whether this unit needs to be reviewed
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
This maps the unit “type” attribute to state.
Iterator that only returns this unit.
Module for parsing Qt .ts files for translation.
Currently this module supports the old format of .ts files. Some applictaions use the newer .ts format which are documented here: TS file format 4.3, Example
This class implements the functionality for handling plain text files, or similar wiki type files.
This class represents a text file, made up of txtunits
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Convert the units back to blocks
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Read in text lines and create txtunits from the blocks of text
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
This class represents a block of text from a text file
Adds an error message to this unit.
| Parameters: |
|---|
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the message context.
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
gets the unquoted source string
gets the unquoted target string
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Sets the definition to the quoted value of source
Sets the definition to the quoted value of target
gets the unquoted source string
gets the unquoted target string
Iterator that only returns this unit.
Manage the Universal Terminology eXchange (UTX) format
UTX is a format for terminology exchange, designed it seems with Machine Translation (MT) as it’s primary consumer. The format is created by the Asia-Pacific Association for Machine Translation (AAMT).
It is a bilingual base class derived format with UtxFile and UtxUnit providing file and unit level access.
The format can manage monolingual dictionaries but these classes don’t implement that.
Describe the properties of an UTX generated TAB-delimited dictionary file.
A UTX dictionary file
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parsese the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A UTX header entry
A UTX dictionary unit
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Build a native unit from a foreign unit, preserving as much information as possible.
Get the dictionary of values for a UTX line
Get the message context.
Get the dictionary of values for a UTX line
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Set the dictionary of values for a UTX line
| Parameters: | newdict (Dict) – a new dictionary with UTX line elements |
|---|
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Iterator that only returns this unit.
This module manages interaction with version control systems.
To implement support for a new version control system, inherit from GenericRevisionControlSystem.
the names of all supported revision control systems
modules of the same name containing a class with the same name are expected to be defined below ‘translate.storage.versioncontrol’
Bases: object
The super class for all version control classes.
Always inherit from this class to implement another RC interface.
At least the two attributes RCS_METADIR and SCAN_PARENTS must be overriden by all implementations that derive from this class.
The name of the metadata directory of the RCS
e.g.: for Subversion -> ”.svn”
Whether to check the parent directories for the metadata directory of the RCS working copy
Some revision control systems store their metadata directory only in the base of the working copy (e.g. bzr, GIT and Darcs) use True for these RCS
Other RCS store a metadata directory in every single directory of the working copy (e.g. Subversion and CVS) use False for these RCS
Dummy to be overridden by real implementations
Dummy to be overridden by real implementations
Dummy to be overridden by real implementations
Dummy to be overridden by real implementations
Commit all files below the given directory.
Files that are just symlinked into the directory are supported, too
return the class objects of all locally available version control systems
return a versioned object for the given file
return a list of objects, each pointing to a file below this directory
Runs a command (array of program name and arguments) and returns the exitcode, the output and the error as a tuple.
| Parameters: |
|---|
Update all files below the given directory.
Files that are just symlinked into the directory are supported, too
Class to manage items under revision control of bzr.
Add and commit files.
Commits the file and supplies the given commit message if present
Get a clean version of a file from the bzr repository
Does a clean update of the given path
return a tuple of (major, minor) for the installed bazaar client
check if bzr is installed
Class to manage items under revision control of CVS.
Add and commit the new files.
Commits the file and supplies the given commit message if present
the ‘author’ parameter is not suitable for CVS, thus it is ignored
Get the content of the file for the given revision
Does a clean update of the given path
check if cvs is installed
Class to manage items under revision control of darcs.
Add and commit files.
Commits the file and supplies the given commit message if present
Get a clean version of a file from the darcs repository
| Parameters: | revision – ignored for darcs |
|---|
Does a clean update of the given path
| Parameters: | revision – ignored for darcs |
|---|
check if darcs is installed
Class to manage items under revision control of git.
Add and commit the new files.
Commits the file and supplies the given commit message if present
Get a clean version of a file from the git repository
Does a clean update of the given path
check if git is installed
Return a tuple of (major, minor) for the installed mercurial client.
Class to manage items under revision control of mercurial.
Add and commit the new files.
Commits the file and supplies the given commit message if present
Get a clean version of a file from the hg repository
Does a clean update of the given path
| Parameters: | revision – ignored for hg |
|---|
check if hg is installed
return a tuple of (major, minor) for the installed subversion client
check if svn is installed
Class to manage items under revision control of Subversion.
Add and commit the new files.
commit the file and return the given message if present
the ‘author’ parameter is used for revision property ‘translate:author’
return the content of the ‘head’ revision of the file
update the working copy - remove local modifications if necessary
Manage the Wordfast Translation Memory format
Wordfast TM format is the Translation Memory format used by the Wordfast computer aided translation tool.
It is a bilingual base class derived format with WordfastTMFile and WordfastUnit providing file and unit level access.
Wordfast is a computer aided translation tool. It is an application built on top of Microsoft Word and is implemented as a rather sophisticated set of macros. Understanding that helps us understand many of the seemingly strange choices around this format including: encoding, escaping and file naming.
The implementation covers the full requirements of a Wordfast TM file. The files are simple Tab Separated Value (TSV) files that can be read by Microsoft Excel and other spreadsheet programs. They use the .txt extension which does make it more difficult to automatically identify such files.
The dialect of the TSV files is specified by WordfastDialect.
The files are UTF-16 or ISO-8859-1 (Latin1) encoded. These choices are most likely because Microsoft Word is the base editing tool for Wordfast.
The format is tab separated so we are able to detect UTF-16 vs Latin-1 by searching for the occurance of a UTF-16 tab character and then continuing with the parsing.
Wordfast TM implements a form of escaping that covers two aspects:
The tab t character as it would appear in UTF-16 encoding
Mapping of Wordfast &’XX; escapes to correct Unicode characters
Field names for a Wordfast TU
Field names for the Wordfast header
Default or minimum header entries for a Wordfast file
Time format used by Wordfast
Describe the properties of a Wordfast generated TAB-delimited file.
A wordfast translation memory header
Get the header dictionary
Get the header dictionary
A Wordfast translation memory file
alias of TranslationUnit
Add a unit to source and location idexes
Add and returns a new unit with the given source string.
| Return type: | TranslationUnit |
|---|
Append the given unit to the object’s list of units.
This method should always be used rather than trying to modify the list manually.
| Parameters: | unit (TranslationUnit) – The unit that will be added. |
|---|
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
return a list of unit ids
Get the project type for this store.
Get the source language for this store.
Get the target language for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
parsese the given file or file source string
Reads the given file (or opens the given filename) and parses back to an object.
Convert the string representation back to an object.
Remove a unit from source and locaton indexes
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
Set the project type for this store.
Set the source language for this store.
Set the target language for this store.
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
Manages time stamps in the Wordfast format of YYYYMMDD~hhmmss
Get the time_struct object
Get the time in the Wordfast time format
Set the time_struct object
| Parameters: | newtime (time.time_struct) – a new time object |
|---|
Set the time_sturct object using a Wordfast time formated string
| Parameters: | timestring (String) – A Wordfast time string (YYYMMDD~hhmmss) |
|---|
Get the time_struct object
Get the time in the Wordfast time format
A Wordfast translation memory unit
Adds an error message to this unit.
| Parameters: |
|---|
Add one location to the list of locations.
Note
Shouldn’t be implemented if the format doesn’t support it.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Adds a note (comment).
| Parameters: |
|---|
Build a native unit from a foreign unit, preserving as much information as possible.
Get the dictionary of values for a Wordfast line
Get the message context.
Get the dictionary of values for a Wordfast line
Get all error messages.
| Return type: | Dictionary |
|---|
A unique identifier for this unit.
| Return type: | string |
|---|---|
| Returns: | an identifier for this unit that is unique in the store |
Derived classes should override this in a way that guarantees a unique identifier for each unit in the store.
A list of source code locations.
| Return type: | List |
|---|
Note
Shouldn’t be implemented if the format doesn’t support it.
Returns all notes about this unit.
It will probably be freeform text or something reasonable that can be synthesised by the format. It should not include location comments (see getlocations()).
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is fuzzy.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
Indicates whether this unit needs review.
Indicates whether this unit can be translated.
This should be used to distinguish real units for translation from header, obsolete, binary or other blank units.
Make a unit obsolete
Marks the unit as fuzzy or not.
Marks the unit to indicate whether it needs review.
| Parameters: |
|
|---|
Do basic format agnostic merging.
Convert a multistring to a list of “rich” string trees:
>>> target = multistring([u'foo', u'bar', u'baz'])
>>> TranslationUnit.multistring_to_rich(target)
[<StringElem([<StringElem([u'foo'])>])>,
<StringElem([<StringElem([u'bar'])>])>,
<StringElem([<StringElem([u'baz'])>])>]
Remove all the translator’s notes.
Convert a “rich” string tree to a multistring:
>>> from translate.storage.placeables.interfaces import X
>>> rich = [StringElem(['foo', X(id='xxx', sub=[' ']), 'bar'])]
>>> TranslationUnit.rich_to_multistring(rich)
multistring(u'foo bar')
Set the message context
Set the dictionary of values for a Wordfast line
| Parameters: | newdict (Dict) – a new dictionary with Wordfast line elements |
|---|
Sets the unique identified for this unit.
only implemented if format allows ids independant from other unit properties like source or context
Iterator that only returns this unit.
A workflow is defined by a set of states that a translation unit can be in and the (allowed) transitions between these states. A state is defined by a range between -128 and 127, indicating its level of “completeness”. The range is closed at the beginning and open at the end. That is, if a workflow contains states A, B and C where A < B < C, a unit with state number n is in state A if A <= n < B, state B if B <= n < C or state C if C <= n < MAX.
A value of 0 is typically the “empty” or “new” state with negative values reserved for states like “obsolete” or “do not use”.
Format specific workflows should be defined in such a way that the numeric state values correspond to similar states. For example state 0 should be “untranslated” in PO and “new” or “empty” in XLIFF, state 100 should be “translated” in PO and “final” in XLIFF. This allows formats to implicitly define similar states.
Only contains the constants for default states.
Module for handling XLIFF files for translation.
The official recommendation is to use the extention .xlf for XLIFF files.
Class representing a XLIFF file store.
Add a unit to source and location idexes
Initialise the file header.
adds the given trans-unit to the last used body node if the filename has changed it uses the slow method instead (will create the nodes required if asked). Returns success
creates a filenode with the given filename. All parameters are needed for XLIFF compliance.
adds a group tag into the specified file
find unit with matching id by checking id_index
Find the unit with the given source string.
| Return type: | TranslationUnit or None |
|---|
Find the units with the given source string.
| Return type: | TranslationUnit or None |
|---|
finds the body node for the given filenode
Returns the datatype of the stored file. If no filename is given, the datatype of the first file is given.
Returns the date attribute for the file.
If no filename is given, the date of the first file is given. If the date attribute is not specified, None is returned.
| Returns: | Date attribute of file |
|---|---|
| Return type: | Date or None |
returns the name of the given file
returns all filenames in this XLIFF file
finds the filenode with the given name
finds the header node for the given filenode
Get the project type for this store.
Return a list of all units in this store.
Return True if the object doesn’t contain any translation units.
Indexes the items in this store. At least .sourceindex should be useful.
The matching criterion to use when merging on.
| Returns: | The default matching criterion for all the subclasses. |
|---|---|
| Return type: | string |
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Populates this object from the given xml string
Reads the given file (or opens the given filename) and parses back to an object.
Parses the string to return the correct file object
Remove a unit from source and locaton indexes
We want to remove the default file-tag as soon as possible if we know if still present and empty.
make sure source index exists
Save to the file that data was originally read from, if available.
Write the string representation to the given file (or filename).
set the name of the given file
Set the project type for this store.
xliff units have alttrans tags which can be used to store suggestions
Adds the given trans-unit (will create the nodes required if asked).
| Returns: | Success |
|---|---|
| Return type: | Boolean |
Return the translated string for a given source string.
| Return type: | String or None |
|---|
Iterator over all the units in this store.
A single term in the xliff file.
Adds an alt-trans tag and alt-trans components to the unit.
| Parameters: | txt (String) – Alternative translation of the source text. |
|---|
Adds an error message to this unit.
Add a location or a list of locations.
Note
Most classes shouldn’t need to implement this, but should rather implement TranslationUnit.addlocation().
Warning
This method might be removed in future.
Add a note specifically in a “note” tag
Build a native unit from a foreign unit, preserving as much information as possible.
Check against node tag’s origin (e.g note or alt-trans)
Create the text node in parent containing all the ph tags
Add the context group to the trans-unit with contexts a list with (type, text) tuples describing each context.
Returns an xml Element setup with given parameters.
Removes the supplied alternative from the list of alt-trans tags
Retrieves the term from the given languageNode.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns <alt-trans> for the given origin as a list of units. No origin means all alternatives.
Get the message context.
Returns the contexts in the context groups with the specified name
Get all error messages.
Retrieves a languageNode either by language or by index.
We override this to get source and target nodes.
returns the restype attribute in the trans-unit tag
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Returns the length of the target string.
| Return type: | Integer |
|---|
Note
Plural forms might be combined.
This unit in a list.
Tells whether or not this specific unit has plural strings.
Empty method that should be overridden in sub-classes to infer the current state(_n) of the unit from its current state.
States whether this unit is approved.
Used to see if this unit has no source or target string.
Note
This is probably used more to find translatable units, and we might want to move in that direction rather and get rid of this.
Indicates whether this unit is a header.
indicate whether a unit is obsolete
States whether this unit needs to be reviewed
Indicates whether this unit is translated.
This should be used rather than deducing it from .target, to ensure that other classes can implement more functionality (as XLIFF does).
Make a unit obsolete
Mark this unit as approved.
Marks the unit to indicate whether it needs review.
Adds an optional explanation as a note.
Override TranslationUnit.multistring_to_rich() which is used by the rich_source and rich_target properties.
Returns name in Clark notation.
For example namespaced("source") in an XLIFF document might return:
{urn:oasis:names:tc:xliff:document:1.1}source
This is needed throughout lxml.
Remove all the translator notes.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Override TranslationUnit.rich_to_multistring() which is used by the rich_source and rich_target properties.
Set the message context
Sets the target string to the given value.
retrieves the “target” text (second entry), or the entry in the specified language, if it exists
Iterator that only returns this unit.
Maintain constants and variables used during the walking of a DOM tree (via the function apply).
A node corresponds to a translatable element. A node may have children, which correspond to placeables.
Utility function for loading xml_filename
See also
For an inline placeable, find the root DOM node for the placeable in its parent.
Consider the diagram. In this pseudo-ODF example, there is an inline span element. However, the span is contained in other tags (which we never process). When splicing the template DOM tree (that is, the DOM which comes from the XML document we’re using to generate a translated XML document), we’ll need to move DOM sub-trees around and we need the roots of these sub-trees:
<p> This is text \/ <- Paragraph containing an inline placeable
<blah> <- Inline placeable's root (which we want to find)
... <- Any number of intermediate DOM nodes
<span> bold text <- The inline placeable's Translatable
holds a reference to this DOM node
Return a function:
action: etree_Element x base.TranslationUnit -> None
which takes a dom_node and a translation unit. The dom_node is rearranged according to rearrangement of placeables in unit.target (relative to their positions in unit.source).
Given two mappings left: A -> B and right: B -> C, create a hash result_map: A -> C. Only values in left (i.e. things from B) which have corresponding keys in right will have their keys mapped to values in right.
>>> parse_tag('{urn:oasis:names:tc:opendocument:xmlns:office:1.0}document-content')
('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'document-content')
Enumerate a tree, applying f to in a pre-order fashion to each node.
parent_unit_node contains the parent of unit_node. For the root of the tree, parent_unit_node == unit_node.
get_children is a single argument function applied to a unit_node to get a list/iterator to its children.
state is used by f to modify state information relating to whatever f does to the tree.
Enumerate a translation store and build a tree with XPath components as nodes and where a node contains a unit if a path from the root of the tree to the node containing the unit, is equal to the XPath of the unit.
The tree looks something like this:
root
`- ('document-content', 1)
`- ('body', 2)
|- ('text', 1)
| `- ('p', 1)
| `- <reference to a unit>
|- ('text', 2)
| `- ('p', 1)
| `- <reference to a unit>
`- ('text', 3)
`- ('p', 1)
`- <reference to a unit>
A class which is used to build XPath-like paths as a DOM tree is walked. It keeps track of the number of times which it has seen a certain tag, so that it will correctly create indices for tags.
Initially, the path is empty. Thus >>> xb = XPathBreadcrumb() >>> xb.xpath “”
Suppose we walk down a DOM node for the tag <foo> and we want to record this, we simply do >>> xb.start_tag(‘foo’)
Now, the path is no longer empty. Thus >>> xb.xpath foo[0]
Now suppose there are two <bar> tags under the tag <foo> (that is <foo><bar></bar><bar></bar><foo>), then the breadcrumb will keep track of the number of times it sees <bar>. Thus
>>> xb.start_tag('bar')
>>> xb.xpath
foo[0]/bar[0]
>>> xb.end_tag()
>>> xb.xpath
foo[0]
>>> xb.start_tag('bar')
>>> xb.xpath
foo[0]/bar[1]
Initialize me with a DOM node or a DOM document node (the toplevel node you get when parsing an XML file). Then use me to generate fully qualified XML names.
>>> xml = '<office:document-styles xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"></office>'
>>> from lxml import etree
>>> namer = XmlNamer(etree.fromstring(xml))
>>> namer.name('office', 'blah')
{urn:oasis:names:tc:opendocument:xmlns:office:1.0}blah
>>> namer.name('office:blah')
{urn:oasis:names:tc:opendocument:xmlns:office:1.0}blah
I can also give you XmlNamespace objects if you give me the abbreviated namespace name. These are useful if you need to reference a namespace continuously.
>>> office_ns = name.namespace('office')
>>> office_ns.name('foo')
{urn:oasis:names:tc:opendocument:xmlns:office:1.0}foo
This module provides functionality to work with zip files.
This class represents a ZIP file like a directory.
Iterator over (dir, filename) for all files in this directory.
Returns a list of (dir, filename) tuples for all the file names in this directory.
List of all the units in all the files in this directory.
Populate the internal file data.
Iterator over all the units in all the files in this zip file.