Merge pull request #679 from stan-dev/install/allow-git-versions

Allow git:TAG as a version in install_cmdstan

Author: WardBrian

.github/workflows/main.yml

@@ -82,6 +82,7 @@ jobs:
         run: python -m pip freeze
 
       - name: CmdStan installation cacheing
+        if: ${{ !startswith(needs.get-cmdstan-version.outputs.version, 'git:') }}
         uses: actions/cache@v3
         with:
           path: ~/.cmdstan

cmdstanpy/install_cmdstan.py

@@ -22,6 +22,7 @@
 import os
 import platform
 import re
+import shutil
 import sys
 import tarfile
 import urllib.error
@@ -426,6 +427,9 @@ def install_version(
 
 
 def is_version_available(version: str) -> bool:
+    if 'git:' in version:
+        return True  # no good way in general to check if a git tag exists
+
     is_available = True
     url = get_download_url(version)
     for i in range(6):
@@ -455,6 +459,27 @@ def retrieve_version(version: str, progress: bool = True) -> None:
     """Download specified CmdStan version."""
     if version is None or version == '':
         raise ValueError('Argument "version" unspecified.')
+
+    if 'git:' in version:
+        tag = version.split(':')[1]
+        tag_folder = version.replace(':', '-').replace('/', '_')
+        print(f"Cloning CmdStan branch '{tag}' from stan-dev/cmdstan on GitHub")
+        do_command(
+            [
+                'git',
+                'clone',
+                '--depth',
+                '1',
+                '--branch',
+                tag,
+                '--recursive',
+                '--shallow-submodules',
+                'https://github.com/stan-dev/cmdstan.git',
+                f'cmdstan-{tag_folder}',
+            ]
+        )
+        return
+
     print('Downloading CmdStan version {}'.format(version))
     url = get_download_url(version)
     for i in range(6):  # always retry to allow for transient URLErrors
@@ -578,9 +603,12 @@ def run_install(args: Union[InteractiveSettings, InstallationSettings]) -> None:
     if args.compiler:
         run_compiler_install(args.dir, args.verbose, args.progress)
 
-    cmdstan_version = f'cmdstan-{args.version}'
+    if 'git:' in args.version:
+        tag = args.version.replace(':', '-').replace('/', '_')
+        cmdstan_version = f'cmdstan-{tag}'
+    else:
+        cmdstan_version = f'cmdstan-{args.version}'
     with pushd(args.dir):
-
         already_installed = os.path.exists(cmdstan_version) and os.path.exists(
             os.path.join(
                 cmdstan_version,
@@ -598,6 +626,7 @@ def run_install(args: Union[InteractiveSettings, InstallationSettings]) -> None:
                     'Connection to GitHub failed. '
                     'Check firewall settings or ensure this version exists.'
                 )
+            shutil.rmtree(cmdstan_version, ignore_errors=True)
             retrieve_version(args.version, args.progress)
             install_version(
                 cmdstan_version=cmdstan_version,
@@ -620,7 +649,11 @@ def parse_cmdline_args() -> Dict[str, Any]:
         + "interactive mode",
     )
     parser.add_argument(
-        '--version', '-v', help="version, defaults to latest release version"
+        '--version',
+        '-v',
+        help="version, defaults to latest release version. "
+        "If git is installed, you can also specify a git tag or branch, "
+        "e.g. git:develop",
     )
     parser.add_argument(
         '--dir', '-d', help="install directory, defaults to '$HOME/.cmdstan"

cmdstanpy/utils/cmdstan.py

@@ -97,11 +97,13 @@ def get_latest_cmdstan(cmdstan_dir: str) -> Optional[str]:
         for name in os.listdir(cmdstan_dir)
         if os.path.isdir(os.path.join(cmdstan_dir, name))
         and name.startswith('cmdstan-')
-        and name[8].isdigit()
-        and len(name[8:].split('.')) == 3
     ]
     if len(versions) == 0:
         return None
+    if len(versions) == 1:
+        return 'cmdstan-' + versions[0]
+    # we can only compare numeric versions
+    versions = [v for v in versions if v[0].isdigit() and v.count('.') == 2]
     # munge rc for sort, e.g. 2.25.0-rc1 -> 2.25.-99
     for i in range(len(versions)):  # # pylint: disable=C0200
         if '-rc' in versions[i]:
@@ -442,6 +444,8 @@ def install_cmdstan(
 
     :param version: CmdStan version string, e.g. "2.29.2".
         Defaults to latest CmdStan release.
+        If ``git`` is installed, a git tag or branch of stan-dev/cmdstan
+        can be specified, e.g. "git:develop".
 
     :param dir: Path to install directory.  Defaults to hidden directory
         ``$HOME/.cmdstan``.
@@ -516,7 +520,11 @@ def install_cmdstan(
         logger.warning('CmdStan installation failed.\n%s', str(e))
         return False
 
-    set_cmdstan_path(os.path.join(args.dir, f"cmdstan-{args.version}"))
+    if 'git:' in args.version:
+        folder = f"cmdstan-{args.version.replace(':', '-').replace('/', '_')}"
+    else:
+        folder = f"cmdstan-{args.version}"
+    set_cmdstan_path(os.path.join(args.dir, folder))
 
     return True