Base
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all our downloader.
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.
DownloaderBase
Provides the base of all downloader classes.
The interface is actually simple, but the part which may be hard to understand is the "downtime" part. What we do, is that we save the download time inside a JSON file, so this class provides the base around the download mechanism but also the generation or update of that JSON file.
Source code in PyFunceble/downloader/base.py
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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
|
DOWNLOAD_FREQUENCY: int = 1
class-attribute
instance-attribute
The download frequency (in day).
Example: if 1 is given, it's once every 24 hours.
.. warning::
A frequency of :code:0
or a negative number will force the download
every hour.
DOWNTIME_INDEX: Optional[str] = None
class-attribute
instance-attribute
Used to set/track the download time of the current file.
all_downtimes: Optional[dict] = {}
class-attribute
instance-attribute
Stores the download time of all files (self managed).
authorized: bool
property
Provides the authorization to start the download.
destination: Optional[str]
property
writable
Provides the current state of the :code:_destination
attribute.
download_link: Optional[str]
property
writable
Provides the current state of the :code:_download_link
attribute.
get_all_downtimes()
get_current_downtime()
Provides the download times of the current :code:DOWN_TIME_INDEX
.
is_downtime_set()
Checks if the download time of the current object exists.
Source code in PyFunceble/downloader/base.py
is_last_download_expired()
Checks if the last downloaded file is expired (if exists).
Source code in PyFunceble/downloader/base.py
save_all_downtimes()
Saves the current state of the all downtimes.
set_current_downtime()
Sets the current datetime into our registry.
Source code in PyFunceble/downloader/base.py
set_destination(value)
Sets the destination.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value
|
str
|
The value to set. |
required |
set_download_link(value)
Sets the link to download.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value
|
str
|
The value to set. |
required |
start()
Starts the download process.