Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #310
This is a breaking change as it switches from positional arguments to a single argument with property-based parameters.
The provider interface is quite simple and I don't expect it would need to be extended in the future. Luckily
arctic's design is quite nice where most of the per-provider custom logic is hidden away internally in the provider or requested through the constructor, so these common methods are quite standard. However, if the need ever arose, it could be extended to support some new provider field without a breaking change for the existing providers. If there were one that was really off the walls you could still implement a custom class without implementing the interface, but again I don't forsee that as ever being necessary.If we wanted to avoid breaking existing users and make for an easier migration path we could leave the existing methods with positional arguments in place alongside the new methods and could simply have one call the other.
I put
OAuth2in the class names, but am not 100% sure that's correct or if arctic could possibly be used with OAuth 1 as well, so am open to renaming those.I didn't update the docs yet as I wanted feedback on this change before doing so, but would be happy to update the docs if you're amenable to this change.
DO NOT DELETE THIS SECTION.
Thank you for creating a pull request!
If your pull request is just making changes to the docs, please create it against the
mainbranch.If your pull request is making changes to the library source code, please create it against the
nextbranch. If your pull request adds a new feature to the library, please open a new issue first.If you're unsure, you can just create it against the
mainbranch.