Skip to main content

Improves work with web files downloading.

Project description

PyLoader.

Python library for downloading files by URL’s. Fast and easy. Uses only Python STDLIB.

Examples.

Simple download.

from pyloader import PyLoader


url = 'https://yt3.ggpht.com/1yafclomM37uN64INRwmmWPC7kT0OXwx6W5Or4JRs5eRrlGAXYD2x6thKfyrK_mf493GkScfUV5P7g=s742-nd-v1'
out = 'pic.png'

file = PyLoader.download(url, out)

print(f'{out} downloaded.')
https://github.com/xzripper/PyLoader/blob/main/simple.gif?raw=true

No progress bar download.

from pyloader import PyLoader


url = 'https://yt3.ggpht.com/1yafclomM37uN64INRwmmWPC7kT0OXwx6W5Or4JRs5eRrlGAXYD2x6thKfyrK_mf493GkScfUV5P7g=s742-nd-v1'
out = 'pic.png'

file = PyLoader.pdownload(url, out)

for data in file:
   print(PyLoader.util_format(data))
https://github.com/xzripper/PyLoader/blob/main/nopb.gif?raw=true

TQDM Progress Bar.

from pyloader import PyLoader

from tqdm import tqdm


url = 'https://yt3.ggpht.com/1yafclomM37uN64INRwmmWPC7kT0OXwx6W5Or4JRs5eRrlGAXYD2x6thKfyrK_mf493GkScfUV5P7g=s742-nd-v1'
out = 'pic.png'

pic = PyLoader.pdownload(url, out)

progress_bar = tqdm()

for download_info in pic:
   if download_info:
      if progress_bar.total == None:
            progress_bar.total = download_info['totalbytes']

     progress_bar.update(download_info['size_written'])
https://github.com/xzripper/PyLoader/blob/main/withtqdm.gif?raw=true

As you see, using PyLoader is very easy.


PyLoader Documentation.

# Static Functions & Variables (from pyloader import ...).
VERSION = 1.0

_percentage(current: int, maximal: int, _round: bool=False) -> int
_convsize(_bytes: int, chunk: int=1024) -> str

# PyLoader Functions & Variables (from pyloader import PyLoader).
# All PyLoader functions and variables are static. It means you can call functions without initializing PyLoader.
PyLoader.CHUNK = 1024

PyLoader.temp_files = []

@staticmethod PyLoader.download(url: str, out: str) -> bool
@staticmethod PyLoader.pdownload(url: str, out: str, round_progress: bool=False) -> dict

@staticmethod webfile(url: str, _type: str) -> str

@staticmethod PyLoader.util_format(download_info: Union[bool, dict]) -> Union[bool, str]

@staticmethod PyLoader.update_chunk(new_chunk: int) -> None

VERSION: Version of PyLoader.

_percentage: Calculate percentage. (_percentage:47, 100, True) -> 10%.<br> _convsize: Converting bytes into another file sizes. (_convsize:1024) -> 1.0kb.

PyLoader.CHUNK: PyLoader default download chunk.

PyLoader.temp_files: Temporary files generated by webfile.

PyLoader.download: The “simple” download. Downloads file from URL into {out}. Already handles exceptions: HTTPError, URLError, SSLCertVerificationError, ValueError.

PyLoader.pdownload: Download file with ability to track things like: already downloaded percentage, downloaded bytes, file size, etc.

Yields (‘yield [value]’ in Python) dict with these values:

percentage (downloaded percentage), current_progress (current progress - downloaded bytes), size_written (bytes was written in this chunk loading), size (size of file), totalbytes (size of file in bytes), chunk (chunk), time_wasted (wasted time to load chunk in nanoseconds), success (is chunk loaded successfully).

Also handles exceptions: HTTPError, RequestHTTPError, RequestConnectionError, MissingSchema, (SSLError?).

PyLoader.webfile: Downloads file from URL and places downloaded into system temporary folder. Returns tuple with path to temporary file, is file downloaded successfully. PyLoader.clear_temp_files: Clear temporary files generated by webfile.

PyLoader.util_format: Format download information. Converts dictionary with information to string. If `download_info` (first argument) is bool, function will return the same bool.

PyLoader.update_chunk: Update default PyLoader chunk.

Notes.

You can customize your progress bar just by using values from download information, you also can customize messages, etc by yourself, how to do it: util_format source code. You also can use PyLoader static functions like _percentage, for your goals. These functions can be really useful. Report any errors to project issues.

XXX: GitHub.


PyLoader MIT License v1.3.1.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pywebloader-1.3.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page