Changeset 4787

Timestamp:

Nov 5, 2007, 3:24:05 PM (17 years ago)

Author:

ole

Message:

Moved version functions to system_tools

Location:

anuga_core

Files:

• documentation/user_manual/update_anuga_user_manual.py (modified) (1 diff)
• documentation/user_manual/version.tex (modified) (1 diff)
• source/anuga/abstract_2d_finite_volumes/util.py (modified) (4 diffs)
• source/anuga/utilities/system_tools.py (modified) (1 diff)

anuga_core/documentation/user_manual/update_anuga_user_manual.py

@@ -31 +31 @@
 from os import system, chdir
 from os.path import expanduser
-from anuga.abstract_2d_finite_volumes.util import get_revision_number
+from anuga.utilities.system_tools import get_revision_number
 from anuga.anuga_config import major_revision
 from sys import argv

anuga_core/documentation/user_manual/version.tex

@@ -7 +7 @@
 % release version; this is used to define the
 % \version macro
-\release{1.0beta\_4785}
+\release{1.0beta\_4786}

anuga_core/source/anuga/abstract_2d_finite_volumes/util.py

@@ -18 +18 @@
     
 from anuga.geospatial_data.geospatial_data import ensure_absolute
+
+
+
+# FIXME (Ole): Temporary short cuts - remove and update scripts where they are used
+from anuga.utilities.system_tools import get_revision_number
+from anuga.utilities.system_tools import store_version_info
+
 
 def file_function(filename,
@@ -564 +571 @@
                          print_to_screen=False, verbose=False)
 
-def get_revision_number():
-    """Get the version number of the SVN
-    NOTE: This requires that the command svn is on the system PATH
-    (simply aliasing svn to the binary will not work)
-    """
-
-    # Create dummy info 
-    #info = 'Revision: Version info could not be obtained.'
-    #info += 'A command line version of svn must be availbable '
-    #info += 'on the system PATH, access to the subversion '
-    #info += 'repository is necessary and the output must '
-    #info += 'contain a line starting with "Revision:"'
-    
-
-    #FIXME (Ole): Change this so that svn info is attempted first.
-    # If that fails, try to read a stored file with that same info (this would be created by e.g. the release script). Failing that, throw an exception.
-
-    #FIXME (Ole): Move this and store_version_info to utilities
-
-
-    try:
-        from anuga.stored_version_info import version_info
-    except:
-        msg = 'No version info stored and command "svn" is not '
-        msg += 'recognised on the system PATH.\n\n'
-        msg += 'If ANUGA has been installed from a distribution e.g. as '
-        msg += 'obtained from SourceForge,\n'
-        msg += 'the version info should be '
-        msg += 'available in the automatically generated file '
-        msg += 'stored_version_info.py\n'
-        msg += 'in the anuga root directory.\n'
-        msg += 'If run from a Subversion sandpit, '
-        msg += 'ANUGA will try to obtain the version info '
-        msg += 'by using the command: "svn info".\n'
-        msg += 'In this case, make sure svn is accessible on the system path. '
-        msg += 'Simply aliasing svn to the binary will not work. '
-        msg += 'Good luck!'
-
-        # No file available - try using Subversion
-        try:
-            # The null stuff is so this section fails quitly.
-            # This could cause the svn info command to fail due to
-            # the redirection being bad on some platforms.
-            # If that occurs then change this code.
-            if sys.platform[0:3] == 'win':
-                fid = os.popen('svn info 2> null')
-            else:
-                fid = os.popen('svn info 2>/dev/null')
-        
-        except:
-            raise Exception(msg)
-        else:
-            #print 'Got version from svn'            
-            version_info = fid.read()
-            
-            if version_info == '':
-                raise Exception(msg)    
-    else:
-        pass
-        #print 'Got version from file'
-
-            
-    for line in version_info.split('\n'):
-        if line.startswith('Revision:'):
-            break
-
-    fields = line.split(':')
-    msg = 'Keyword "Revision" was not found anywhere in text: %s' %version_info
-    assert fields[0].startswith('Revision'), msg            
-
-    try:
-        revision_number = int(fields[1])
-    except:
-        msg = 'Revision number must be an integer. I got %s' %fields[1]
-        msg += 'Check that the command svn is on the system path' 
-        raise Exception(msg)                
-        
-    return revision_number
-
-
-def store_version_info(destination_path='.', verbose=False):
-    """Obtain current version from Subversion and store it.
-    
-    Title: store_version_info()
-
-    Author: Ole Nielsen (Ole.Nielsen@ga.gov.au)
-
-    CreationDate: January 2006
-
-    Description:
-        This function obtains current version from Subversion and stores it
-        is a Python file named 'stored_version_info.py' for use with
-        get_version_info()
-
-        If svn is not available on the system PATH, an Exception is thrown
-    """
-
-    # Note (Ole): This function should not be unit tested as it will only
-    # work when running out of the sandpit. End users downloading the
-    # ANUGA distribution would see a failure.
-    #
-    # FIXME: This function should really only be used by developers (
-    # (e.g. for creating new ANUGA releases), so maybe it should move
-    # to somewhere else.
-    
-    import config
-
-    try:
-        fid = os.popen('svn info')
-    except:
-        msg = 'Command "svn" is not recognised on the system PATH'
-        raise Exception(msg)
-    else:    
-        txt = fid.read()
-        fid.close()
-
-
-        # Determine absolute filename
-        if destination_path[-1] != os.sep:
-            destination_path += os.sep
-            
-        filename = destination_path + config.version_filename
-
-        fid = open(filename, 'w')
-
-        docstring = 'Stored version info.\n\n'
-        docstring += 'This file provides the version for distributions '
-        docstring += 'that are not accessing Subversion directly.\n'
-        docstring += 'The file is automatically generated and should not '
-        docstring += 'be modified manually.\n'
-        fid.write('"""%s"""\n\n' %docstring)
-        
-        fid.write('version_info = """\n%s"""' %txt)
-        fid.close()
-
-
-        if verbose is True:
-            print 'Version info stored to %s' %filename
-            
-    
+
 def sww2timeseries(swwfiles,
                    gauge_filename,
@@ -1928 +1796 @@
 
 
+
 def get_runup_data_for_locations_from_file(gauge_filename,
                                            sww_filename,
@@ -1978 +1847 @@
         file.write(temp)
         file.close()
+
+
+            
+
+    
+        

anuga_core/source/anuga/utilities/system_tools.py

@@ -31 +31 @@
 
     return host    
+
+def get_revision_number():
+    """Get the version number of the SVN
+    NOTE: This requires that the command svn is on the system PATH
+    (simply aliasing svn to the binary will not work)
+    """
+
+    # Create dummy info 
+    #info = 'Revision: Version info could not be obtained.'
+    #info += 'A command line version of svn must be availbable '
+    #info += 'on the system PATH, access to the subversion '
+    #info += 'repository is necessary and the output must '
+    #info += 'contain a line starting with "Revision:"'
+    
+
+    #FIXME (Ole): Change this so that svn info is attempted first.
+    # If that fails, try to read a stored file with that same info (this would be created by e.g. the release script). Failing that, throw an exception.
+
+    #FIXME (Ole): Move this and store_version_info to utilities
+
+
+    try:
+        from anuga.stored_version_info import version_info
+    except:
+        msg = 'No version info stored and command "svn" is not '
+        msg += 'recognised on the system PATH.\n\n'
+        msg += 'If ANUGA has been installed from a distribution e.g. as '
+        msg += 'obtained from SourceForge,\n'
+        msg += 'the version info should be '
+        msg += 'available in the automatically generated file '
+        msg += 'stored_version_info.py\n'
+        msg += 'in the anuga root directory.\n'
+        msg += 'If run from a Subversion sandpit, '
+        msg += 'ANUGA will try to obtain the version info '
+        msg += 'by using the command: "svn info".\n'
+        msg += 'In this case, make sure svn is accessible on the system path. '
+        msg += 'Simply aliasing svn to the binary will not work. '
+        msg += 'Good luck!'
+
+        # No file available - try using Subversion
+        try:
+            # The null stuff is so this section fails quitly.
+            # This could cause the svn info command to fail due to
+            # the redirection being bad on some platforms.
+            # If that occurs then change this code.
+            if sys.platform[0:3] == 'win':
+                fid = os.popen('svn info 2> null')
+            else:
+                fid = os.popen('svn info 2>/dev/null')
+        
+        except:
+            raise Exception(msg)
+        else:
+            #print 'Got version from svn'            
+            version_info = fid.read()
+            
+            if version_info == '':
+                raise Exception(msg)    
+    else:
+        pass
+        #print 'Got version from file'
+
+            
+    for line in version_info.split('\n'):
+        if line.startswith('Revision:'):
+            break
+
+    fields = line.split(':')
+    msg = 'Keyword "Revision" was not found anywhere in text: %s' %version_info
+    assert fields[0].startswith('Revision'), msg            
+
+    try:
+        revision_number = int(fields[1])
+    except:
+        msg = 'Revision number must be an integer. I got %s' %fields[1]
+        msg += 'Check that the command svn is on the system path' 
+        raise Exception(msg)                
+        
+    return revision_number
+
+
+def store_version_info(destination_path='.', verbose=False):
+    """Obtain current version from Subversion and store it.
+    
+    Title: store_version_info()
+
+    Author: Ole Nielsen (Ole.Nielsen@ga.gov.au)
+
+    CreationDate: January 2006
+
+    Description:
+        This function obtains current version from Subversion and stores it
+        is a Python file named 'stored_version_info.py' for use with
+        get_version_info()
+
+        If svn is not available on the system PATH, an Exception is thrown
+    """
+
+    # Note (Ole): This function should not be unit tested as it will only
+    # work when running out of the sandpit. End users downloading the
+    # ANUGA distribution would see a failure.
+    #
+    # FIXME: This function should really only be used by developers (
+    # (e.g. for creating new ANUGA releases), so maybe it should move
+    # to somewhere else.
+    
+    import config
+
+    try:
+        fid = os.popen('svn info')
+    except:
+        msg = 'Command "svn" is not recognised on the system PATH'
+        raise Exception(msg)
+    else:    
+        txt = fid.read()
+        fid.close()
+
+
+        # Determine absolute filename
+        if destination_path[-1] != os.sep:
+            destination_path += os.sep
+            
+        filename = destination_path + config.version_filename
+
+        fid = open(filename, 'w')
+
+        docstring = 'Stored version info.\n\n'
+        docstring += 'This file provides the version for distributions '
+        docstring += 'that are not accessing Subversion directly.\n'
+        docstring += 'The file is automatically generated and should not '
+        docstring += 'be modified manually.\n'
+        fid.write('"""%s"""\n\n' %docstring)
+        
+        fid.write('version_info = """\n%s"""' %txt)
+        fid.close()
+
+
+        if verbose is True:
+            print 'Version info stored to %s' %filename
+