Merge pull request #586 from stan-dev/fix/585-install-location

Fix location setting after install_cmdstan()

Author: mitzimorris

.github/workflows/main.yml

@@ -96,14 +96,14 @@ jobs:
         run: |
           install_cmdstan -h
           install_cxx_toolchain -h
-          python -m cmdstanpy.install_cmdstan --version ${{ needs.get-cmdstan-version.outputs.version }}
+          python -c "import cmdstanpy; cmdstanpy.install_cmdstan(version='${{ needs.get-cmdstan-version.outputs.version }}', cores=2)"
 
       - name: Install CmdStan (Windows)
         if: matrix.os == 'windows-latest'
         run: |
           install_cmdstan -h
           install_cxx_toolchain -h
-          python -m cmdstanpy.install_cmdstan --compiler --version ${{ needs.get-cmdstan-version.outputs.version }}
+          python -m cmdstanpy.install_cmdstan --compiler --version ${{ needs.get-cmdstan-version.outputs.version }} --cores 2
 
       - name: Run tests
         run: |

cmdstanpy/install_cmdstan.py

@@ -7,11 +7,14 @@
 example model ``bernoulli.stan``.
 
 Optional command line arguments:
+   -i, --interactive: flag, when specified ignore other arguments and
+                      ask user for settings on STDIN
    -v, --version <release> : version, defaults to latest release version
    -d, --dir <path> : install directory, defaults to '$HOME/.cmdstan
    --overwrite: flag, when specified re-installs existing version
    --progress: flag, when specified show progress bar for CmdStan download
    --verbose: flag, when specified prints output from CmdStan build process
+   --cores: int, number of cores to use when building, defaults to 1
    -c, --compiler : flag, add C++ compiler to path (Windows only)
 """
 import argparse

cmdstanpy/utils.py

@@ -153,7 +153,7 @@ def validate_cmdstan_path(path: str) -> None:
         raise ValueError(f'No CmdStan directory, path {path} does not exist.')
     if not os.path.exists(os.path.join(path, 'bin', 'stanc' + EXTENSION)):
         raise ValueError(
-            'CmdStan installataion missing binaries. '
+            f'CmdStan installataion missing binaries in {path}/bin. '
             'Re-install cmdstan by running command "install_cmdstan '
             '--overwrite", or Python code "import cmdstanpy; '
             'cmdstanpy.install_cmdstan(overwrite=True)"'
@@ -213,8 +213,9 @@ def cmdstan_version() -> Optional[Tuple[int, ...]]:
     """
     try:
         makefile = os.path.join(cmdstan_path(), 'makefile')
-    except ValueError:
+    except ValueError as e:
         get_logger().info('No CmdStan installation found.')
+        get_logger().debug("%s", e)
         return None
 
     if not os.path.exists(makefile):
@@ -299,7 +300,7 @@ def cxx_toolchain_path(
         if os.path.exists(os.path.join(toolchain_root, 'mingw64')):
             compiler_path = os.path.join(
                 toolchain_root,
-                'mingw64' if (sys.maxsize > 2**32) else 'mingw32',
+                'mingw64' if (sys.maxsize > 2 ** 32) else 'mingw32',
                 'bin',
             )
             if os.path.exists(compiler_path):
@@ -323,7 +324,7 @@ def cxx_toolchain_path(
         elif os.path.exists(os.path.join(toolchain_root, 'mingw_64')):
             compiler_path = os.path.join(
                 toolchain_root,
-                'mingw_64' if (sys.maxsize > 2**32) else 'mingw_32',
+                'mingw_64' if (sys.maxsize > 2 ** 32) else 'mingw_32',
                 'bin',
             )
             if os.path.exists(compiler_path):
@@ -375,7 +376,7 @@ def cxx_toolchain_path(
                 if version not in ('35', '3.5', '3'):
                     compiler_path = os.path.join(
                         toolchain_root,
-                        'mingw64' if (sys.maxsize > 2**32) else 'mingw32',
+                        'mingw64' if (sys.maxsize > 2 ** 32) else 'mingw32',
                         'bin',
                     )
                     if os.path.exists(compiler_path):
@@ -400,7 +401,7 @@ def cxx_toolchain_path(
                 else:
                     compiler_path = os.path.join(
                         toolchain_root,
-                        'mingw_64' if (sys.maxsize > 2**32) else 'mingw_32',
+                        'mingw_64' if (sys.maxsize > 2 ** 32) else 'mingw_32',
                         'bin',
                     )
                     if os.path.exists(compiler_path):
@@ -1361,7 +1362,7 @@ def install_cmdstan(
         logger.warning('CmdStan installation failed.\n%s', str(e))
         return False
 
-    set_cmdstan_path(args.dir)
+    set_cmdstan_path(os.path.join(args.dir, f"cmdstan-{args.version}"))
 
     return True
 

test/test_utils.py

@@ -6,14 +6,14 @@
 import json
 import logging
 import os
+import pathlib
 import platform
 import random
 import shutil
 import stat
 import string
 import tempfile
 import unittest
-from pathlib import Path
 from test import CustomTestCase
 
 import numpy as np
@@ -137,18 +137,21 @@ def test_validate_path(self):
         path_foo = os.path.abspath(os.path.join('releases', 'foo'))
         with self.assertRaisesRegex(ValueError, 'No CmdStan directory'):
             validate_cmdstan_path(path_foo)
+
         folder_name = ''.join(
             random.choice(string.ascii_letters) for _ in range(10)
         )
         while os.path.exists(folder_name):
             folder_name = ''.join(
                 random.choice(string.ascii_letters) for _ in range(10)
             )
-        os.makedirs(folder_name)
-        path_test = os.path.abspath(folder_name)
+        folder = pathlib.Path(folder_name)
+        folder.mkdir(parents=True)
+        (folder / "makefile").touch()
+
         with self.assertRaisesRegex(ValueError, 'missing binaries'):
-            validate_cmdstan_path(path_test)
-        shutil.rmtree(folder_name)
+            validate_cmdstan_path(str(folder.absolute()))
+        shutil.rmtree(folder)
 
     def test_validate_dir(self):
         with tempfile.TemporaryDirectory(
@@ -193,32 +196,31 @@ def test_cmdstan_version(self):
         with tempfile.TemporaryDirectory(
             prefix="cmdstan_tests", dir=_TMPDIR
         ) as tmpdir:
-            tdir = os.path.join(tmpdir, 'tmpdir_xxx')
-            os.makedirs(tdir)
-            fake_path = os.path.join(tdir, 'cmdstan-2.22.0')
-            os.makedirs(os.path.join(fake_path))
-            fake_bin = os.path.join(fake_path, 'bin')
-            os.makedirs(fake_bin)
-            Path(os.path.join(fake_bin, 'stanc' + EXTENSION)).touch()
-            with self.modified_environ(CMDSTAN=fake_path):
-                self.assertTrue(fake_path == cmdstan_path())
+            tdir = pathlib.Path(tmpdir) / 'tmpdir_xxx'
+            fake_path = tdir / 'cmdstan-2.22.0'
+            fake_bin = fake_path / 'bin'
+            fake_bin.mkdir(parents=True)
+            fake_makefile = fake_path / 'makefile'
+            fake_makefile.touch()
+            (fake_bin / f'stanc{EXTENSION}').touch()
+            with self.modified_environ(CMDSTAN=str(fake_path)):
+                self.assertTrue(str(fake_path) == cmdstan_path())
+                with open(fake_makefile, 'w') as fd:
+                    fd.write('...  CMDSTAN_VERSION := dont_need_no_mmp\n\n')
                 expect = (
-                    'CmdStan installation {} missing makefile, '
-                    'cannot get version.'.format(fake_path)
+                    'Cannot parse version, expected "<major>.<minor>.<patch>", '
+                    'found: "dont_need_no_mmp".'
                 )
                 with LogCapture() as log:
-                    logging.getLogger()
                     cmdstan_version()
                 log.check_present(('cmdstanpy', 'INFO', expect))
-                fake_makefile = os.path.join(fake_path, 'makefile')
-                with open(fake_makefile, 'w') as fd:
-                    fd.write('...  CMDSTAN_VERSION := dont_need_no_mmp\n\n')
+
+                fake_makefile.unlink()
                 expect = (
-                    'Cannot parse version, expected "<major>.<minor>.<patch>", '
-                    'found: "dont_need_no_mmp".'
+                    'CmdStan installation {} missing makefile, '
+                    'cannot get version.'.format(fake_path)
                 )
                 with LogCapture() as log:
-                    logging.getLogger()
                     cmdstan_version()
                 log.check_present(('cmdstanpy', 'INFO', expect))
         cmdstan_path()