and one more doctest for all

isnok · isnok · commit a7e02d10c891 · 2016-04-09T01:07:31.000+02:00
diff --git a/base/versioning.py b/base/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/git/versioning.py b/git/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/gitflow/versioning.py b/gitflow/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/githooks/versioning.py b/githooks/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/hooks-demo/versioning.py b/hooks-demo/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/meta/versioning.py b/meta/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/pythonic/versioning.py b/pythonic/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/release/versioning.py b/release/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/stages/versioning.py b/stages/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
diff --git a/versioning/flowtool_versioning/dropins/cmdclass.py b/versioning/flowtool_versioning/dropins/cmdclass.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
diff --git a/versioning/versioning.py b/versioning/versioning.py
@@ -53,7 +53,11 @@ def find_parent_containing(name, path=None, check='exists'):
         return find_parent_containing(name, path=alternative, check=check)
 
 def read_config(filename):
-    """Read the project setup.cfg file to determine versioning config."""
+    """ Read the project setup.cfg file to determine versioning config.
+
+        >>> hasattr(read_config(''), 'get')
+        True
+    """
     # This might raise EnvironmentError (if setup.cfg is missing), or
     # configparser.NoSectionError (if it lacks a [versioneer] section), or
     # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
@@ -138,6 +142,13 @@ def run(self):
         print('== Version-Info:\n%s' % pformat(version_in_git.VERSION_INFO))
 
 def bump_version(info):
+    """ Bump a parsed version.
+
+        >>> bump_version({'release':(8, 1)})
+        {'release': (8, 2)}
+        >>> bump_version({'release':(8, 1), 'post_release':0})['post_release']
+        1
+    """
     if 'dev_release' in info:
         info['dev_release'] += 1
     elif 'post_release' in info:
@@ -194,6 +205,7 @@ def run(self):
         print('== Tagging: %s' % tag)
         os.system('git tag ' + tag)
 
+
 class cmd_update_versionfile(Command):
     description = "update the versioning"
     user_options = []
