Separate labscript-profile-create into a separate CLI interface and the

dihm · dihm · commit c9a5e1366156 · 2025-01-17T10:10:23.000-05:00
actual creation function `create_profile`,
which is automatically called when labscript_utils is imported and the profile does not already exist.
Separation ensures that argparse doesn't consume erroneous CLI arguments
just because a command incidentally imports labscript_utils (like on RTD).
diff --git a/labscript_profile/create.py b/labscript_profile/create.py
@@ -96,8 +96,10 @@ def dummy_callback(success):
                                        done_callback = dummy_callback)
     print(f'\tOutput written to {output_h5_path}')
 
-def create_profile():
+def create_profile_cli():
     """Function that defines the labscript-profile-create command
+
+    Parses CLI arguments and calls :func:`~.create_profile`.
     """
 
     # capture CMD arguments
@@ -116,6 +118,21 @@ def create_profile():
     
     args = parser.parse_args()
 
+    create_profile(args.apparatus_name, args.compile)
+
+def create_profile(apparatus_name = None, compile_table = False):
+    """Function that creates a labscript config profile from the default config
+
+    Parameters
+    ----------
+    appratus_name: str, optional
+        apparatus_name to define in the config.
+        If None, defaults to example_apparatus (set in default config file)
+    compile_table: bool, optional
+        Whether to compile to example connection table defined by the default config file
+        Default is False.
+    """
+
     src = Path(DEFAULT_PROFILE_CONTENTS)
     dest = Path(LABSCRIPT_SUITE_PROFILE)
     print(f'Creating labscript profile at {LABSCRIPT_SUITE_PROFILE}')
@@ -136,15 +153,15 @@ def create_profile():
             shutil.copy2(src_file, dest_file)
 
     print('Writing labconfig file')
-    make_labconfig_file(args.apparatus_name)
+    make_labconfig_file(apparatus_name)
 
     # rename apparatus directories
-    if args.apparatus_name is not None:
+    if apparatus_name is not None:
         print('\tRenaming apparatus directories')
         for path in dest.glob('**/example_apparatus/'):
-            new_path = Path(str(path).replace('example_apparatus', args.apparatus_name))
+            new_path = Path(str(path).replace('example_apparatus', apparatus_name))
             path.rename(new_path)
 
-    if args.compile:
+    if compile_table:
         print('Compiling the example connection table')
         compile_connection_table()
diff --git a/pyproject.toml b/pyproject.toml
@@ -69,4 +69,4 @@ docs = [
 ]
 
 [project.scripts]
-labscript-profile-create = "labscript_profile.create:create_profile"
+labscript-profile-create = "labscript_profile.create:create_profile_cli"

Original file line number	Diff line number	Diff line change
`@@ -69,4 +69,4 @@ docs = [`
`69`	`69`	`]`
`70`	`70`
`71`	`71`	`[project.scripts]`
`72`		`-labscript-profile-create = "labscript_profile.create:create_profile"`
	`72`	`+labscript-profile-create = "labscript_profile.create:create_profile_cli"`