1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides a common base to the manipulation of the output directory.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import os
from typing import Optional, Union
import PyFunceble.cli.storage
from PyFunceble.database.session import DBSession
from PyFunceble.helpers.directory import DirectoryHelper
class FilesystemDirBase:
"""
Provides a common base for the manipulation of our output directory.
"""
_parent_dirname: Optional[str] = None
db_session: Optional[DBSession] = None
# Setting this to true will let you differ to the inline directory.
_differ_to_inline: bool = False
INLINE_DEST: str = "_inline_"
directory_helper: Optional[DirectoryHelper] = None
def __init__(
self,
parent_dirname: Optional[str] = None,
*,
db_session: Optional[DBSession] = None,
) -> None:
if parent_dirname is not None:
self.parent_dirname = parent_dirname
else:
self.parent_dirname = PyFunceble.cli.storage.STD_PARENT_DIRNAME
self.db_session = db_session
self.directory_helper = DirectoryHelper()
@property
def parent_dirname(self) -> Optional[str]:
"""
Provides the current state of the :code:`_parent_dirname` attribute.
"""
return self._parent_dirname
@parent_dirname.setter
def parent_dirname(self, value: Union[str, None]) -> None:
"""
Sets the parent dirname. The parent dirname is a directory which
acts a parent into the output directory.
:parm value:
The value to set.
:raise TypeError:
When the given :code:`value` is not a :py:class:`str` or :py:class:`None`.
:raise ValueError:
When the given :code:`value` is empty.
"""
if not isinstance(value, (str, type(None))):
raise TypeError(f"<value> should be {str}, {type(value)} given.")
if value is not None and not value:
raise ValueError("<value> should not be empty.")
self._parent_dirname = value
def set_parent_dirname(self, value: str) -> "FilesystemDirBase":
"""
Sets the parent dirname. The parent dirname is a directory which
acts a parent into the output directory.
:parm value:
The value to set.
"""
self.parent_dirname = value
return self
@property
def differ_to_inline(self) -> bool:
"""
Provides the current state of the :code:`_differ_to_inline` attribute.
"""
return self._differ_to_inline
@differ_to_inline.setter
def differ_to_inline(self, value: bool) -> None:
"""
Allows/Disallow the split to the inline directory. The attribute can be set
when you want to overwrite the behavior of the :code:`get_output_basedir`
method.
:parm value:
The value to set.
:raise TypeError:
When the given :code:`value` is not a :py:class:`bool`.
"""
if not isinstance(value, bool):
raise TypeError(f"<value> should be {bool}, {type(value)} given.")
self._differ_to_inline = value
def set_differ_to_inline(self, value: bool) -> "FilesystemDirBase":
"""
Allows/Disallow the split to the inline directory. The attribute can be set
when you want to overwrite the behavior of the :code:`get_output_basedir`
method.
:parm value:
The value to set.
"""
self.differ_to_inline = value
return self
def get_output_basedir(self) -> str:
"""
Provides the output base directory.
:param create_if_missing:
Authorizes the creation of the directory if it's missing.
"""
if self.parent_dirname:
result = os.path.join(
PyFunceble.cli.storage.OUTPUT_DIRECTORY, self.parent_dirname
)
elif self.differ_to_inline:
result = os.path.join(
PyFunceble.cli.storage.OUTPUT_DIRECTORY, self.INLINE_DEST
)
else:
result = PyFunceble.cli.storage.OUTPUT_DIRECTORY
self.directory_helper.set_path(result).create()
return result
|
