Child Item

Not able to get team folders or files using python sdk

Python SDK,
Not Able to get files and folders
where I'm using dropbox business API access token

output = dbx.DropboxTeam(_dropbox_token).as_admin(ng_member_id).files_list_folder("").entries
print(output)

Trying this as suggested from the doc.
help me to do it
Trying to get files from a folder of folders and download the files.

Find more posts tagged with

Developers

Accepted answers

Greg-DB

What is the value of your '_team_name_space_id' variable?

Based on the error output you shared, if you want to list the contents of the team space, you should set your '_team_name_space_id' variable to "5632093280".

All comments

Greg-DB

[Cross-linking for reference: https://stackoverflow.com/questions/59877833/download-files-from-dropbox-team-folder-using-python-sdk/59884229?noredirect=1#comment105910967_59884229 ]

There are two things to note here that may be preventing you from listing everything you're expecting:

The files_list_folder method isn't guaranteed to return everything in the requested folder. You need to always check the returned ListFolderResult.has_more value and if it's True, call back to files_list_folder_continue to get more results, as documented in the files_list_folder documentation.
Dropbox API calls operate in the team member folder by default. If you're on a team with the team space configuration, that won't include your team space folders. You can access the team space though, using the 'Dropbox-API-Path-Root' header, as covered in the Namespace Guide. To set that in the Python SDK, you should use the with_path_root method. Your 'files_list_folder' code would then look something like:
```
output = dbx.DropboxTeam(_dropbox_token).with_path_root(dbx.common.PathRoot.root(team_space_namespace_id)).as_admin(ng_member_id).files_list_folder("").entries
print(output)
```

GopalN

Thanks for the solution,
I have tried the above code

dbx = dropbox.DropboxTeam(_dropbox_token).as_user(ng_member_id)
output = dbx.with_path_root(dropbox.common.PathRoot.root(_team_name_space_id)).files_list_folder("").entries
print(output)

Its giving me the error :

('8928caa6ce35a895296b45e5d694ddfe', 'Error in call to API function "files/list_folder": This API function operates on a single Dropbox account
t, but the OAuth 2 access token you provided is for an entire Dropbox Business team. Since your API app key has team member file access permissions, you can operate on a team member\'s Dropbox by providing the "Dropbox-API-Select-User" HTTP header or "select_user"

Note: I'm the admin and have Permission Type: Team Member file access in business API

Thanks for your solution.

Greg-DB

It looks like there's currently an issue with the Python SDK if you use 'as_user' or 'as_admin' before 'with_path_root'. I'll ask the team to fix that up.

As a workaround, please use 'with_path_root' before 'as_user' or 'as_admin', as in the example in my previous comment.

GopalN

When I try to do with your reference code this exist with error

dropbox.exceptions.PathRootError: PathRootError('8255e7bee11bfaa054cc966323944b00', PathRootError('invalid_root', TeamRootInfo(root_namespace_id='5632093280', home_namespace_id='6821388560'
, home_path='/Gopal N')))

please suggest the solution.

Greg-DB

What is the value of your '_team_name_space_id' variable?

Based on the error output you shared, if you want to list the contents of the team space, you should set your '_team_name_space_id' variable to "5632093280".

Greg-DB

For reference, the issue of not being able to use 'as_user' or 'as_admin' before 'with_path_root' should now be fixed as of v10.3.0 of the Dropbox Python SDK.

phermans

In your code sample, you use the variable

team_space_namespace_id

but I don't know what that is.....where do I get the id of the Team Folder? Is there a complete example of simply listing all the folders and files in a team folder using python?

Thanks

Greg-DB

@phermans The 'team_space_namespace_id' for a team using the team space configuration would be the 'root_namespace_id' value, e.g., as returned by /2/users/get_current_account. I recommend reviewing the Team Files Guide for more context if you haven't already.

In the Python SDK in particular, you can call that via users_get_current_account, so you can get that information from the returned FullAccount.root_info.

Hopefully that should fill in the missing piece for you so you can connect that with the rest of the code and information in the earlier comments in this thread, but let us know if something still isn't working for you.

phermans

@Greg-DB Thanks for the quick reply. I know you are trying to be helpful but I have tried reading most of the guides, and find them to be mostly not helpful.

So I jsut tried what you suggested, and what I could glean from the Python SDK...and it still won't work.

dbxt = dropbox.DropboxTeam(_dropbox_token).as_admin(_member_id)
full_accnt = dbxt.users_get_current_account()

yields an error that tells me little.....Error in call to API function "users/get_current_account": Invalid select user id format')

I don't know what a "select user id format" is, or where it is documented but it must make sense to someone who wrote this stuff.

So I looked at python sdk docs and find that it tells me this:

users_get_current_account()

Get information about the current user’s account.

Wonderful.....imagine that, a function called get users_get_current_account gets the current user's account! It apparently takes no arguments and it apparently doesn't work for some esoteric reason.

Sorry for the rant, but this has already cost hours of time to attempt to do the most basic thing - get a list of files and folders in the team folder.

I will continue to guess and check until my token expires (yet again) and I waste a few more hours but after that I will probably say the hell with Dropbox API, it doesn't appear to be worth the time to learn it.

Greg-DB

@phermans Thanks for the feedback!

I see you're currently getting the error:

Invalid select user id format

That's referring to the value you're passing to identify the particular user account from the team to operate on, which in your case is via the as_admin method to which you're supplying your variable '_member_id'. So, it appears your '_member_id' value is not valid. That value should be a "team member ID" (which starts with "dbmid:"). You can get the team member IDs from a number of places on the API, such as team_members_get_info and team_members_list/team_members_list_continue. It's returned in the TeamMemberProfile.team_member_id field.

Also, note that API calls for teams using the team space configuration default to the "team member folder", not the "team space". You can access the team space though by setting the relevant root. You can do so via the with_path_root method. (You mentioned reviewing some guides, but just in case you missed this one, the Team Files Guide would be the most relevant to this part.)

So, putting that all together, it sounds like this is what you're looking to do:

import dropbox

_dropbox_token = "<ACCESS_TOKEN>"
admin_email = "<EMAIL_ADDRESS>"

dbx_team = dropbox.DropboxTeam(_dropbox_token)

_member_id = dbx_team.team_members_get_info([dropbox.team.UserSelectorArg.email(admin_email)])[0].get_member_info().profile.team_member_id

dbx_admin = dbx_team.as_admin(_member_id)

root_namespace_id = dbx_admin.users_get_current_account().root_info.root_namespace_id

dbx_admin_team_root = dbx_admin.with_path_root(dropbox.common.PathRoot.root(root_namespace_id))

listing = dbx_admin_team_root.files_list_folder('')
for entry in listing.entries:
    print(entry.name)

while listing.has_more:
    listing = dbx_admin_team_root.files_list_folder_continue(listing.cursor)
    for entry in listing.entries:
        print(entry.name)

Hope this helps!

phermans

@Greg-DB Thanks again! Yes it helped a lot. I accidentally forgot to include the dbmid: part......silly me. I really appreciate your help. I will give it a go a bit later today and hopefully make more progress.

Thanks again!

phermans

@Greg-DB , I got that part working, but don't totally understand one part, hoping I missed it in the docs somewhere, or that there is a simple explanation. In the code you posted, there was both a for loop and a while loop...

for entry in listing.entries:
    print(entry.name)

while listing.has_more:
    listing = dbx_admin_team_root.files_list_folder_continue(listing.cursor)
    for entry in listing.entries:
        print(entry.name)

Not sure I understand why i need both of those. Seems like the initial for loop only gets some of the folders/files.....then the while keeps asking for more....but if that is correct, why even bother with the first for loop, why not just use the while listing.has_more loop? Wouldn't that just keep going until all the files/folders were returned, and in this case, had their names printed?

Thanks for clarifying.

Greg-DB

@phermans In order to scale to folder listings of any size, the list_folder interface is paginated. The API may return the results across multiple pages, and each page can contain multiple files/folders. You need to implement calls to both files_list_folder and files_list_folder_continue to make sure you can receive all of the entries.

The first for loop iterates over the results on the first page, from files_list_folder; the while loop then has the app make additional calls to files_list_folder_continue as needed, and the second for loop iterates over the results from those subsequent pages, if any, from files_list_folder_continue.

Check out the files_list_folder documentation for more information on using this functionality.

mukesh111

output = dropbox.DropboxTeam(TOKEN).with_path_root(dropbox.common.PathRoot.root(team_space_namespace_id)).as_admin(member_id).files_list_folder("").entries

what is the team_space_namespace_id here? I use a 10-digit number

Traceback (most recent call last):
File "/home/mukesh/Documents/automation/app_test/dropbox/test_dropbox.py", line 20, in <module>
output = dropbox.DropboxTeam(TOKEN).with_path_root(dropbox.common.PathRoot.root(team_space_namespace_id)).as_admin(member_id).files_list_folder("").entries
File "/home/mukesh/Documents/BOVIWALK/projects/pose_estimation/boviwalk-ai/venv/lib/python3.10/site-packages/dropbox/base.py", line 2145, in files_list_folder
r = self.request(
File "/home/mukesh/Documents/BOVIWALK/projects/pose_estimation/boviwalk-ai/venv/lib/python3.10/site-packages/dropbox/dropbox_client.py", line 326, in request
res = self.request_json_string_with_retry(host,
File "/home/mukesh/Documents/BOVIWALK/projects/pose_estimation/boviwalk-ai/venv/lib/python3.10/site-packages/dropbox/dropbox_client.py", line 476, in request_json_string_with_retry
return self.request_json_string(host,
File "/home/mukesh/Documents/BOVIWALK/projects/pose_estimation/boviwalk-ai/venv/lib/python3.10/site-packages/dropbox/dropbox_client.py", line 596, in request_json_string
self.raise_dropbox_error_for_resp(r)
File "/home/mukesh/Documents/BOVIWALK/projects/pose_estimation/boviwalk-ai/venv/lib/python3.10/site-packages/dropbox/dropbox_client.py", line 643, in raise_dropbox_error_for_resp
raise PathRootError(request_id, err)
dropbox.exceptions.PathRootError: PathRootError('b0bc4fd1e82647deae8616b37255c2cc', PathRootError('invalid_root', TeamRootInfo(home_namespace

Здравко

Hi @mukesh111,

Take a look on Greg's post on this page top. There is pretty clear where 'team_space_namespace_id' comes from. Try reproduce something similar. 😉 One more thing, at present access token is 'short lived' only. If you need long term access, refresh token may be object of consideration from your side.

Hope this helps.

mukesh111

Thanks for the reference it helped. I see that there are solutions to download files are recreate the whole structure and downloading them. Is there a single function that can handle downloading a complete directory

ex: I want to download a whole FolderA with (subfolder1, subfolder2, subfolder3)

I could only find the below for files is there for folders by any chance?:

dbx_admin_team_root.files_download_to_file()

Здравко

Hi again @mukesh111,

You can download a folder as zip file. You can use the zip stream using files_download_zip and unzip the content on fly or save it as file using files_download_zip_to_file. 😉

Good luck.