v2.0.0

This new major version of parfive tackles the usability of the API.

The API of parfive grew organically as support for more use cases were added.
To enable both a highly flexible downloader that can be used for any HTTP/FTP downloads while maintaining an accessible and simple API with the 2.0 release there is now a parfive.SessionConfig object where advanced settings are located.

The other major change in this release is that any files where the download failed before it is completed will be removed from disk. This means that you shouldn't end up with incomplete and corrupt files on disk if the download is interrupted for any reason.

Breaking Changes

• The file_progress, notebook, use_aiofiles, and header keyword arguments to parfive.Downloader have been removed and moved into the parfive.SessionConfig object.
• The timeouts keyword argument has been removed from the run_download() and download() methods and replaced by an option in SessionConfig.

Enhancements

• Improve repr of Results, remove files from disk if download errors before completing and add max_splits as a keyword argument to Downloader by @nabobalis in #76
• Add a new SessionConfig object to allow advanced configuration of the Downloader by @Cadair in #92
  • A new PARFIVE_HIDE_PROGRESS environment variable will disable all progress bars.
  • All environment variables are now evaluated at the time the Downloader class is instantiated (by the new config classes).
  • It is now possible to customise the instantiation of the aiohttp.ClientSession by passing a function to the aiohttp_session_generator= keyword argument to SessionConfig.
  • It is now possible to configure debug or other levels of logging with SessionConifg where previously it could only be configured with an environment variable.
  • It is now possible to configure the HTTP chunksize with SessionConfig and the default when not using aiofiles has been increased from 100 bytes to 1024 bytes.
  • It is now possible to configure the HTTP(S) proxy URLs with SessionConfig as well as the HTTP[S]_PROXY environment variables.
  • It is now possible to customise all the timeouts supported by aiohttp by passing an aiohttp.ClientTimeout object to SessionConfig.
• Improve the CLI with more options by @Cadair in #103
• Cleanup after Keyboard interrupt correctly by @Cadair in #104
  • This means that the download will be killed correctly when the download is interrupted.
  • Note that is does not work on Windows due to the lack of support for signal handling in asyncio on Windows.
• Remove deprecated loop keyword argument by @Cadair in #88
• Use tqdm's auto notebook detection by @Cadair in #90

Bug Fixes

• Do not split download if no "Content-length" by @rlaker in #87
• Do not overwrite custom headers if user agent isn't specified by @Cadair in #89
• Fix a bug where only HTTP 200 response codes were accepted as success by @SolarDrew in #95

Misc/Internal Changes

• Add a Python 3.10 build and configure pre-commit.ci by @Cadair in #83
• Improve docs for 2.0 release by @Cadair in #102
• Use black by @Cadair in #91

New Contributors

• @rlaker made their first contribution in #87
• @SolarDrew made their first contribution in #95

Full Changelog: v1.5.1...v2.0.0