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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the list helpers
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 Any, List, Optional
class ListHelper:
"""
Simplify the list manipulation.
:param subject:
The list to work with.
:param bool remove_empty: Process the deletion of empty strings.
"""
_subject: Optional[List[Any]] = None
def __init__(self, subject: Optional[List[Any]] = None):
if subject is not None:
self.subject = subject
@property
def subject(self):
"""
Provides the current state of the :code:`_subject` attribute.
"""
return self._subject
@subject.setter
def subject(self, value: List[Any]) -> None:
"""
Sets the subject to work with.
:param value:
The subject to work with.
:raise TypeError:
When :code:`value` is not a :py:class:`list`.
"""
if not isinstance(value, list):
raise TypeError(f"<value> should be {list}, {type(value)} given.")
self._subject = copy.deepcopy(value)
def set_subject(self, value: List[Any]) -> "ListHelper":
"""
Sets the subject to work with.
:param value:
The subject to work with.
"""
self.subject = value
return self
def remove_empty(self) -> "ListHelper":
"""
Removes the empty entries of the given list.
"""
self.subject = [x for x in self.subject if x is None or x]
return self
def remove_duplicates(self) -> "ListHelper":
"""
Removes the duplicates of the current list.
"""
result = []
for element in self.subject:
if element not in result:
result.append(element)
self.subject = result
return self
def sort(self, *, reverse: bool = False) -> "ListHelper":
"""
Sorts the given list (of string preferably).
:param bool reverse: Tell us if we have to reverse the list.
"""
self.custom_sort(str.lower, reverse=reverse)
return self
def custom_sort(self, key_method: Any, *, reverse: bool = False) -> "ListHelper":
"""
Sorts the list with the given key method.
:param key_method:
A function or method to use to format the
readed element before sorting.
:type key_method: function|method
:param bool reverse: Tell us if we have to reverse the list.
"""
self.subject = sorted(self.subject, key=key_method, reverse=reverse)
return self
|
