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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides an interface for version comparison or manipulation.
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.
"""
from typing import List, Optional, Tuple
import packaging.version
from PyFunceble.helpers.directory import DirectoryHelper
from PyFunceble.helpers.file import FileHelper
class VersionUtility:
"""
Provides an interface to compare or manipulate a version.
:param local_version:
The local version to work with.
:ivar local_version:
The version we are currently working with.
"""
_local_version: Optional[str] = None
def __init__(self, local_version: Optional[str] = None) -> None:
if local_version:
self.local_version = local_version
@property
def local_version(self) -> Optional[str]:
"""
Provides the current state of the :code:`_local_version` attribute.
"""
return self._local_version
@local_version.setter
def local_version(self, value: str) -> None:
"""
Sets the local version to work with.
:param value:
The local version to work with.
:raise TypeError:
When :code:`value` is not :py:class:`str`.
"""
if not isinstance(value, str):
raise TypeError(f"<value> should be {str}, {type(value)} given.")
self._local_version = value
@property
def real_local_version(self) -> str:
"""
Provides the real local version.
"""
return self.get_real_parsed_version(self.local_version)
def set_local_version(self, value: str) -> "VersionUtility":
"""
Sets the local version to work with.
:param value:
The local version to work with.
"""
self.local_version = value
return self
@staticmethod
def get_splitted(version: str) -> Tuple[List[str], str]:
"""
Splits the version from its code name.
:param version:
The version to split.
:return:
A tuple. The first index is the digit part of the version,
when the second one is the the non-digit part of the
version.
As example if :code:`1.0.0. Hello World` is given, this method
will output:
::
([1,0,0], " Hello World")
"""
splitted_version: List[str] = version.split(".")
def get_version_part() -> List[str]:
"""
Provides the version part.
"""
return [x for x in splitted_version if x.isdigit() or x[0].isdigit()]
def get_codename_part() -> str:
"""
Provides the codename part.
"""
try:
return [
x
for x in splitted_version
if not x.isdigit() and not x[0].isdigit()
][0]
except IndexError:
return ""
return get_version_part(), get_codename_part()
def get_real_parsed_version(self, version: str) -> str:
"""
Provides the real version to work with.
:param version:
The version to parse.
"""
return ".".join(self.get_splitted(version)[0])
def literally_compare(self, upstream_version: str) -> bool:
"""
Compares :code:`new_version` with the given base version.
:param new_version:
The new version to compare with.
:return:
- :code:`True`: base version == upstream version
- :code:`False`: base version != upstream version
"""
return self.local_version == upstream_version
def is_older_than(self, upstream_version: str) -> bool:
"""
Compares if the local version is older that the given one.
"""
return packaging.version.parse(
self.real_local_version
) < packaging.version.parse(self.get_real_parsed_version(upstream_version))
def is_equal_to(self, upstream_version: str) -> bool:
"""
Compares if the local version is equal the given one.
"""
return packaging.version.parse(
self.real_local_version
) == packaging.version.parse(self.get_real_parsed_version(upstream_version))
def is_recent(self, upstream_version: str) -> bool:
"""
Compares if the upstream version is older that the given one.
"""
return packaging.version.parse(
self.get_real_parsed_version(upstream_version)
) < packaging.version.parse(self.real_local_version)
def is_dev(self) -> bool:
"""
Checks if the local version is the dev one.
"""
return self.get_splitted(self.local_version)[-1].strip().startswith("dev")
def is_master(self) -> bool:
"""
Checks if the local version is the master one.
"""
return self.get_splitted(self.local_version)[-1].startswith(" ")
@staticmethod
def is_cloned() -> bool: # pragma: no cover ## Only used by 1 thing for dev.
"""
Checks if the local version is a cloned (from git) one.
"""
file_helper = FileHelper()
directory_helper = DirectoryHelper()
if not directory_helper.set_path(".git").exists():
return False
list_of_files = [
".coveragerc",
".gitignore",
"alembic.ini",
"CODE_OF_CONDUCT.md",
"CONTRIBUTING.md",
"CONTRIBUTORS.md",
"MANIFEST.in",
"README.md",
"requirements.txt",
"setup.py",
"version.yaml",
]
list_of_dirs = ["docs", "PyFunceble", "tests", ".github"]
if not all(file_helper.set_path(x).exists() for x in list_of_files):
return False
if not all(directory_helper.set_path(x).exists() for x in list_of_dirs):
return False
return True
|
