dropbox / dropbox-sdk-python

The Official Dropbox API V2 SDK for Python
https://www.dropbox.com/developers
MIT License
930 stars 318 forks source link

Alternative to pending_upload when using sharing_create_shared_link_with_settings? #476

Open nk9 opened 1 year ago

nk9 commented 1 year ago

The method sharing_create_shared_link has a pending_upload argument which you can use to ask Dropbox to generate a url for a file or folder which is still in the process of being uploaded. If you do this and then use the link before the file is fully uploaded, you see a nice "This file cannot be previewed" UI, showing a zero-byte file. Once the file upload is complete, you can use the URL to share as you would any other generated URL.

This is fine, but sharing_create_shared_link is marked as deprecated and has been replaced by sharing_create_shared_link_with_settings. The new method doesn't have the pending_upload argument, nor does there seem to be any setting which you can pass in to get the same behavior.

So my question is: how do I get a shared link from a pending upload using non-deprecated API? I am not doing any uploading myself, I just have a script which generates shared links. So I can't do a zero-length upload because it could clobber the in-progress one which I have no control over.

Versions

OnionKnightN commented 1 year ago

Hello nk9! Unfortunately there isn't pending_upload parameter for the sharing_create_shared_link_with_settings method. That said, I can totally see the benefit of this use case. Therefore, I've help submit a feature request on your behalf over to our product team for review.

nk9 commented 1 year ago

Thanks! I'd also like to point out that the Python docs for sharing_create_shared_link don't list the method as deprecated. Probably a good idea to call that out if indeed you want people to ultimately stop using it. Other methods put the deprecation warning in the text, but there is a Sphinx directive for deprecation which you can use so it will show up nicely formatted in ReadTheDocs.

greg-db commented 1 year ago

Thanks for the note! I'll ask the team to update the documentation to include that deprecation information.