Type and doc cleanup

Author: WardBrian

cmdstanpy/cmdstan_args.py

@@ -632,7 +632,7 @@ class CmdStanArgs:
     def __init__(
         self,
         model_name: str,
-        model_exe: Union[os.PathLike, str],
+        model_exe: str,
         chain_ids: Optional[list[int]],
         method_args: Union[
             SamplerArgs,
@@ -853,10 +853,10 @@ def compose_command(
                         idx, len(self.chain_ids)
                     )
                 )
-            cmd.append(self.model_exe)  # type: ignore # guaranteed by validate
+            cmd.append(self.model_exe)
             cmd.append(f'id={self.chain_ids[idx]}')
         else:
-            cmd.append(self.model_exe)  # type: ignore # guaranteed by validate
+            cmd.append(self.model_exe)
 
         if self.seed is not None:
             if not isinstance(self.seed, list):

cmdstanpy/compilation.py

@@ -441,7 +441,7 @@ def compile_stan_file(
             raise ValueError(
                 f"Failed to compile Stan model '{src}'. Console:\n{console}"
             )
-        return str(exe_target)
+        return os.fspath(exe_target)
 
 
 def format_stan_file(

cmdstanpy/model.py

@@ -68,11 +68,6 @@ class CmdStanModel:
     Stan program source file or the compiled executable, or both.
     This will compile the model if provided a Stan file and no executable,
 
-    :param model_name: Model name, used for output file names.
-        Optional, default is the base filename of the Stan program file.
-        Deprecated: In version 2.0.0, model name cannot be
-        specified and will always be taken from executable.
-
     :param stan_file: Path to Stan program file.
 
     :param exe_file: Path to compiled executable file.  Optional, unless
@@ -94,13 +89,6 @@ class CmdStanModel:
     :param user_header: A path to a header file to include during C++
         compilation.
         Optional.
-
-    :param compile: Whether or not to compile the model.  Default is ``True``.
-        If set to the string ``"force"``, it will always compile even if
-        an existing executable is found.
-        Deprecated: Use ``force_compile`` instead. The ability to instantiate
-        a CmdStanModel without an executable will be removed in version 2.0.0.
-
     """
 
     def __init__(
@@ -115,7 +103,6 @@ def __init__(
         """
         Initialize object given constructor args.
 
-        :param model_name: Deprecated. Model name, used for output file names.
         :param stan_file: Path to Stan program file.
         :param exe_file: Path to compiled executable file.
         :param force_compile: Whether or not to force recompilation if
@@ -206,17 +193,15 @@ def __init__(
                 get_logger().debug("TBB already found in load path")
 
     def __repr__(self) -> str:
-        repr = 'CmdStanModel: name={}'.format(self._name)
-        repr = '{}\n\t stan_file={}'.format(repr, self._stan_file)
-        repr = '{}\n\t exe_file={}'.format(repr, self._exe_file)
-        return repr
+        return (
+            f"CmdStanModel(stan_file={self.stan_file!r}, "
+            f"exe_file={self.exe_file!r})"
+        )
 
     @property
     def name(self) -> str:
         """
-        Model name used in output filename templates. Default is basename
-        of Stan program or exe file, unless specified in call to constructor
-        via argument ``model_name``.
+        Model name used in output filename templates.
         """
         return self._name
 
@@ -226,7 +211,7 @@ def stan_file(self) -> OptionalPath:
         return self._stan_file
 
     @property
-    def exe_file(self) -> Union[os.PathLike, str]:
+    def exe_file(self) -> str:
         """Full path to Stan exe file."""
         return self._exe_file
 
@@ -237,7 +222,7 @@ def exe_info(self) -> dict[str, str]:
         """
         result: dict[str, str] = {}
         info = StringIO()
-        do_command(cmd=[str(self.exe_file), 'info'], fd_out=info)
+        do_command(cmd=[self.exe_file, 'info'], fd_out=info)
         lines = info.getvalue().split('\n')
         for line in lines:
             kv_pair = [x.strip() for x in line.split('=')]

test/test_model.py

@@ -344,8 +344,7 @@ def test_model_syntax_error() -> None:
 
 def test_repr() -> None:
     model = CmdStanModel(stan_file=BERN_STAN)
-    model_repr = repr(model)
-    assert 'name=bernoulli' in model_repr
+    assert BERN_STAN in repr(model)
 
 
 def test_print() -> None: