Merge lp:~xnox/bzr/bug.569934 into lp:bzr

[Dimitri John Ledkov]

version-info rio parser has a hook. Plugins such as bzr-svn hook into that to add additional information about revisions. python parser doesn't have a hook, and you shouldn't expect plugin writters to hook into every single parsers. This branch changes python parser to use rio parser to get revision information including stuff added by hooks.

For example see bug #569934.

[Vincent Ladeuil (vila)]

Design-wise, the approach sounds fine, yet, I don't understand why you delete the 'revisions' and 'file-revisions' only to let the existing code re-create them (in much the same way that the base class does).

Two tests are failing with your patch, you can avoid running the whole test suite
by using:
 './bzr selftest -s bt.test_version'

Note that since this formatter is for python we may want to preserve revno being an int (so you may have to convert it from the rio string).

Finally, we need you sign the contributor agreement to accept your patch, see http://www.canonical.com/contributors, thanks for giving it a look.

review: Needs Fixing

Unmerged revisions

5185. By Dimitri John Ledkov on 2010-04-26

version_info python formater now uses RioFormatter to get info from additional hooks, e.g. svn-revno

=== modified file 'bzrlib/version_info_formats/format_python.py'
--- bzrlib/version_info_formats/format_python.py	2009-04-03 21:23:55 +0000
+++ bzrlib/version_info_formats/format_python.py	2010-04-26 01:30:33 +0000
@@ -17,21 +17,23 @@
 """A generator which creates a python script from the current tree info"""
 
 import pprint
+import cStringIO as StringIO
 
 from bzrlib.revision import (
     NULL_REVISION,
     )
-from bzrlib.version_info_formats import (
-    create_date_str,
-    VersionInfoBuilder,
+from bzrlib.version_info_formats.format_rio import RioVersionInfoBuilder
+from bzrlib.rio import (
+    RioReader,
+    read_stanza,
+    read_stanza_unicode,
     )
 
-
 # Header and footer for the python format
 _py_version_header = '''#!/usr/bin/env python
 """This file is automatically generated by generate_version_info
 It uses the current working tree to determine the revision.
-So don't edit it. :)
+So do not edit it. :)
 """
 
 '''
@@ -40,42 +42,25 @@
 _py_version_footer = '''
 
 if __name__ == '__main__':
-    print 'revision: %(revno)d' % version_info
-    print 'nick: %(branch_nick)s' % version_info
-    print 'revision id: %(revision_id)s' % version_info
+
+    for key in version_info:
+        print key + ': ' + version_info[key]
 '''
 
 
-class PythonVersionInfoBuilder(VersionInfoBuilder):
+class PythonVersionInfoBuilder(RioVersionInfoBuilder):
     """Create a version file which is a python source module."""
 
     def generate(self, to_file):
-        info = {'build_date':create_date_str()
-                  , 'revno':None
-                  , 'revision_id':None
-                  , 'branch_nick':self._branch.nick
-                  , 'clean':None
-                  , 'date':None
-        }
-        revisions = []
-
-        revision_id = self._get_revision_id()
-        if revision_id == NULL_REVISION:
-            info['revno'] = 0
-        else:
-            info['revno'] = self._branch.revision_id_to_revno(revision_id)
-            info['revision_id'] = revision_id
-            rev = self._branch.repository.get_revision(revision_id)
-            info['date'] = create_date_str(rev.timestamp, rev.timezone)
-
-        if self._check or self._include_file_revs:
-            self._extract_file_revisions()
-
-        if self._check:
-            if self._clean:
-                info['clean'] = True
-            else:
-                info['clean'] = False
+        rio = StringIO.StringIO()
+        RioVersionInfoBuilder.generate(self, rio)
+        stanzas = read_stanza(rio.getvalue().splitlines(True))
+        info = stanzas.as_dict()
+
+        if info.has_key('revisions'):
+            del(info['revisions'])
+        if info.has_key('file-revisions'):
+            del(info['file-revisions'])
 
         info_str = pprint.pformat(info)
         to_file.write(_py_version_header)
@@ -101,6 +86,3 @@
             to_file.write('file_revisions = {}\n\n')
 
         to_file.write(_py_version_footer)
-
-
-