Fix: Better handling of local log dir paths

Author: klieret

codeclash/__init__.py

@@ -9,4 +9,5 @@
     pass
 
 
-CONFIG_DIR = Path(__file__).resolve().parent.parent / "configs"
+PACKAGE_DIR = Path(__file__).resolve().parent
+CONFIG_DIR = PACKAGE_DIR / "configs"

codeclash/constants.py

@@ -1,6 +1,9 @@
 from pathlib import Path
 
-DIR_LOGS = Path("logs")
+from codeclash import PACKAGE_DIR
+
+DIR_LOGS = Path("logs")  # this is used also for parts of the paths in the environment
+LOCAL_LOG_DIR = PACKAGE_DIR / DIR_LOGS  # this one is always relative to the location of this code
 DIR_WORK = Path("/testbed")
 FILE_RESULTS = "results.json"
 GH_ORG = "emagedoc"

codeclash/ratings/elo.py

@@ -5,7 +5,7 @@
 
 from tqdm import tqdm
 
-from codeclash.constants import DIR_LOGS, FILE_RESULTS
+from codeclash.constants import FILE_RESULTS, LOCAL_LOG_DIR
 
 K_FACTOR = 32  # ELO constant, changeable
 
@@ -99,6 +99,6 @@ def main(log_dir: Path):
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
-    parser.add_argument("-d", "--log_dir", type=Path, help="Path to game logs (Default: logs/)", default=DIR_LOGS)
+    parser.add_argument("-d", "--log_dir", type=Path, help="Path to game logs (Default: logs/)", default=LOCAL_LOG_DIR)
     args = parser.parse_args()
     main(args.log_dir)

codeclash/ratings/win_rate.py

@@ -5,7 +5,7 @@
 
 from tqdm import tqdm
 
-from codeclash.constants import DIR_LOGS, RESULT_TIE
+from codeclash.constants import LOCAL_LOG_DIR, RESULT_TIE
 
 
 @dataclass
@@ -88,6 +88,6 @@ def main(log_dir: Path):
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
-    parser.add_argument("-d", "--log_dir", type=Path, help="Path to game logs (Default: logs/)", default=DIR_LOGS)
+    parser.add_argument("-d", "--log_dir", type=Path, help="Path to game logs (Default: logs/)", default=LOCAL_LOG_DIR)
     args = parser.parse_args()
     main(args.log_dir)

codeclash/utils/aws.py

@@ -3,7 +3,7 @@
 from logging import Logger
 from pathlib import Path
 
-from codeclash.constants import DIR_LOGS
+from codeclash.constants import LOCAL_LOG_DIR
 
 
 def is_running_in_aws_batch() -> bool:
@@ -81,7 +81,7 @@ def s3_log_sync(local_output_dir: Path, *, logger: Logger) -> None:
     # Construct S3 path: s3://bucket/prefix/logs/relative_path
     # where relative_path is local_output_dir relative to DIR_LOGS
     try:
-        relative_path = local_output_dir.relative_to(DIR_LOGS)
+        relative_path = local_output_dir.relative_to(LOCAL_LOG_DIR)
     except ValueError:
         # If local_output_dir is not under DIR_LOGS, use the full path
         relative_path = local_output_dir

main.py

@@ -6,7 +6,7 @@
 import yaml
 
 from codeclash import CONFIG_DIR
-from codeclash.constants import DIR_LOGS
+from codeclash.constants import LOCAL_LOG_DIR
 from codeclash.tournaments.pvp import PvpTournament
 from codeclash.utils.yaml_utils import resolve_includes
 
@@ -34,7 +34,7 @@ def main(
     suffix_part = f".{suffix}" if suffix else ""
     folder_name = f"PvpTournament.{config['game']['name']}.r{rounds}.s{sims}.p{p_num}.{p_list}{suffix_part}.{timestamp}"
     if output_dir is None:
-        full_output_dir = DIR_LOGS / getpass.getuser() / folder_name
+        full_output_dir = LOCAL_LOG_DIR / getpass.getuser() / folder_name
     else:
         full_output_dir = output_dir / folder_name
 

main_single_player.py

@@ -6,7 +6,7 @@
 import yaml
 
 from codeclash import CONFIG_DIR
-from codeclash.constants import DIR_LOGS
+from codeclash.constants import LOCAL_LOG_DIR
 from codeclash.tournaments.single_player import SinglePlayerTraining
 from codeclash.utils.yaml_utils import resolve_includes
 
@@ -27,7 +27,7 @@ def main(
     suffix_part = f".{suffix}" if suffix else ""
     folder_name = f"SinglePlayerTraining.{config['game']['name']}.{timestamp}{suffix_part}"
     if output_dir is None:
-        full_output_dir = DIR_LOGS / getpass.getuser() / folder_name
+        full_output_dir = LOCAL_LOG_DIR / getpass.getuser() / folder_name
     else:
         full_output_dir = output_dir / folder_name