"""
The tool to check the availability or syntax of domains, IPv4, IPv6 or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the directory helpers.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/special-thanks.html
Contributors:
https://pyfunceble.github.io/contributors.html
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://pyfunceble.readthedocs.io///en/master/
Project homepage:
https://pyfunceble.github.io/
License:
::
MIT License
Copyright (c) 2017, 2018, 2019, 2020 Nissar Chababy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from os import getcwd, makedirs, path
from os import sep as directory_separator
from shutil import rmtree
[docs]class Directory:
"""
Simplify the directories manipulation.
:param str dir_path the path to work with.
"""
def __init__(self, dir_path=None):
self.path = dir_path
[docs] @classmethod
def get_current(cls, with_end_sep=False):
"""
Returns the current directory path.
:param bool with_end_sep:
Add a directory separator at the end.
"""
if with_end_sep:
return getcwd() + directory_separator
return getcwd() # pragma: no cover
[docs] def fix_path(self, dir_path=None, splited_path=None):
"""
Fix the path of the given path.
.. note::
We consider a path as fixed if it ends with the right
directory separator.
"""
if not dir_path:
dir_path = self.path
if not splited_path:
if dir_path:
# The parsed directory is not empty or equal to None.
# We initate a variable which will save the splited path.
split_path = []
if "/" in dir_path:
# We split the separator.
split_path = dir_path.split("/")
elif "\\" in dir_path:
# We split the separator.
split_path = dir_path.split("\\")
else:
split_path = [dir_path]
# We join the splited element with the directory separator as glue.
return self.fix_path(splited_path=[x for x in split_path if x])
# We return the directory.
return dir_path
return directory_separator.join(splited_path) + directory_separator
[docs] def exists(self, dir_path=None):
"""
Checks if the given directory exists.
"""
if not dir_path:
dir_path = self.path
return path.isdir(dir_path)
[docs] def create(self, dir_path=None): # pragma: no cover
"""
Creates the given directory path.
:return: The output of :code:`self.exists` after the directory creation.
:rtype: bool
"""
if not dir_path:
dir_path = self.path
try:
if not self.exists(dir_path=dir_path):
makedirs(dir_path)
except FileExistsError:
pass
return self.exists(dir_path=dir_path)
[docs] def delete(self, dir_path=None): # pragma: no cover
"""
Deletes the given directory path.
:return: :code:`not self.exists` after the directory deletion.
:rtypt: bool
"""
if not dir_path:
dir_path = self.path
if self.exists(dir_path=dir_path):
rmtree(dir_path)
return not self.exists(dir_path=dir_path)