Edgewall Software
Please note:

The documentation here is generated live, in a way that is neither comprehensive nor 100% correct. We strongly recommend using the HTML documentation included with the source tarballs instead.

babel.messages.extract

Basic infrastructure for extracting localizable messages from source files.

This module defines an extensible system for collecting localizable message strings from a variety of sources. A native extractor for Python source files is builtin, extractors for other sources can be added using very simple plugins.

The main entry points into the extraction functionality are the functions extract_from_dir and extract_from_file.

extract_from_dir(dirname=osgetcwd, method_map=DEFAULT_MAPPING, options_map=None, keywords=DEFAULT_KEYWORDS, comment_tags=, callback=None)

Extract messages from any source files found in the given directory.

This function generates tuples of the form:

(filename, lineno, message, comments)

Which extraction method is used per file is determined by the method_map parameter, which maps extended glob patterns to extraction method names. For example, the following is the default mapping:

>>> method_map = [
...     ('**.py', 'python')
... ]

This basically says that files with the filename extension ".py" at any level inside the directory should be processed by the "python" extraction method. Files that don't match any of the mapping patterns are ignored. See the documentation of the pathmatch function for details on the pattern syntax.

The following extended mapping would also use the "genshi" extraction method on any file in "templates" subdirectory:

>>> method_map = [
...     ('**/templates/**.*', 'genshi'),
...     ('**.py', 'python')
... ]

The dictionary provided by the optional options_map parameter augments these mappings. It uses extended glob patterns as keys, and the values are dictionaries mapping options names to option values (both strings).

The glob patterns of the options_map do not necessarily need to be the same as those used in the method mapping. For example, while all files in the templates folders in an application may be Genshi applications, the options for those files may differ based on extension:

>>> options_map = {
...     '**/templates/**.txt': {
...         'template_class': 'genshi.template:TextTemplate',
...         'encoding': 'latin-1'
...     },
...     '**/templates/**.html': {
...         'include_attrs': ''
...     }
... }
param dirname:the path to the directory to extract messages from
param method_map:
 a list of (pattern, method) tuples that maps of extraction method names to extended glob patterns
param options_map:
 a dictionary of additional options (optional)
param keywords:a dictionary mapping keywords (i.e. names of functions that should be recognized as translation functions) to tuples that specify which of their arguments contain localizable strings
param comment_tags:
 a list of tags of translator comments to search for and include in the results
param callback:a function that is called for every file that message are extracted from, just before the extraction itself is performed; the function is passed the filename, the name of the extraction method and and the options dictionary as positional arguments, in that order
return:an iterator over (filename, lineno, funcname, message) tuples
rtype:iterator
see:pathmatch

extract_from_file(method, filename, keywords=DEFAULT_KEYWORDS, comment_tags=, options=None)

Extract messages from a specific file.

This function returns a list of tuples of the form:

(lineno, funcname, message)
param filename:the path to the file to extract messages from
param method:a string specifying the extraction method (.e.g. "python")
param keywords:a dictionary mapping keywords (i.e. names of functions that should be recognized as translation functions) to tuples that specify which of their arguments contain localizable strings
param comment_tags:
 a list of translator tags to search for and include in the results
param options:a dictionary of additional options (optional)
return:the list of extracted messages
rtype:list

extract(method, fileobj, keywords=DEFAULT_KEYWORDS, comment_tags=, options=None)

Extract messages from the given file-like object using the specified extraction method.

This function returns a list of tuples of the form:

(lineno, message, comments)

The implementation dispatches the actual extraction to plugins, based on the value of the method parameter.

>>> source = '''# foo module
... def run(argv):
...    print _('Hello, world!')
... '''
>>> from StringIO import StringIO
>>> for message in extract('python', StringIO(source)):
...     print message
(3, u'Hello, world!', [])
param method:a string specifying the extraction method (.e.g. "python")
param fileobj:the file-like object the messages should be extracted from
param keywords:a dictionary mapping keywords (i.e. names of functions that should be recognized as translation functions) to tuples that specify which of their arguments contain localizable strings
param comment_tags:
 a list of translator tags to search for and include in the results
param options:a dictionary of additional options (optional)
return:the list of extracted messages
rtype:list
raise ValueError:
 if the extraction method is not registered

extract_nothing(fileobj, keywords, comment_tags, options)

Pseudo extractor that does not actually extract anything, but simply returns an empty list.

extract_python(fileobj, keywords, comment_tags, options)

Extract messages from Python source code.

param fileobj:the seekable, file-like object the messages should be extracted from
param keywords:a list of keywords (i.e. function names) that should be recognized as translation functions
param comment_tags:
 a list of translator tags to search for and include in the results
param options:a dictionary of additional options (optional)
return:an iterator over (lineno, funcname, message, comments) tuples
rtype:iterator


See ApiDocs/0.8, Documentation

Last modified 15 months ago Last modified on Dec 10, 2015 6:25:47 AM