Skip to content

System

AutoPoly.core.system

System Management Module

This module provides the System class for managing file paths, directories, and system operations within the AutoPoly package.

The System class handles: - Output directory creation and management - Path resolution for various file operations - Integration with the logging system

Created on Fri Dec 21 12:19:08 2018 @author: zwu

Classes:

Name Description
System

System management class for AutoPoly package.

System

System management class for AutoPoly package.

This class handles file system operations, path management, and provides utilities for creating and managing output directories for polymer simulations.

Attributes:

Name Type Description
out str

Output directory name for the current simulation

Methods:

Name Description
get_folder_path

Get the full path to the output directory.
get_output_path

Get the full path to the output directory.
change_output_directory

Change the output directory to a new location.
cleanup_output_directory

Remove the output directory and all its contents.
Source code in AutoPoly/core/system.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
class System:
    """
    System management class for AutoPoly package.

    This class handles file system operations, path management, and provides
    utilities for creating and managing output directories for polymer simulations.

    Attributes:
        out (str): Output directory name for the current simulation
    """

    def __init__(self, out: str = None) -> None:
        """
        Initialize the System class.

        Args:
            out (str, optional): Output directory name. If None, uses current
                               working directory. Defaults to None.
        """
        self.out = out
        if self.out:
            self._folder_path = str(Path.cwd() / self.out)
        else:
            self._folder_path = str(Path.cwd())

        # Create output directory if specified
        if self.out:
            self._create_output_directory()

    def _create_output_directory(self) -> None:
        """
        Create the output directory if it doesn't exist.

        This method creates the output directory specified in the constructor.
        If the directory already exists, it logs a warning but continues.
        """
        try:
            Path(self._folder_path).mkdir(parents=True, exist_ok=True)
            logger.info(f"Output directory created/verified: {self._folder_path}")
        except Exception as e:
            logger.error(f"Failed to create output directory {self._folder_path}: {e}")
            raise

    def get_folder_path(self) -> str:
        """
        Get the full path to the output directory.

        Returns:
            str: Full path to the output directory
        """
        return self._folder_path

    def get_output_path(self) -> str:
        """
        Get the full path to the output directory.

        This is an alias for get_folder_path() for backward compatibility.

        Returns:
            str: Full path to the output directory
        """
        return self.get_folder_path()

    def change_output_directory(self, new_out: str) -> None:
        """
        Change the output directory to a new location.

        Args:
            new_out (str): New output directory name
        """
        self.out = new_out
        self._folder_path = str(Path.cwd() / self.out)
        self._create_output_directory()
        logger.info(f"Output directory changed to: {self._folder_path}")

    def cleanup_output_directory(self) -> None:
        """
        Remove the output directory and all its contents.

        This method should be used with caution as it permanently deletes
        all files in the output directory.
        """
        if Path(self._folder_path).exists():
            try:
                shutil.rmtree(self._folder_path)
                logger.info(f"Cleaned up output directory: {self._folder_path}")
            except Exception as e:
                logger.error(f"Failed to cleanup output directory: {e}")
                raise

get_folder_path() -> str

Get the full path to the output directory.

Returns:

Name Type Description
str str

Full path to the output directory
Source code in AutoPoly/core/system.py 
66
67
68
69
70
71
72
73
def get_folder_path(self) -> str:
    """
    Get the full path to the output directory.

    Returns:
        str: Full path to the output directory
    """
    return self._folder_path

get_output_path() -> str

Get the full path to the output directory.

This is an alias for get_folder_path() for backward compatibility.

Returns:

Name Type Description
str str

Full path to the output directory
Source code in AutoPoly/core/system.py 
75
76
77
78
79
80
81
82
83
84
def get_output_path(self) -> str:
    """
    Get the full path to the output directory.

    This is an alias for get_folder_path() for backward compatibility.

    Returns:
        str: Full path to the output directory
    """
    return self.get_folder_path()

change_output_directory(new_out: str) -> None

Change the output directory to a new location.

Parameters:

Name Type Description Default
new_out str

New output directory name

 required
Source code in AutoPoly/core/system.py 
86
87
88
89
90
91
92
93
94
95
96
def change_output_directory(self, new_out: str) -> None:
    """
    Change the output directory to a new location.

    Args:
        new_out (str): New output directory name
    """
    self.out = new_out
    self._folder_path = str(Path.cwd() / self.out)
    self._create_output_directory()
    logger.info(f"Output directory changed to: {self._folder_path}")

cleanup_output_directory() -> None

Remove the output directory and all its contents.

This method should be used with caution as it permanently deletes all files in the output directory.

Source code in AutoPoly/core/system.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def cleanup_output_directory(self) -> None:
    """
    Remove the output directory and all its contents.

    This method should be used with caution as it permanently deletes
    all files in the output directory.
    """
    if Path(self._folder_path).exists():
        try:
            shutil.rmtree(self._folder_path)
            logger.info(f"Cleaned up output directory: {self._folder_path}")
        except Exception as e:
            logger.error(f"Failed to cleanup output directory: {e}")
            raise