Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abstract away the difference between a download and a download result, i.e. remove and purge #30

Closed
pawamoy opened this issue Oct 14, 2019 · 1 comment
Labels
module:api question Further information is requested

Comments

@pawamoy
Copy link
Owner

pawamoy commented Oct 14, 2019

I think it would make aria2p easier to understand and use. Currently we "remove" downloads and "purge" download results. I'd like to get rid of the "purge" methods and only use "remove". The "remove" methods would be smart enough to know if we have to internally purge or remove, based on the download object status.

I think it would simplify things, but maybe it's a not a good idea. Any thoughts, users of aria2p?

@pawamoy pawamoy changed the title Abstract away the difference between a download and a download result Abstract away the difference between a download and a download result, i.e. remove and purge Oct 14, 2019
@pawamoy pawamoy added module:api question Further information is requested labels Oct 14, 2019
@pawamoy
Copy link
Owner Author

pawamoy commented Oct 15, 2019

I went ahead and planned things like this:

  • deprecation warnings are immediately added to API.purge, API.purge_all and "purge" command
  • in version 0.7.0, API.purge, API.purge_all and "purge" command are removed
  • change warnings are immediately added but only printed between version 0.7 and 0.9.0 to "autopurge" command and API.autopurge, informing they will be renamed "purge"
  • in version 0.9.0, API.autopurge and "autopurge" command are renamed "purge", to really reflect what aria2 does. "purge" command might get an "autoremove" alias.

In summary:

  • now: deprecation and future change warnings
  • v0.7.0: remove API.purge and API.purge_all
  • v0.9.0: rename API.autopurge to API.purge and "autopurge" command to "purge" + "autoremove" alias

@pawamoy pawamoy closed this as completed Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module:api question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant