Skip to content

utils.py

get_param_names(func)

Get parameter names for a function signature.

Source code in src/spyglass/position/utils.py 
 6
 7
 8
 9
10
def get_param_names(func):
    """Get parameter names for a function signature."""
    if not callable(func):
        return []  # If called when func is not imported
    return list(inspect.signature(func).parameters)

sanitize_filename(filename)

Sanitize filename to remove special characters

Source code in src/spyglass/position/utils.py 
13
14
15
16
17
18
19
20
21
22
def sanitize_filename(filename: str) -> str:
    """Sanitize filename to remove special characters"""
    char_map = {
        " ": "_",
        ".": "_",
        ",": "-",
        "&": "and",
        "'": "",
    }
    return "".join([char_map.get(c, c) for c in filename])

get_most_recent_file(path, ext='')

Get the most recent file of a given extension in a directory

Parameters:

Name Type Description Default
path Path

Path to the directory containing the files

 required
ext str

File extension to filter by (e.g., ".h5", ".csv"). Default is "", which returns the most recent file regardless of extension.

 ''
Source code in src/spyglass/position/utils.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_most_recent_file(path: Path, ext: str = "") -> Path:
    """Get the most recent file of a given extension in a directory

    Parameters
    ----------
    path : Path
        Path to the directory containing the files
    ext : str
        File extension to filter by (e.g., ".h5", ".csv"). Default is "",
        which returns the most recent file regardless of extension.
    """
    eval_files = list(Path(path).glob(f"*{ext}"))
    if not eval_files:
        raise FileNotFoundError(f"No {ext} files found in directory: {path}")

    eval_latest, max_modified_time = None, 0
    for eval_path in eval_files:
        modified_time = os.path.getmtime(eval_path)
        if modified_time > max_modified_time:
            eval_latest = eval_path
            max_modified_time = modified_time

    return eval_latest