add pathlib import for handling paths

pyscope/telrun/init_dirs.py

@@ -2,6 +2,8 @@
 import os
 import platform
 import shutil
+import subprocess
+from pathlib import Path
 
 import click
 
@@ -13,8 +15,8 @@
 @click.command()
 @click.argument(
     "path",
-    type=click.Path(resolve_path=True),
-    default="./pyscope-observatory/",
+    type=click.Path(resolve_path=True, path_type=Path),
+    default=Path("pyscope-observatory"),
     required=False,
 )
 @click.version_option()
@@ -24,40 +26,37 @@
 
     logger.info("Initializing a telrun home directory at %s" % path)
 
-    if os.path.exists(path):
+    if Path(path).exists():
         logger.error(f"Path {path} already exists")
         raise click.Abort()
 
-    logger.info(f"Creating directory {path}")
-    os.mkdir(path)
+    logger.info(f"Creating directory {str(path)}")
+    Path(path).mkdir()
 
     logger.info(f"Creating subdirectories")
-    os.mkdir(os.path.join(path, "config"))
-    os.mkdir(os.path.join(path, "schedules"))
-    os.mkdir(os.path.join(path, "images"))
-    os.mkdir(os.path.join(path, "logs"))
+    Path(path, "config").mkdir()
+    Path(path, "schedules").mkdir()
+    Path(path, "images").mkdir()
+    Path(path, "logs").mkdir()
 
     logger.info("Creating empty config files")
     shutil.copyfile(
-        os.path.join(os.path.dirname(__file__), "../config/telrun.cfg"),
-        os.path.join(path, "config/telrun.cfg"),
+        Path(__file__).parents[1] / "config/telrun.cfg", Path(path, "config/telrun.cfg")
     )
 
     shutil.copyfile(
-        os.path.join(os.path.dirname(__file__), "../config/observatory.cfg"),
-        os.path.join(path, "config/observatory.cfg"),
+        Path(__file__).parents[1] / "config/observatory.cfg",
+        Path(path, "config/observatory.cfg"),
     )
 
     logger.info("Copying default shortcut startup script")
     if platform.system() == "Windows":
         shutil.copyfile(
-            os.path.join(os.path.dirname(__file__), "start_telrun.bat"),
-            os.path.join(path, "start_telrun.bat"),
+            Path(__file__).parent / "start_telrun.bat", Path(path, "start_telrun.bat")
         )
     else:
         shutil.copyfile(
-            os.path.join(os.path.dirname(__file__), "start_telrun"),
-            os.path.join(path, "start_telrun"),
+            Path(__file__).parent / "start_telrun", Path(path, "start_telrun")
         )
 
     logger.info("Done")
@@ -76,35 +75,32 @@
 
     logger.info("Initializing a remote telrun home directory from %s" % path)
 
-    if not os.path.exists(os.path.join(path, "config/syncfiles.cfg")):
+    syncfiles_path = Path(path, "config/syncfiles.cfg")
+    if not syncfiles_path.exists():
         logger.info("No syncfiles.cfg found, creating one" % path)
 
         shutil.copyfile(
-            os.path.join(os.path.dirname(__file__), "../config/syncfiles.cfg"),
-            os.path.join(path, "config/syncfiles.cfg"),
+            Path(__file__).parents[1] / "config/syncfiles.cfg", syncfiles_path
         )
 
         logger.info(
             "Opening text editor... Please complete all fields and save the file"
         )
         if platform.system() == "Windows":
-            os.system(os.path.join(path, "config/syncfiles.cfg"))
+            subprocess.call(syncfiles_path, shell=True)
         else:
             try:
                 logger.info("Trying to open $EDITOR")
-                os.system(
-                    "%s %s"
-                    % (os.getenv("EDITOR"), os.path.join(path, "config/syncfiles.cfg"))
-                )
+                subprocess.call(os.getenv("EDITOR", "vi"), syncfiles_path)
             except:
                 logger.warning("Could not open $EDITOR, trying to open vi")
-                os.system("vi " + os.path.join(path, "config/syncfiles.cfg"))
+                subprocess.call("vi", syncfiles_path)
 
         input("Press enter to continue...")
 
     logger.info("Reading syncfiles.cfg")
 
-    local_config_dir = os.path.join(path, "config")
+    local_config_dir = Path(path, "config")
 
     (
         uname,
@@ -118,7 +114,7 @@
         remote_images_dir,
         local_logs_dir,
         remote_logs_dir,
-    ) = _read_syncfiles_cfg(os.path.join(local_config_dir, "syncfiles.cfg"))
+    ) = _read_syncfiles_cfg(Path(local_config_dir, "syncfiles.cfg"))
 
     logger.info("Performing initial single sync")
 
@@ -145,13 +141,12 @@
     logger.info("Copying default shortcut startup script")
     if platform.system() == "Windows":
         shutil.copyfile(
-            os.path.join(os.path.dirname(__file__), "start_syncfiles.bat"),
-            os.path.join(path, "start_syncfiles.bat"),
+            Path(__file__).parent / "start_syncfiles.bat",
+            Path(path, "start_syncfiles.bat"),
         )
     else:
         shutil.copyfile(
-            os.path.join(os.path.dirname(__file__), "start_syncfiles"),
-            os.path.join(path, "start_syncfiles"),
+            Path(__file__).parent / "start_syncfiles", Path(path, "start_syncfiles")
         )
 
 

pyscope/telrun/rst.py

@@ -167,8 +167,8 @@
     )
 
     if type(observatory) is str:
-        observatory = os.path.abspath(observatory)
-        if os.path.exists(observatory):
+        observatory = Path(observatory).absolute()
+        if observatory.is_file():
             config = configparser.ConfigParser()
             config.read(observatory)
             lat = coord.Latitude(config["site"]["latitude"], unit=u.deg)

pyscope/telrun/schedtel.py

@@ -3,6 +3,7 @@
 import json
 import logging
 import os
+import pathlib
 import shlex
 
 import astroplan

pyscope/telrun/startup.py

@@ -1,4 +1,4 @@
-import os
+from pathlib import Path
 
 import click
 
@@ -15,9 +15,7 @@
 )
 @click.version_option()
 def start_telrun_cli(path, gui):
-    telrun = TelrunOperator(
-        config_path=os.path.join(path, "config/telrun.cfg"), gui=gui
-    )
+    telrun = TelrunOperator(config_path=Path(path) / "config" / "telrun.cfg", gui=gui)
     telrun.mainloop()
 
 
@@ -27,7 +25,7 @@
 )
 @click.version_option()
 def start_syncfiles_cli(path):
-    syncfiles(config=os.path.join(path, "config/"))
+    syncfiles(config=Path(path) / "config")
 
 
 start_telrun = start_telrun_cli.callback

pyscope/telrun/summary_report.py

@@ -1,4 +1,5 @@
 import logging
+from pathlib import Path
 
 import click
 import markdown
@@ -65,7 +66,7 @@
 )
 @click.version_option()
 def summary_report_cli(
-    schedule, images_dir="./images/", preamble=None, code=None, verbose=-1
+    schedule=None, images_dir="./images/", preamble=None, code=None, verbose=-1
 ):
     """
     Generates an HTML summary report on the requested schedule.\b
@@ -84,11 +85,11 @@
 
     Parameters
     ----------
-    schedule : `str`, optional
+    schedule : Path-like, optional
         Path to the schedule file. If none provided, the default behavior
         is to check the ./schedules/ directory for the latest schedule.
 
-    images_dir : `str`, default='./images/'
+    images_dir : Path-like, default='./images/'
         Path to the directory containing the images.
 
     preamble : `str`, optional
@@ -144,28 +145,28 @@
     # Get schedule
     if schedule is None:
         last_mtime = 0
-        for fname in glob.glob("./schedules/*.ecsv"):
-            if os.path.getmtime(schedule) > last_mtime:
-                last_mtime = os.path.getmtime(schedule)
-                schedule = fname
+        for f in Path("schedules").glob("*.ecsv"):
+            if f.stat().st_mtime > last_mtime:
+                last_mtime = f.stat().st_mtime
+                schedule = f
     schedule = table.Table.read(schedule, format="ascii.ecsv")
 
     # Check images all exist
-    fnames = []
+    files = []
     headers = []
     for row in schedule:
         for fname in row["configuration"]["filename"].split(","):
-            if not os.path.exists(os.path.join(images_dir, fname)):
+            if not Path(images_dir, fname).is_file():
                 raise click.BadOptionUsage(f"Image {fname} does not exist.")
             else:
-                fnames.append(os.path.join(images_dir, fname))
+                files.append(Path(images_dir, fname))
                 headers.append(fits.getheader(fnames[-1]))
 
     tbl = table.Table(
         [
             [hdr["OBSCODE"] for hdr in headers],
             [hdr["OBSERVER"] for hdr in headers],
-            fnames,
+            [str(f) for f in files],
             [hdr["TARGET"] for hdr in headers],
             [
                 astrotime.Time(hdr["DATE-OBS"], format="fits", scale="utc")