adapt versioning info to use saved_version.py when present, git_verinfo.py when not

Author: briantoby

GSASII/GSASIIGUI.py

@@ -1,9 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-#GSASII
+#GSASIIGUI
 '''
+This provides a short file that is used to start the GSAS-II GUI
+
 A single class, :class:`G2App`, is defined here to create
-an wxPython application. This is only used on
+a wxPython application. This is only used on
 MacOS. For other platforms ``wx.App()`` is called directly.
 '''
 
@@ -12,15 +14,12 @@
 from . import GSASIIpath
 
 __version__ = '5.0.0'
-try:
-    from . import git_verinfo
-    if len(git_verinfo.git_tags):
-        __version__ = git_verinfo.git_tags[0]
-    elif len(git_verinfo.git_prevtags):
-        __version__ = git_verinfo.git_prevtags[0]
-except ImportError:
-    pass
-
+gv = GSASIIpath.getSavedVersionInfo()
+if gv is not None:
+    if len(gv.git_tags):
+        __version__ = gv.git_tags[0]
+    elif len(gv.git_prevtags):
+        __version__ = gv.git_prevtags[0]
 
 def main():
     import scipy.optimize # loading here addresses problem with build for wx on Pi

GSASII/GSASIImiscGUI.py

@@ -695,20 +695,21 @@ def ProjFileSave(G2frame):
             return
         print ('save to file: '+G2frame.GSASprojectfile)
         # stick the file name into the tree and version info into tree so they are saved.
-        # (Controls should always be created at this point)
+        # (Controls should always have been created in tree at this point)
         try:
             Controls = G2frame.GPXtree.GetItemPyData(
                 G2gd.GetGPXtreeItemId(G2frame,G2frame.root, 'Controls'))
             Controls['PythonVersions'] = G2frame.PackageVersions
             Controls['LastSavedAs'] = os.path.abspath(G2frame.GSASprojectfile)
-            Controls['LastSavedUsing'] = str(GSASIIpath.GetVersionNumber())
+            Controls['LastSavedUsing'] = f"#{GSASIIpath.GetVersionNumber()}, {GSASIIpath.GetVersionTag()}"
             if GSASIIpath.HowIsG2Installed().startswith('git'):
                 g2repo = GSASIIpath.openGitRepo(GSASIIpath.path2GSAS2)
                 commit = g2repo.head.commit
                 Controls['LastSavedUsing'] += f" git {commit.hexsha[:8]}"
             else:
-                from . import git_verinfo as gv
-                Controls['LastSavedUsing'] += f" static {gv.git_version[:8]}"
+                gv = getSavedVersionInfo()
+                if gv is not None:
+                    Controls['LastSavedUsing'] += f" static {gv.git_version[:8]}"
         except:
             pass
         wx.BeginBusyCursor()

GSASII/GSASIIpath.py

@@ -207,39 +207,90 @@ def HowIsG2Installed():
     G2_installed_result = 'noVCS'
     return G2_installed_result
 
+def getSavedVersionInfo():
+    '''Get version number information from a file written by install
+    routines. This is faster than getting the information from git. Also,
+    when GSAS-II is installed into Python, the files are no longer in 
+    a git repository so querying git is not possible.
+
+    The saved_version.py file is written by install/save_versions.py.
+    The git_verinfo.py file is written by install/tag-version.py or
+    by install/incr-mini-version.py. If both are present, use the 
+    saved_version.py file preferentially. 
+
+    :returns: a reference to the version variables or None if no 
+      version info file is found.
+    '''
+    try:
+        from . import saved_version as gv
+        return gv
+    except:
+        pass
+    try:
+        from . import git_verinfo as gv
+        return gv
+    except:
+        pass
+    return None  # this is unexpected as all dists should have git_verinfo.py
+
 def GetVersionNumber():
-    '''Obtain a version number for GSAS-II from git or from the
-    files themselves, if no other choice.
+    '''Obtain a numeric (sequential) version number for GSAS-II from version
+    files, or directly from git if no other choice.
 
-    :returns: an int value usually, but a value of 'unknown' might occur
+    :returns: an int value normally, but unexpected error conditions could result in 
+      a value of 'unknown' or '?'.
     '''
+    # look for a previously recorded tag -- this is quick
+    gv = getSavedVersionInfo()
+    if gv is not None:
+        for item in gv.git_tags+gv.git_prevtags:
+            if item.isnumeric(): return int(item)
+
     if HowIsG2Installed().startswith('git'):
-        # look for a recorded tag -- this is quick
+        # unexpected: should always find a version from getSavedVersionInfo()
+        #   from a version file, but if that fails ask Git for the most
+        #   recent tag that starts & ends with a digit and does not contain a '.'
         try:
-            from . import git_verinfo as gv
-            for item in gv.git_tags+gv.git_prevtags:
-                if item.isnumeric(): return int(item)
+            g2repo = openGitRepo(path2GSAS2)
+            tag,vers,gnum = g2repo.git.describe('--tags','--match','[0-9]*[0-9]',
+                                                         '--exclude','*.*').split('-')
+            if tag.isnumeric(): return int(tag)
         except:
             pass
-        # no luck, ask Git for the most recent tag (must start & end with a number)
+        return "unknown"
+
+    # Not installed from git and no version file -- very strange!
+    return "?"
+
+def GetVersionTag():
+    '''Obtain a release (X.Y.Z) version number for GSAS-II from version
+    files, or directly from git if no other choice.
+
+    :returns: a string of form <Major>.<Minor>.<mini> normally, but unexpected 
+      error conditions could result in a value of '?.?.?' or '?'.
+    '''
+    # look for a previously recorded tag -- this is quick
+    gv = getSavedVersionInfo()
+    if gv is not None:
+        if '?' not in gv.git_versiontag: return gv.git_versiontag
+
+    if HowIsG2Installed().startswith('git'):
+        # unexpected: should always find a version from getSavedVersionInfo()
+        #   from a version file, but if that fails ask Git for the most
+        #   recent tag that has the X.Y.Z format.
         try:
             g2repo = openGitRepo(path2GSAS2)
-            tag,vers,gnum = g2repo.git.describe('--tags','--match','[0-9]*[0-9]').split('-')
-            if tag.isnumeric(): return int(tag)
+            tag,vers,gnum = g2repo.git.describe('--tags','--match','*.*.*').split('-')
+            return tag
         except:
             pass
-        return "unknown"
+        return "?.?.?"
 
-    # No luck asking, look up version information from git_verinfo.py
-    try:
-        from . import git_verinfo as gv
-        for item in gv.git_tags+gv.git_prevtags:
-            if item.isnumeric(): return int(item)
-    except:
-        pass
-    return "unknown"
+    # Not installed from git and no version file -- very strange!
+    return "?"
 
 def getG2VersionInfo():
+    gv = getSavedVersionInfo()
     if HowIsG2Installed().startswith('git'):
         g2repo = openGitRepo(path2GSAS2)
         commit = g2repo.head.commit
@@ -248,7 +299,7 @@ def getG2VersionInfo():
             tzinfo=commit.committed_datetime.tzinfo)
         delta = now - commit.committed_datetime
         age = delta.total_seconds()/(60*60*24.)
-        gversion = f"Tag: #{GetVersionNumber()}"
+        gversion = f"Tag: #{GetVersionNumber()}, {GetVersionTag()}"
         msg = ''
         if g2repo.head.is_detached:
             msg = ("\n" +
@@ -270,16 +321,12 @@ def getG2VersionInfo():
             elif len(rc) > 0:
                 msg += f"\n\tThis GSAS-II version is ~{len(rc)} updates behind current."
         return f"  GSAS-II:    {commit.hexsha[:8]}, {ctim} ({age:.1f} days old). {gversion}{msg}"
-    else:
-        try:
-            from . import git_verinfo as gv
-            for item in gv.git_tags+gv.git_prevtags:
-                if item.isnumeric():
-                    return f"GSAS-II version: Git: {gv.git_version[:8]}, #{item} (installed without update capability)"
-        except:
-            pass
+    elif gv is not None:
+        for item in gv.git_tags+gv.git_prevtags:
+            if item.isnumeric():
+                return f"GSAS-II version: Git: {gv.git_version[:8]}, #{item} (installed without update capability)"
     # Failed to get version info, fallback on old version number routine
-    return f"GSAS-II installed without git, last tag: {GetVersionNumber()}"
+    return f"GSAS-II installed without git, last tag: #{GetVersionNumber()}, {GetVersionTag()}"
 
 #==============================================================================
 #==============================================================================

GSASII/GSASIIpwd.py

@@ -27,13 +27,7 @@
 from . import GSASIIpath
 GSASIIpath.SetBinaryPath()
 
-filversion = "?"
-try:
-    import git_verinfo
-    filversion = git_verinfo.git_tags[0]
-    if not filversion: filversion = git_verinfo.git_prevtags[0]
-except:
-    pass
+filversion = str(GSASIIpath.GetVersionNumber())
 from . import GSASIIlattice as G2lat
 from . import GSASIIspc as G2spc
 from . import GSASIIElem as G2elem

GSASII/GSASIIscriptable.py

@@ -913,8 +913,9 @@ def save(self, filename=None):
                 commit = g2repo.head.commit
                 controls_data['LastSavedUsing'] += f" git {commit.hexsha[:8]} script"
             else:
-                from . import git_verinfo as gv
-                Controls['LastSavedUsing'] += f" static {gv.git_version[:8]}"
+                gv = getSavedVersionInfo()
+                if gv is not None:
+                    Controls['LastSavedUsing'] += f" static {gv.git_version[:8]}"
         except:
             pass
         #    .gpx name

GSASII/install/git_filters.py renamed to GSASII/install/git_filters.py.old

@@ -36,22 +36,27 @@ To assign a new integer tag number (and increment the minor version number), use
 
    This script is used when there are significant changes (possibly cumulative) to the
    code and a new release should be tagged both with a new integer tag number and
-   minor version number. It updates the `git_verinfo.py` version file so that non-git
-   installs of GSAS-II can report the currect version number.
+   minor version number. It updates the `git_verinfo.py` version file so that
+   GSAS-II can quickly report the current version numbers. 
 
 To increment only the mini version number, use script:
 
    `.../GSASII/install/incr-mini-version.py`
 
    This script is used when the have been minor changes made in GSAS-II and 
    the changes warrent an update (for example, due to a bug fix). This cannot be used
-   when an integer tag number has been assigned to the 
-   current GSAS-II commit code.
+   when a new integer tag number has been assigned to the 
+   current GSAS-II commit.
+   It also updates the `git_verinfo.py` version file so that
+   GSAS-II can quickly report the current version numbers.
 
    `.../GSASII/install/save-versions.py`
 
-   This script is used to save the latest version info in the `git_verinfo.py` file.
-   No tags or release version numbers are created. 
+   This script is used to save the latest version info in the `saved_version.py` file.
+   This file is created when a non-git install is made for GSAS-II so that the
+   hash number for the current git version (which cannot be
+   placed into the `git_verinfo.py` file) is recorded. 
+   The `save-versions.py` script does not change any tags or release version numbers. 
 
 
 History

docs/source/versioning.rst

@@ -0,0 +1,45 @@
+# compute a single peak with pypowder
+import os
+import sys
+import importlib.util
+import numpy as np
+
+home = os.path.dirname(__file__)
+G2loc = None
+try: 
+    G2loc = importlib.util.find_spec('GSASII.GSASIIscriptable')
+except ModuleNotFoundError:
+    print('ModuleNotFound for GSASII.GSASIIscriptable')
+
+if G2loc is None: # fixup path if GSASII not installed into Python
+    print('GSAS-II not installed in Python; Hacking sys.path')
+    sys.path.append(os.path.dirname(home))
+
+from GSASII import GSASIIpath
+GSASIIpath.SetBinaryPath()
+
+if GSASIIpath.binaryPath:
+    import  pypowder as pyd
+else:
+    from . import pypowder as pyd
+
+# these values generate a nearly symmetric peak
+xdata = np.arange(18,22,.05)
+pos = 20.
+sig = 525.9994695543994
+gam = 2.1444606947716025
+shl = 0.002
+ydata = pyd.pypsvfcjo(len(xdata),xdata-pos,pos,sig,gam,shl)
+
+# these values generate a peak with significant low-angle broadening
+#xdata = np.arange(0.1,5,.05)
+#pos = 2
+#sig = 525.9994695543994
+#gam = 2.1444606947716025
+#shl = 0.035
+#ydata = pyd.pypsvfcjo(len(xdata),xdata-pos,pos,sig,gam,shl)
+
+import matplotlib.pyplot as plt
+plt.plot(xdata,ydata)
+plt.show()
+