Updated copyright blurbs in all files to '# Copyright'

[hooke.git] / hooke / __init__.py

diff --git a/hooke/__init__.py b/hooke/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..ed8eb58e3340ee642a79ee0c4d51bb7eebf017af 100644 (file)
--- a/hooke/__init__.py
+++ b/hooke/__init__.py
@@ -0,0 +1,77 @@
+# Copyright
+
+"""The hooke module does all the legwork for Hooke_.
+
+.. _hooke: http://code.google.com/p/hooke/
+
+To facilitate faster loading, submodules are not imported by default.
+The available submodules are:
+
+* :mod:`hooke.config`
+* :mod:`hooke.compat`
+"""
+
+__version__ = (0, 9, 0, 'devel', None, 'Kenzo')
+"""Version tuple::
+
+    (major, minor, release, type, patch, name)
+
+Where 
+
+  * type: Python uses alpha, beta, candidate, and final.  Whatever
+    so long as the alphabetic sort gets them in the right order.
+  * patch: either manually incremented for each release, the packaging
+    date string, YYYYMMDD, date of last commit, whatever.
+
+See `Greg Noel's post on scons-devel`_ for a good explaination of why this
+versioning scheme is a good idea.
+
+.. _Greg Noel's post on scons-devel
+  http://thread.gmane.org/gmane.comp.programming.tools.scons.devel/8740
+"""
+
+def version(depth=-1, version_tuple=None):
+    """Return a nicely formatted version string.::
+
+        major.minor.release.type[.patch] (name)
+
+    Examples
+    --------
+
+    Since I seem to be unable to override __version__ in a Doctest,
+    we'll pass the version tuple in as an argument.  You can ignore
+    `version_tuple`.
+
+    >>> v = (1, 2, 3, 'devel', '20100501', 'Kenzo')
+
+    If depth -1, a full version string is returned
+
+    >>> version(depth=-1, version_tuple=v)
+    '1.2.3.devel.20100501 (Kenzo)'
+
+    Otherwise, only the first depth fields are used.
+
+    >>> version(depth=3, version_tuple=v)
+    '1.2.3'
+    >>> version(depth=4, version_tuple=v)
+    '1.2.3.devel'
+
+    Here's an example dropping the patch.
+
+    >>> v = (1, 2, 3, 'devel', None, 'Kenzo')
+    >>> version(depth=-1, version_tuple=v)
+    '1.2.3.devel (Kenzo)'
+    """
+    if version_tuple == None:
+        version_tuple = __version__
+    patch_index = 4
+    if version_tuple[patch_index] == None: # No patch field, drop that entry
+        version_tuple = version_tuple[0:patch_index] \
+            + version_tuple[patch_index+1:]
+        if depth >= patch_index:
+            depth -= 1
+    fields = version_tuple[0:depth]
+    string = '.'.join([str(x) for x in fields])
+    if depth == -1 or depth == len(version_tuple):
+        string += ' (%s)' % version_tuple[-1]
+    return string