Improve version tracking; remove unneeded menu items if installed into Python w/o git

Author: briantoby

GSASII/GSASIIGUI.py

@@ -15,6 +15,7 @@
 try:
     from . import git_verinfo
     __version__ = git_verinfo.git_tags[0]
+    if not __version__: __version__ = git_verinfo.git_prevtags[0]
 except ImportError:
     pass
 

GSASII/GSASIIctrlGUI.py

@@ -5648,7 +5648,7 @@ def __init__(self,frame,includeTree=False,morehelpitems=[]):
         self.Append(wx.ID_ABOUT,'&About GSAS-II',
                         'Shows version and citation info')
         frame.Bind(wx.EVT_MENU, self.OnHelpAbout, id=wx.ID_ABOUT)
-        if GSASIIpath.HowIsG2Installed():
+        if GSASIIpath.HowIsG2Installed().startswith('git'):
             helpobj = self.Append(wx.ID_ANY,'&Check for updates\tCtrl+U',
                     'Updates to latest GSAS-II version')
             if os.access(GSASIIpath.path2GSAS2, os.W_OK):

GSASII/GSASIIdataGUI.py

@@ -362,7 +362,7 @@ def compareVersions(version1,version2):
 'versions of modules that are known to have bugs'
 versionDict['tooNewWarn'] = {}
 'module versions newer than what we have tested & where problems are suspected'
-versionDict['tooNewUntested'] = {'Python':'3.12','wx': '4.2.3'}
+versionDict['tooNewUntested'] = {'Python':'3.14','wx': '4.2.3'}
 'module versions newer than what we have tested but no problems are suspected'
 
 def ShowVersions():
@@ -454,20 +454,21 @@ def ShowVersions():
     print(GSASIIpath.getG2VersionInfo())
 
     # warn if problems with Git
-    try:
-        import git
-    except ImportError as msg:
-        if 'Failed to initialize' in msg.msg:
-            print('The gitpython package is unable to locate a git installation.')
-            print('See https://gsas-ii.readthedocs.io/en/latest/packages.html for more information.')
-        elif 'No module' in msg.msg:
-            print('Warning: Python gitpython module not installed')
-        else:
-            print(f'gitpython failed to import, but why? Error:\n{msg}')
-        print('Note: git and gitpython are required for GSAS-II to self-update')
-    except Exception as msg:
-        print(f'git import failed with unexpected error:\n{msg}')
-        print('Note: git and gitpython are required for GSAS-II to self-update')
+    if GSASIIpath.HowIsG2Installed().startswith('git'):
+        try:
+            import git
+        except ImportError as msg:
+            if 'Failed to initialize' in msg.msg:
+                print('The gitpython package is unable to locate a git installation.')
+                print('See https://gsas-ii.readthedocs.io/en/latest/packages.html for more information.')
+            elif 'No module' in msg.msg:
+                print('Warning: Python gitpython module not installed')
+            else:
+                print(f'gitpython failed to import, but why? Error:\n{msg}')
+            print('Note: git and gitpython are required for GSAS-II to self-update')
+        except Exception as msg:
+            print(f'git import failed with unexpected error:\n{msg}')
+            print('Note: git and gitpython are required for GSAS-II to self-update')
 
     # warn if problems with requests package
     try:
@@ -656,8 +657,10 @@ def OnwxInspect(event):
             item = parent.Append(wx.ID_ANY,'Reopen current\tCtrl+0','Reread the current GSAS-II project (.gpx) file')
             self.Bind(wx.EVT_MENU, self.OnFileReread, id=item.GetId())
 
-        item = parent.Append(wx.ID_ANY,"Install GSASIIscriptable shortcut",'')
-        self.Bind(wx.EVT_MENU,
+        # if Git install assume GSAS-II was not installed into Python
+        if GSASIIpath.HowIsG2Installed().startswith('git'):
+            item = parent.Append(wx.ID_ANY,"Install GSASIIscriptable shortcut",'')
+            self.Bind(wx.EVT_MENU,
                       lambda event: GSASIIpath.makeScriptShortcut(),
                       item)
 

GSASII/GSASIImiscGUI.py

@@ -208,17 +208,9 @@ def GetVersionNumber():
     if HowIsG2Installed().startswith('git'):
         # look for a recorded tag -- this is quick
         try:
-            import git_verinfo as gv
-            try:
-                for item in gv.git_tags:
-                    if item.isnumeric(): return int(item)
-            except:
-                pass
-            try:
-                for item in gv.git_prevtags:
-                    if item.isnumeric(): return int(item)
-            except:
-                pass
+            from . import git_verinfo as gv
+            for item in gv.git_tags+gv.git_prevtags:
+                if item.isnumeric(): return int(item)
         except:
             pass
         # no luck, ask Git for the most recent tag (must start & end with a number)
@@ -232,20 +224,11 @@ def GetVersionNumber():
 
     # No luck asking, look up version information from git_verinfo.py
     try:
-        import git_verinfo as gv
-        try:
-            for item in gv.git_tags:
-                if item.isnumeric(): return int(item)
-        except:
-            pass
-        try:
-            for item in gv.git_prevtags:
-                if item.isnumeric(): return int(item)
-        except:
-            pass
+        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"
 
 def getG2VersionInfo():
@@ -278,21 +261,17 @@ def getG2VersionInfo():
                 msg += f"\n\t**** Please consider updating. >= {len(rc)} updates have been posted"
             elif len(rc) > 0:
                 msg += f"\n\tThis GSAS-II version is ~{len(rc)} updates behind current."
-        return f"  GSAS-II:    {commit.hexsha[:6]}, {ctim} ({age:.1f} days old). {gversion}{msg}"
+        return f"  GSAS-II:    {commit.hexsha[:8]}, {ctim} ({age:.1f} days old). {gversion}{msg}"
     else:
         try:
-            import git_verinfo as gv
-            if gv.git_tags:
-                msg = f"{' '.join(gv.git_tags)}, Git: {gv.git_version[:6]}"
-            else:
-                msg = (f"{gv.git_version[:6]}; "+
-                       f"Prev ver: {' '.join(gv.git_prevtags)}"+
-                       f", {gv.git_prevtaggedversion[:6]}")
-            return f"GSAS-II version: {msg} (Manual update)"
+            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
-    # all else fails, use the old version number routine
-    return f"GSAS-II installed manually, last revision: {GetVersionNumber()}"
+    # Failed to get version info, fallback on old version number routine
+    return f"GSAS-II installed without git, last tag: {GetVersionNumber()}"
 
 #==============================================================================
 #==============================================================================
@@ -1495,6 +1474,9 @@ def makeScriptShortcut():
       indicates an error.
     '''
     import datetime as dt
+    if not HowIsG2Installed().startswith('git'):
+        print('GSAS-II installed directly, shortcut likely not needed')
+        return None
     for p in sys.path:
         if 'site-packages' in p: break
     else:

GSASII/GSASIIpath.py

@@ -31,6 +31,7 @@
 try:
     import git_verinfo
     filversion = git_verinfo.git_tags[0]
+    if not filversion: filversion = git_verinfo.git_prevtags[0]
 except:
     pass
 from . import GSASIIlattice as G2lat

GSASII/GSASIIpwd.py

@@ -907,13 +907,16 @@ def save(self, filename=None):
         controls_data['PythonVersions'] = G2fil.get_python_versions(modList)
         #    G2 version info
         controls_data['LastSavedUsing'] = str(GSASIIpath.GetVersionNumber())
-        if GSASIIpath.HowIsG2Installed().startswith('git'):
-            try:
+        try:
+            if GSASIIpath.HowIsG2Installed().startswith('git'):
                 g2repo = GSASIIpath.openGitRepo(GSASIIpath.path2GSAS2)
                 commit = g2repo.head.commit
-                controls_data['LastSavedUsing'] += f" git {commit.hexsha[:6]} script"
-            except:
-                pass
+                controls_data['LastSavedUsing'] += f" git {commit.hexsha[:8]} script"
+            else:
+                from . import git_verinfo as gv
+                Controls['LastSavedUsing'] += f" static {gv.git_version[:8]}"
+        except:
+            pass
         #    .gpx name
         if filename:
             filename = os.path.abspath(os.path.expanduser(filename))

GSASII/GSASIIscriptable.py

@@ -0,0 +1,62 @@
+# record tag number and git hash into the git_version.py file.
+#
+import os
+import sys
+import datetime as dt
+import git
+
+# get location of the GSAS-II files
+# assumed to be the parent of location of this file
+path2GSAS2 = os.path.dirname(os.path.dirname(
+    os.path.abspath(os.path.expanduser(__file__))))
+# and the repo is in the parent of that
+path2repo = os.path.dirname(path2GSAS2)
+
+if __name__ == '__main__':
+
+    g2repo = git.Repo(path2repo)
+#    if g2repo.active_branch.name != 'master':
+#        print(f'Not on master branch {commit0[:6]!r}')
+#        sys.exit()
+    if g2repo.head.is_detached:
+        print(f'Detached head {commit0[:6]!r}')
+        sys.exit()
+    # create a file with GSAS-II version information
+    try:
+        g2repo = git.Repo(path2repo)
+    except:
+        print('Launch of gitpython for version file failed'+
+                  f' with path {path2repo}')
+        sys.exit()
+    commit = g2repo.head.commit
+    ctim = commit.committed_datetime.strftime('%d-%b-%Y %H:%M')
+    now = dt.datetime.now().replace(
+        tzinfo=commit.committed_datetime.tzinfo)
+    commit0 = commit.hexsha
+    tags0 = g2repo.git.tag('--points-at',commit).split('\n')
+    history = list(g2repo.iter_commits('HEAD'))
+    for i in history[1:]:
+        tags = g2repo.git.tag('--points-at',i)
+        if not tags: continue
+        commitm1 = i.hexsha
+        tagsm1 = tags.split('\n')
+        break
+    pyfile = os.path.join(path2GSAS2,'git_verinfo.py')
+    try:
+        fp = open(pyfile,'w')
+    except:
+        print(f'Creation of git version file {pyfile} failed')
+        sys.exit()
+    fp.write('# -*- coding: utf-8 -*-\n')
+    fp.write(f'# {os.path.split(pyfile)[1]} - GSAS-II version info from git\n')
+    fp.write(f'# Do not edit, generated by {" ".join(sys.argv)!r} script\n')
+    fp.write(f'# Created {now}\n\n')
+    fp.write(f'git_version = {commit0!r}\n')
+    if tags:
+        fp.write(f'git_tags = {tags0}\n')
+    else:
+        fp.write('git_tags = []\n')
+    fp.write(f'git_prevtaggedversion = {commitm1!r}\n')
+    fp.write(f'git_prevtags = {tagsm1}\n')
+    fp.close()
+    print(f'Created git version file {pyfile} at {now} for {commit0[:6]!r}')

GSASII/install/save-versions.py

@@ -6,9 +6,9 @@
 # version #
 
 # perhaps someday include as a clean (run on git add) or smudge
-# step (run on git pull). 
+# step (run on git pull).
 # Alternately, on commit/pull might get a count of how many untagged
-# check-ins there have been. 
+# check-ins there have been.
 #
 #    [filter "createVersionFile"]
 #       clean  = python git_filters.py --tag-version
@@ -30,12 +30,12 @@
 path2repo = os.path.dirname(path2GSAS2)
 
 if __name__ == '__main__':
-    
+
     g2repo = git.Repo(path2repo)
     if g2repo.active_branch.name != 'master':
         print(f'Not on master branch {commit0[:6]!r}')
         sys.exit()
-    if g2repo.head.is_detached: 
+    if g2repo.head.is_detached:
         print(f'Detached head {commit0[:6]!r}')
         sys.exit()
     # make a list of tags without a dash; get the largest numeric tag
@@ -66,7 +66,7 @@
         print(f'created tag {tagnum} for {i.hexsha[:6]}')
         break
 
-    # create a file with GSAS-II version infomation
+    # create a file with GSAS-II version information
     try:
         g2repo = git.Repo(path2repo)
     except:
@@ -94,7 +94,7 @@
         sys.exit()
     fp.write('# -*- coding: utf-8 -*-\n')
     fp.write(f'# {os.path.split(pyfile)[1]} - GSAS-II version info from git\n')
-    fp.write(f'# Do not edit, generated by {" ".join(sys.argv)!r} command\n')
+    fp.write(f'# Do not edit, generated by {" ".join(sys.argv)!r} script\n')
     fp.write(f'# Created {now}\n\n')
     fp.write(f'git_version = {commit0!r}\n')
     if tags: