Getting SVN revision number into a program automatically

Question

I have a python project under SVN, and I'm wanting to display the version number when it is run. Is there any way of doing this (such as automatically running a short script on commit which could update a version file, or querying an SVN repository in Python?)

Solution 1

I'm not sure about the Python specifics, but if put the string $Revision$ into your file somewhere and you have enable-auto-props=true in your SVN config, it'll get rewritten to something like $Revision: 144$. You could then parse this in your script.

There are a number of property keywords you can use in this way.

This won't have any overhead, e.g. querying the SVN repo, because the string is hard-coded into your file on commit or update.

I'm not sure how you'd parse this in Python but in PHP I'd do:

$revString = '$Revision: 144$';
if(preg_match('/: ([0-9]+)\$/', $revString, $matches) {
    echo 'Revision is ' . $matches[1];
}

Solution 2

Similar to, but a little more pythonic than the PHP answer; put this in your module's __init__.py:

__version__ = filter(str.isdigit, "$Revision: 13 $")

and make sure you add the Revision property:

svn propset svn:keywords Revision __init__.py

Solution 3

Or you can do like this:

import re,subprocess

svn_info = subprocess.check_output("svn info")

print (re.search(ur"Revision:\s\d+", svn_info)).group()

it prints "Revision: 2874" in my project

Or like this:

print (subprocess.check_output("svnversion")).split(":")[0]

it prints "2874" in my project

Edit

For newer python versions (>=3.4) and for explicit file path:

import re,subprocess

file_path = 'c:/foo'

svn_info = subprocess.check_output('svn info ' + file_path)

revision_string = re.search(r"Revision:\s\d+", str(svn_info)).group()
revision = revision_string.split(': ')[1]
print(revision)

Prints for example

'8623'

Solution 4

There's a snippet of code in Django that allows you to do this, I'd recommend looking at it. http://code.djangoproject.com/browser/django/trunk/django/utils/version.py

Solution 5

The file hooks/pre-commit in your repository is a script or program which will be executed before a successful commit. Simply make this a script which updates your file with the proper version number as it is being committed (the revision number is passed to your script as it's run). Here's a tutorial with an example of writing a pre-commit hook: http://wordaligned.org/articles/a-subversion-pre-commit-hook

View more solutions

Comments

[Eli Courtwright]

This function only works when you're running from within a subversion checkout. If this is what the OP wants, then problem solved. However, I suspect he may want the script to have contained within itself or a config file or something its subversion revision, even if the script is no longer under subversion, in which case that link won't be useful.

[sunny256]

Ouch. Letting the pre-commit hook modify files is generally a bad idea. The version in the repo will be different from the version in the working copy, and this may lead to some confusion. The committer has to revert to an earlier version of the file, and then get the new one, probably resulting in some kind of conflict, as svn has stored the original version in the text-base of the working copy.

[Eli Courtwright]

I agree that this is dangerous and not usually a desired behavior, but if you limit yourself appropriately, then I don't see the problem. For example, if you have a "svn_version.txt" file that contains nothing but the current revision number, then it would be perfectly safe; your local copy would always have the version which you've checked out and the repository would always have the latest (often the same as your working copy).

[Smashery]

Yeah, this is great fallback option, but having the version number also under source control would be better. Thanks! +1

[Drew Hall]

This is the right answer! Also, remember to set the property 'keywords=Revision' on each file you want to do this to.

[Ciaran McNulty]

Drew - I think if enable-auto-props=true is set, then the default keywords are all set?

[Smashery]

+1 That's awesome! In my case, though, is there a way to have SVN edit the revision number if it's a different file that was changed in this revision? For instance, if I have the revision number keyword in version.py, but I don't change version.py in revision nnn, it won't update it, will it? If not, is there a way to use this method in that way?

[Ciaran McNulty]

@Smashery I'm afraid you'd have to write your own commit hook to do that I suspect - you could use the svn:keywords property though by setting your own keyword and letting SVN do the substitution for you.

[orip]

That will only work on the file(s) being committed. We handle it in the build script, easy to do.

[Tal Weiss]

or ''.join(c for c in "$LastChangedRevision: 1546 $" if c.isdigit()) if you don't like filter.

[German Petrov]

Not only with working copy. You can retrieve svn remote URL from "svn info" first, like execute "svn info", then take "URL" param value from the output and execute same code, but using "svn info value_of_URL_param" So, updated code is: import re,subprocess svn_info = subprocess.check_output("svn info svn.you_remote_repo_url") print (re.search(ur"Revision:\s\d+", svn_info)).group()

[tzg]

I get an invalid syntax error on your print statement. print (re.search(ur"Revision:\s\d+", svn_info)).group()

[fiorentinoing]

I would add a 'strip()' to avoid unexpected spaces

[Stefan]

a) Use r instead of ur before strings since python 3.4: stackoverflow.com/questions/26063899/… b)Wrap binary string in str()