v2.1.0

Enhancements

• Add a customizable callback function for when download completed @dreamflasher (#127)
• Add callbacks for ftp downloads @samaloney (#150)
• Drop Python 3.7 as it's EOL @Cadair (#149)
• Only log get_ftp_size errors at INFO @Cadair (#148)

Bug Fixes

• Fixes signal that only works in main thread of the main interpreter @AthKouloumvakos (#133)
• fix aiohttp redirect @dreamflasher (#126)

Misc/Internal Changes

• Add typing to utils @dstansby (#139)
• Fix test issue where warning was being raised but not captured @samaloney (#151)
• Add devdeps build with aiohttp dev @dstansby (#138)
• Fix actually running pytest in tox @Cadair (#136)
• Make sure tox-conda is installed @Cadair (#113)

v2.0.2

Changes

• Vendor parse_header out of the deprecated cgi module for Python 3.11 compatibility @Cadair (#112)

Documentation and code quality

• Fix typos @kianmeng (#107)

v2.0.1

Changes

Bug Fixes

• Fix a bug where an asyncio.CancelledError was not properly caught @Cadair (#106)

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

v2.0.0rc4

Changes

• Cleanup after Keyboard interrupt correctly @Cadair (#104)
• Improve the CLI with more options @Cadair (#103)
• Improve docs for 2.0 release @Cadair (#102)

v2.0.0rc3

Changes

• Do not deprecate header kwarg to Downloader @Cadair (#101)

Enhancements

• Allow the user to override the aiohttp.ClientSession with a callback @Cadair (#99)

Misc/Internal Changes

• Do not use pydantic for settings validation @Cadair (#98)

v2.0.0rc2

Changes

• Fix a bug where only HTTP 200 response codes were accepted as success @SolarDrew (#95)
• [pre-commit.ci] pre-commit autoupdate @pre-commit-ci (#93)

v2.0.0rc1

Add a new `SessionConfig` object to allow advanced configuration of t…

…he `Downloader` (#92)

* Refactor API simplify config

* Further typehinting

* More docs

* We need the Literal backport on Python 3.7

* Deprecate headers= and use_aiofiles= Downloader kwargs

* Assorted fixes

* Allow configuration of log level in SessionConfig

* Configure black to 100 lines in the right place

* Bad black config

* timeouts cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Make sure that when progress is False we don't draw any progress bars

* Use pydantic for config validation

* Fix mypy

* Use platform

* More env var docs

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

v1.5.1

Changes

Bug Fixes

• Fix issue with small files where the size of a chunk would round down to 0 bytes @GitHK (#82)
• Remove the default download timeout of 5 minutes for a single file @Cadair (#81)
• Cast timeout environment variables to numbers @dstansby (#80)

Full Changelog: v1.5.0...v1.5.1

v1.5.0

Changes

• Add a Downloader.simple_download method to easily download a list of URLs to a single directory @Cadair (#73)

Bug Fixes

• Make path default to "./" so that it works without specifying it in simple_download @Cadair (#74)