babel/mirror: babel/messages/extract.py comparison

comparison babel/messages/extract.py @ 569:1b801a0cb2cb trunk

Support for context-aware methods during message extraction (fixes #229, patch by David Rios)

author	fschwarz
date	Mon, 26 Sep 2011 20:01:01 +0000
parents	86524be05b60
children	99983baf1067

comparison

equal deleted inserted replaced

-:39ff5164e8ea
+:1b801a0cb2cb
 'ngettext': (1, 2),
 'ugettext': None,
 'ungettext': (1, 2),
 'dgettext': (2,),
 'dngettext': (2, 3),
-'N_': None
+'N_': None,
+'pgettext': ((1, 'c'), 2)
 }
 DEFAULT_MAPPING = [('**.py', 'python')]
 empty_msgid_warning = (
 performed; the function is passed the filename, the name
 of the extraction method and and the options dictionary as
 positional arguments, in that order
 :param strip_comment_tags: a flag that if set to `True` causes all comment
 tags to be removed from the collected comments.
-:return: an iterator over ``(filename, lineno, funcname, message)`` tuples
+:return: an iterator over ``(filename, lineno, funcname, message, context)``
+tuples
 :rtype: ``iterator``
 :see: `pathmatch`
 """
 if options_map is None:
 options_map = {}
 for opattern, odict in options_map.items():
 if pathmatch(opattern, filename):
 options = odict
 if callback:
 callback(filename, method, options)
-for lineno, message, comments in \
+for lineno, message, comments, context in \
 extract_from_file(method, filepath,
 keywords=keywords,
 comment_tags=comment_tags,
 options=options,
 strip_comment_tags=
 strip_comment_tags):
-yield filename, lineno, message, comments
+yield filename, lineno, message, comments, context
 break
 def extract_from_file(method, filename, keywords=DEFAULT_KEYWORDS,
 comment_tags=(), options=None, strip_comment_tags=False):
 ... '''
 >>> from StringIO import StringIO
 >>> for message in extract('python', StringIO(source)):
 ...     print message
-(3, u'Hello, world!', [])
+(3, u'Hello, world!', [], None)
 :param method: a string specifying the extraction method (.e.g. "python");
 if this is a simple name, the extraction function will be
 looked up by entry point; if it is an explicit reference
 to a function (of the form ``package.module:funcname`` or
 messages = [messages]
 if not messages:
 continue
 # Validate the messages against the keyword's specification
+context = None
 msgs = []
 invalid = False
 # last_index is 1 based like the keyword spec
 last_index = len(messages)
 for index in spec:
+if isinstance(index, tuple):
+context = messages[index[0] - 1]
+continue
 if last_index < index:
 # Not enough arguments
 invalid = True
 break
 message = messages[index - 1]
 break
 msgs.append(message)
 if invalid:
 continue
-first_msg_index = spec[0] - 1
+# keyword spec indexes are 1 based, therefore '-1'
+if isinstance(spec[0], tuple):
+# context-aware *gettext method
+first_msg_index = spec[1] - 1
+else:
+first_msg_index = spec[0] - 1
 if not messages[first_msg_index]:
 # An empty string msgid isn't valid, emit a warning
 where = '%s:%i' % (hasattr(fileobj, 'name') and \
 fileobj.name or '(unknown)', lineno)
 print >> sys.stderr, empty_msgid_warning % where
 if len(messages) == 1:
 messages = messages[0]
 if strip_comment_tags:
 _strip_comment_tags(comments, comment_tags)
-yield lineno, messages, comments
+yield lineno, messages, comments, context
 def extract_nothing(fileobj, keywords, comment_tags, options):
 """Pseudo extractor that does not actually extract anything, but simply
 returns an empty list.

Mercurial > babel > mirror

comparison babel/messages/extract.py @ 569:1b801a0cb2cb trunk