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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides everything related to our counter tracker.
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 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 copy
from typing import Dict, List, Tuple, Union
import PyFunceble.cli.storage
import PyFunceble.cli.utils.testing
import PyFunceble.storage
from PyFunceble.checker.status_base import CheckerStatusBase
from PyFunceble.cli.filesystem.json_base import FilesystemJSONBase
from PyFunceble.helpers.list import ListHelper
class FilesystemCounter(FilesystemJSONBase):
"""
Provides our counter.
"""
STD_DATASET: Dict[str, int] = {
"counter": {
PyFunceble.storage.STATUS.up: 0,
PyFunceble.storage.STATUS.valid: 0,
PyFunceble.storage.STATUS.sane: 0,
PyFunceble.storage.STATUS.down: 0,
PyFunceble.storage.STATUS.malicious: 0,
PyFunceble.storage.STATUS.invalid: 0,
"total": 0,
},
"percentage": {
PyFunceble.storage.STATUS.up: 0,
PyFunceble.storage.STATUS.valid: 0,
PyFunceble.storage.STATUS.sane: 0,
PyFunceble.storage.STATUS.down: 0,
PyFunceble.storage.STATUS.malicious: 0,
PyFunceble.storage.STATUS.invalid: 0,
"total": 0,
},
}
PERCENTAGE_STATUSES: Dict[str, List[str]] = {
"SYNTAX": [
PyFunceble.storage.STATUS.valid,
PyFunceble.storage.STATUS.invalid,
],
"REPUTATION": [
PyFunceble.storage.STATUS.sane,
PyFunceble.storage.STATUS.malicious,
],
"AVAILABILITY": [
PyFunceble.storage.STATUS.up,
PyFunceble.storage.STATUS.down,
PyFunceble.storage.STATUS.invalid,
],
}
SOURCE_FILE: str = PyFunceble.cli.storage.COUNTER_FILE
@FilesystemJSONBase.fetch_dataset_beforehand
def get_sorted_dataset(self) -> List[Tuple[str, float]]:
"""
Provides the datasets in a sorted manner.
"""
return (
ListHelper(
[(x, y) for x, y in self.dataset["percentage"].items() if x != "total"]
)
.custom_sort(key_method=lambda x: x[-1], reverse=True)
.subject
)
@FilesystemJSONBase.fetch_dataset_beforehand
def get_dataset_for_printer(self) -> List[Dict[str, Union[str, int]]]:
"""
Provides the dataset that the printer may understand.
:raise ValueError:
When the current testing mode is not supported (yet?).
"""
result = {}
testing_mode = PyFunceble.cli.utils.testing.get_testing_mode()
if testing_mode not in self.PERCENTAGE_STATUSES:
raise ValueError("<testing_mode> ({testing_mode!r}) is not supported.")
for status, value in self.dataset["counter"].items():
if (
status == "total"
or status not in self.PERCENTAGE_STATUSES[testing_mode]
):
continue
result[status] = {"status": status, "amount": value}
for status, value in self.dataset["percentage"].items():
if (
status == "total"
or status not in self.PERCENTAGE_STATUSES[testing_mode]
):
continue
result[status]["percentage"] = f"{round(value)}%"
# Apply the right order.
return [result[x] for x in self.PERCENTAGE_STATUSES[testing_mode]]
@FilesystemJSONBase.update_source_file_path_beforehand
@FilesystemJSONBase.fetch_dataset_beforehand
@FilesystemJSONBase.save_dataset_afterwards
def count(self, status: CheckerStatusBase) -> "FilesystemCounter":
"""
Starts the counting process.
:param status:
The status to count into our dataset.
"""
if not isinstance(status, CheckerStatusBase):
raise TypeError(
f"<status> should be {CheckerStatusBase}, {type(status)} given."
)
if "counter" not in self.dataset:
self.dataset = copy.deepcopy(self.STD_DATASET)
self.dataset["counter"][status.status] += 1
self.dataset["counter"]["total"] += 1
for key in self.dataset["percentage"]:
if key == "total":
continue
self.dataset["percentage"][key] = (
self.dataset["counter"][key] * 100
) / self.dataset["counter"]["total"]
self.dataset["percentage"]["total"] = sum(
y for x, y in self.dataset["percentage"].items() if x != "total"
)
return self
|
