Renaming and more tests

Author: WardBrian

cmdstanpy/model.py

@@ -297,26 +297,29 @@ def src_info(self) -> Dict[str, Any]:
             get_logger().debug(e)
             return result
 
-    def format_model(
+    def format(
         self,
-        save: bool = False,
+        overwrite_file: bool = False,
         canonicalize: Union[bool, str, Iterable[str]] = False,
+        max_line_length: int = 78,
         *,
-        unsafe: bool = False,
+        backup: bool = True,
     ) -> None:
         """
         Run stanc's auto-formatter on the model code. Either saves directly
         back to the file or prints for inspection
 
 
-        :param save: If True, save the updated code to disk, rather than
-            printing it. By default False
+        :param overwrite_file: If True, save the updated code to disk, rather
+            than printing it. By default False
         :param canonicalize: Whether or not the compiler should 'canonicalize'
             the Stan model, removing things like deprecated syntax. Default is
             False. If True, all canonicalizations are run. If it is a list of
             strings, those options are passed to stanc (new in Stan 2.29)
-        :param unsafe: If True, do not create stanfile.bak backups before
-            writing to the file. Only do this if you're sure you have other
+        :param max_line_length: Set the wrapping point for the formatter. The
+            default value is 78, which wraps most lines by the 80th character.
+        :param backup: If True, create a stanfile.bak backup before
+            writing to the file. Only disable this if you're sure you have other
             copies of the file or are using a version control system like Git.
         """
         if self.stan_file is None or not os.path.isfile(self.stan_file):
@@ -330,25 +333,32 @@ def format_model(
             )
 
             if canonicalize:
-                if isinstance(canonicalize, str):
+                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))
-                else:
-                    cmd.append('--print-canonical')
 
+            # before 2.29, having both --print-canonical
+            # and --auto-format printed twice
             if not (cmdstan_version_before(2, 29) and canonicalize):
                 cmd.append('--auto-format')
 
+            if not cmdstan_version_before(2, 29):
+                cmd.append(f'--max-line-length={max_line_length}')
+
             out = subprocess.run(
                 cmd, capture_output=True, text=True, check=True
             )
             if out.stderr:
                 get_logger().warning(out.stderr)
             result = out.stdout
-            if save:
+            if overwrite_file:
                 if result:
-                    if not unsafe:
+                    if backup:
                         shutil.copyfile(self.stan_file, self.stan_file + '.bak')
                     with (open(self.stan_file, 'w')) as file_handle:
                         file_handle.write(result)

test/data/format_me.stan

@@ -1,5 +1,9 @@
-# pound-sign comment
 generated quantities {
-   int x;
-   x <- (((((3)))));
+   array[10,10,10,10,10] matrix[100,100] a_very_long_name;
+   int x = (((10)));
+   int y;
+   if (1)
+    y = 1;
+   else
+    y=2;
 }

test/data/format_me_deprecations.stan

@@ -0,0 +1,5 @@
+# pound-sign comment
+generated quantities {
+   int x;
+   x <- (((((3)))));
+}

test/test_model.py

@@ -382,14 +382,14 @@ def test_model_includes_implicit(self):
         not cmdstan_version_before(2, 32),
         reason="Deprecated syntax removed in Stan 2.32",
     )
-    def test_model_format(self):
-        stan = os.path.join(DATAFILES_PATH, 'format_me.stan')
+    def test_model_format_deprecations(self):
+        stan = os.path.join(DATAFILES_PATH, 'format_me_deprecations.stan')
 
         model = CmdStanModel(stan_file=stan, compile=False)
 
         sys_stdout = io.StringIO()
         with contextlib.redirect_stdout(sys_stdout):
-            model.format_model()
+            model.format()
 
         formatted = sys_stdout.getvalue()
         self.assertIn("//", formatted)
@@ -398,13 +398,41 @@ def test_model_format(self):
 
         sys_stdout = io.StringIO()
         with contextlib.redirect_stdout(sys_stdout):
-            model.format_model(canonicalize=True)
+            model.format(canonicalize=True)
 
         formatted = sys_stdout.getvalue()
         print(formatted)
         self.assertNotIn("<-", formatted)
         self.assertEqual(formatted.count('('), 0)
 
+    @pytest.mark.skipif(
+        cmdstan_version_before(2, 29), reason='Options only available later'
+    )
+    def test_model_format_options(self):
+        stan = os.path.join(DATAFILES_PATH, 'format_me.stan')
+
+        model = CmdStanModel(stan_file=stan, compile=False)
+
+        sys_stdout = io.StringIO()
+        with contextlib.redirect_stdout(sys_stdout):
+            model.format(max_line_length=10)
+        formatted = sys_stdout.getvalue()
+        self.assertGreater(len(formatted.splitlines()), 11)
+
+        sys_stdout = io.StringIO()
+        with contextlib.redirect_stdout(sys_stdout):
+            model.format(canonicalize='braces')
+        formatted = sys_stdout.getvalue()
+        self.assertEqual(formatted.count('{'), 3)
+        self.assertEqual(formatted.count('('), 4)
+
+        sys_stdout = io.StringIO()
+        with contextlib.redirect_stdout(sys_stdout):
+            model.format(canonicalize=['parentheses'])
+        formatted = sys_stdout.getvalue()
+        self.assertEqual(formatted.count('{'), 1)
+        self.assertEqual(formatted.count('('), 1)
+
 
 if __name__ == '__main__':
     unittest.main()