ats_utilities.utils.dirs module

Module

dirs.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines factory directory utility functions.

ats_utilities.utils.dirs.check_dir_exists(dir_path: str, exc_message: str | None = None, exception_class: type[BaseException] = <class 'ats_utilities.exceptions.ats_value_error.ATSValueError'>) → None[source]

Checks if a directory exists.

Parameters:

  • dir_path (<str>) – Path to the directory.

  • exc_message (<str | None>) – Message to include in the exception message.

  • exception_class (<type[BaseException]> (default ATSValueError)) – The exception class to raise if value is None.

Exceptions:
ATSTypeError: Parameter type validation failed.
Dynamically raises the provided exception_class (e.g., ATSValueError).