Source code for gaggle.arguments.outdir_args

import os
from dataclasses import dataclass, field


@dataclass
class OutdirArgs:
    """ Argument class that contains the arguments relating to the output directory of the experiment """

    CONFIG_KEY = "output_dir"

    root: str
    name: str
    folder_number: str

    root: str = field(default=None, metadata={
        "help": "Root folder where to put the experiments (good choice can be f'{os.getcwd()}/experiments')"
    })

    name: str = field(default="experiment", metadata={
        "help": "Name of each experiment folder"
    })

    folder_number: str = field(default=None, metadata={
        "help": "Suffix of each folder (e.g., '00001')"
    })

    def exists(self):
        return self.root is not None

    def create_folder_name(self, verbose=False):
        """ Gets and creates a unique folder name """
        folder_name = self.get_folder_path()
        os.makedirs(folder_name, exist_ok=True)
        if verbose:
            print(f"Created an output folder at '{folder_name}'.")
        return folder_name

    def get_folder_path(self):
        """ Get an unused folder name in the root directory. """
        if self.folder_number is None:
            os.makedirs(self.root, exist_ok=True)
            numbers = [0]
            for folder in [x for x in os.listdir(self.root) if self.name in x]:
                try:
                    numbers.append(int(folder.split(self.name + "_")[1]))
                except Exception as e:
                    pass
            self.folder_number = str(int(max(numbers) + 1)).zfill(5)
        return os.path.join(self.root, f'{self.name}_{self.folder_number}')