1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
3 # This file is part of Hooke.
5 # Hooke is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
13 # Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke. If not, see
17 # <http://www.gnu.org/licenses/>.
19 """The hooke module does all the legwork for Hooke_.
21 .. _hooke: http://code.google.com/p/hooke/
23 To facilitate faster loading, submodules are not imported by default.
24 The available submodules are:
30 from .license import LICENSE as __license__
31 except ImportError, e:
33 logging.warn('could not load LICENSE from hooke.license')
34 __license__ = 'All rights reserved.'
36 from .util import yaml # extend YAML to parse Hooke-specific items.
38 __version__ = (1, 0, 0, 'alpha', None, 'Ninken')
41 (major, minor, release, type, patch, name)
45 * type: Python uses alpha, beta, candidate, and final. Whatever
46 so long as the alphabetic sort gets them in the right order.
47 * patch: either manually incremented for each release, the packaging
48 date string, YYYYMMDD, date of last commit, whatever.
50 See `Greg Noel's post on scons-devel`_ for a good explaination of why this
51 versioning scheme is a good idea.
53 .. _Greg Noel's post on scons-devel
54 http://thread.gmane.org/gmane.comp.programming.tools.scons.devel/8740
57 def version(depth=-1, version_tuple=None):
58 """Return a nicely formatted version string.::
60 major.minor.release.type[.patch] (name)
65 Since I seem to be unable to override __version__ in a Doctest,
66 we'll pass the version tuple in as an argument. You can ignore
69 >>> v = (1, 2, 3, 'devel', '20100501', 'Kenzo')
71 If depth -1, a full version string is returned
73 >>> version(depth=-1, version_tuple=v)
74 '1.2.3.devel.20100501 (Kenzo)'
76 Otherwise, only the first depth fields are used.
78 >>> version(depth=3, version_tuple=v)
80 >>> version(depth=4, version_tuple=v)
83 Here's an example dropping the patch.
85 >>> v = (1, 2, 3, 'devel', None, 'Kenzo')
86 >>> version(depth=-1, version_tuple=v)
89 if version_tuple == None:
90 version_tuple = __version__
92 if version_tuple[patch_index] == None: # No patch field, drop that entry
93 version_tuple = version_tuple[0:patch_index] \
94 + version_tuple[patch_index+1:]
95 if depth >= patch_index:
97 fields = version_tuple[0:depth]
98 string = '.'.join([str(x) for x in fields])
99 if depth == -1 or depth == len(version_tuple):
100 string += ' (%s)' % version_tuple[-1]