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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our directory files sorter worker. This is the description of a
single directory file sorter worker.
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 concurrent.futures
import os
from typing import Any, List, Optional, Tuple
import PyFunceble.cli.storage
import PyFunceble.facility
import PyFunceble.storage
from PyFunceble.cli.processes.workers.file_sorter_base import FileSorterWorkerBase
class DireFileSorterWorker(FileSorterWorkerBase):
"""
Provides our directory files sorter worker. The objective of this worker is
to provides a single worker (or process if you prefer) which will be used
to handle the sorting of the content of a submitted directory.
Expected (input) message:
::
{
"directory": str,
"remove_duplicates": bool,
"write_header": bool
}
Expected (output) message:
::
None
"""
@staticmethod
def get_files_to_sort(directory: str) -> List[str]:
"""
Provides the list of files to sort.
:param directory:
The directory to start from.
"""
dirs_to_ignore = [
os.path.join(
directory,
PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
),
os.path.join(directory, PyFunceble.cli.storage.OUTPUTS.splitted.directory),
]
files_to_ignore = [
".gitignore",
".gitkeep",
PyFunceble.cli.storage.TEST_RUNNING_FILE,
PyFunceble.cli.storage.COUNTER_FILE,
PyFunceble.cli.storage.REGISTRAR_COUNTER_FILE,
PyFunceble.cli.storage.PRE_LOADER_FILE,
]
result = []
for root, _, files in os.walk(directory):
if any(x in root for x in dirs_to_ignore):
continue
for file in files:
if file in files_to_ignore:
continue
result.append(os.path.join(root, file))
PyFunceble.facility.Logger.debug("List of files to sort:\n%r.", result)
return result
def target(self, consumed: Any) -> Optional[Tuple[Any, ...]]:
"""
The producer of the worker.
:param consumed:
The consumed data to work with.
"""
if (
not isinstance(consumed, dict)
and "directory" not in consumed
or not consumed["directory"]
):
PyFunceble.facility.Logger.info(
"Ignoring consumed data because no data to work with."
)
return None
# Just for human brain :-)
directory = consumed["directory"]
remove_duplicates = consumed.get("remove_duplicates", True)
write_header = consumed.get("write_header", True)
with concurrent.futures.ThreadPoolExecutor(
max_workers=PyFunceble.storage.CONFIGURATION.cli_testing.max_workers,
) as executor:
submitted_list = [
executor.submit(
self.process_file_sorting, file, remove_duplicates, write_header
)
for file in self.get_files_to_sort(directory)
]
for submitted in concurrent.futures.as_completed(submitted_list):
# Ensure that everything is finished
if submitted.exception():
raise submitted.exception()
return None
|
