More safeguards and tests

Author: WardBrian

cmdstanpy/model.py

@@ -39,6 +39,7 @@
     MaybeDictToFilePath,
     SanitizedOrTmpFilePath,
     cmdstan_path,
+    cmdstan_version,
     cmdstan_version_before,
     do_command,
     get_logger,
@@ -333,14 +334,24 @@ def format(
             )
 
             if canonicalize:
-                if cmdstan_version_before(2, 29) or isinstance(
-                    canonicalize, bool
-                ):
-                    cmd.append('--print-canonical')
-                elif isinstance(canonicalize, str):
-                    cmd.append('--canonicalize=' + canonicalize)
-                elif isinstance(canonicalize, Iterable):
-                    cmd.append('--canonicalize=' + ','.join(canonicalize))
+                if cmdstan_version_before(2, 29):
+                    if isinstance(canonicalize, bool):
+                        cmd.append('--print-canonical')
+                    else:
+                        raise ValueError(
+                            "Invalid arguments passed for current CmdStan"
+                            + " version({})\n".format(
+                                cmdstan_version() or "Unknown"
+                            )
+                            + "--canonicalize requires 2.29 or higher"
+                        )
+                else:
+                    if isinstance(canonicalize, str):
+                        cmd.append('--canonicalize=' + canonicalize)
+                    elif isinstance(canonicalize, Iterable):
+                        cmd.append('--canonicalize=' + ','.join(canonicalize))
+                    else:
+                        cmd.append('--print-canonical')
 
             # before 2.29, having both --print-canonical
             # and --auto-format printed twice
@@ -349,6 +360,12 @@ def format(
 
             if not cmdstan_version_before(2, 29):
                 cmd.append(f'--max-line-length={max_line_length}')
+            elif max_line_length != 78:
+                raise ValueError(
+                    "Invalid arguments passed for current CmdStan version"
+                    + " ({})\n".format(cmdstan_version() or "Unknown")
+                    + "--max-line-length requires 2.29 or higher"
+                )
 
             out = subprocess.run(
                 cmd, capture_output=True, text=True, check=True

test/test_model.py

@@ -8,6 +8,7 @@
 import tempfile
 import unittest
 from test import CustomTestCase
+from unittest.mock import MagicMock, patch
 
 import pytest
 from testfixtures import LogCapture, StringComparison
@@ -433,6 +434,26 @@ def test_model_format_options(self):
         self.assertEqual(formatted.count('{'), 1)
         self.assertEqual(formatted.count('('), 1)
 
+        sys_stdout = io.StringIO()
+        with contextlib.redirect_stdout(sys_stdout):
+            model.format(canonicalize=True)
+        formatted = sys_stdout.getvalue()
+        self.assertEqual(formatted.count('{'), 3)
+        self.assertEqual(formatted.count('('), 1)
+
+    @patch('cmdstanpy.utils.cmdstan_version', MagicMock(return_value=(2, 27)))
+    def test_format_old_version(self):
+        self.assertTrue(cmdstan_version_before(2, 28))
+
+        stan = os.path.join(DATAFILES_PATH, 'format_me.stan')
+        model = CmdStanModel(stan_file=stan, compile=False)
+        with self.assertRaisesRegexNested(RuntimeError, r"--canonicalize"):
+            model.format(canonicalize='braces')
+        with self.assertRaisesRegexNested(RuntimeError, r"--max-line"):
+            model.format(max_line_length=88)
+
+        model.format(canonicalize=True)
+
 
 if __name__ == '__main__':
     unittest.main()