上傳與下載檔案

在熟悉 Dropbox 的認證程序 (Authentication) 後，接著我們來學習如何上傳、條列與下載檔案。

你可以拿底下的範本來練習 (來自 Dropbox Python SDK Docs):

有關如何取得 App key 與 App secret，請參考「建立 app 取得 App key 與 App Secret」一文

上傳檔案

檔案的上傳很簡單:

put_file 這個 method 需要 2 個參數，第 1 個參數指定檔案在 Dropbox 上的存放路徑，第 2 個參數是一個 file object，也可以是 string。如果成功上傳，sample.txt 會被放在 app folder 或者 Dropbox 的根目錄下 (根據你的 app 的 access type 而定)。在 response 中，會有剛剛上傳的檔案的 metadata，內容會像這樣:

條列檔案或資料夾的 metadata

假設使用者 app folder 的檔案結構如下，裏面包含一個空的資料夾 Sample Folder 以及剛剛上傳的 sample.txt:

我們可以針對檔案或資料夾呼叫 metadata:

就會得到類似這樣的結果:

從 metadata 中你可以獲得很多資訊，例如完整的檔案路徑 (path)，file sizes (bytes)，上次修改日期 (modified) 等。

假如要知道資料夾有沒有變動，我們要自行保存並比較 hash。

下載檔案

檔案的下載也很簡單，只要呼叫 get_file_and_metadata:

get_file_and_metadata 會傳回兩個值，一個是檔案的資料，另一個是檔案的 metadata。你必須呼叫 .read() 才能取得檔案的內容。

總結

底下是本文的完整程式碼，使用之前記得先建一個 sample.txt，並且輸入你的 app ket, app secret 與 access type 。

參考資料

• Dropbox Python SDK Docs

Dropbox SDK 範例中文支援

前幾天把玩了一下 Dropbox SDK 範例，有網友反應，說 Dropbox 官方的 web_upload_app.py 是可以上傳檔案到 Dropbox，但是如果檔名裏有中文，上傳就會失敗。我發現，不只 web_upload_app.py，cli_client.py 也有同樣的問題。

我做了一個新的版本，用這個版本，現在就算檔名有中文也沒問題了。你可以點底下的連結下載檔案:

cli_client.py

web_upload_app.py

我是拿 dropbox-python-sdk-1.5.1 的版本來改的，底下摘要說明我修改的地方:

cli_client.py

這支程式我只動到兩三行，全部都在 DropboxTerm 的 do_put() method 裏。新舊版程式碼對照如下 (註: 簡單起見，底下拿掉了程式文件說明):

舊版:

新版:

web_upload_app.py

這支程式只動到 ExampleHandler 的 upload_page() method。新舊版程式碼對照如下:

舊版:

新版:

參考資料

• 把玩 Dropbox SDK 範例

Authentication

這篇說明如何用 Python SDK 去跟 Dropbox 進行認證。Dropbox 用的認證通訊協定是 OAuth 1.0 (Open Authentication Protocol)。網路上有很多的資料和 libraries 可以讓你用 OAuth 去跟 Dropbox 認證，但我們不必從零開始，因為 Dropbox 提供的 Python SDK 很簡單，只要三個步驟就可以搞定。

註: 本文內容大部份取自 Dropbox developers 網站

在開始之前，我們必須先做兩件準備工作：

第 1 件: 準備 App key 和 App secret

首先，你必須準備好 app key 和 app secret 以及 app 所用的 access type:

# Get your app key and secret from the Dropbox developer website
APP_KEY = 'INSERT_APP_KEY_HERE'
APP_SECRET = 'INSERT_SECRET_HERE'

# ACCESS_TYPE should be 'dropbox' or 'app_folder' as configured for your app
ACCESS_TYPE = 'INSERT_ACCESS_TYPE_HERE'

有關如何取得 App key 與 App secret，請參考「建立 app 取得 App key 與 App Secret」一文。

第 2 件: 建立認證用的 session 物件

接著我們必須建立一個 session 物件。session 物件主要是負責認證的工作。在建立 session 物件時，記得把 App key, App secret 和 access type 一併傳入，同時引用 Dropbox SDK 的 libraries:

# Include the Dropbox SDK libraries
from dropbox import client, rest, session

# Create a session object for holding OAuth authentication info
sess = session.DropboxSession(APP_KEY, APP_SECRET, ACCESS_TYPE)

前面提到，認證只要三個步驟，這三個步驟是:

1. 取得 request token
2. 使用者授權給 reqeust token
3. 用 request token 來交換 access token

底下說明分別說明:

Step 1: 取得 request token

取得 request token 的方法很簡單，只要呼叫 obtain_request_token 這個 SDK method 即可:

request_token = sess.obtain_request_token()

Step 2: 使用者授權給 reqeust token

取得 request token 後，接著就要請使用者授權給 app。方法是導引使用者到 Dropbox 網站取得他的同意，request token 要傳到 build_authorize_url 建立一個授權用的 URL，像這樣:

url = sess.build_authorize_url(request_token)
print "url:", url
print "Please visit this website and press the 'Allow' button, then hit 'Enter' here."
raw_input()

上面只是印出 URL 然後請使用者在授權完畢後按個 Enter 鍵，這是為了方便說明，在實際的應用中，通常我們會直接顯示 Dropbox 的認證網頁，而且可能會順便傳入一個 callback URL，以便在使用者同意授權之後就直接跳轉回到你的應用程式。

當使用者瀏覽 build_authorize_url 產生的 URL 時，Dropbox 會確認使用者以他的帳戶登入，並且呈現一個像底下這樣徵詢同意的畫面:

為了避免有心人士非法取得授權，Dropbox 提供的 requst token 使用壽命只有 5 分鐘，所以如果使用者沒有在 5 分鐘之內授權，request token 就會失效，必須重新取得。

Step 3: 用 request token 來交換 access token

一旦取得使用者的授權，我們就可以拿 request token 來交換 access token，方法是透過 obtain_access_token 這個 SDK method:

# This will fail if the user didn't visit the above URL and hit 'Allow'
access_token = sess.obtain_access_token(request_token)

access token 就是 app 之後用來向 Dropbox 發任何 API requests 所需的，必須妥善保存。如果把 access token 保存起來的話，你就不需要再重覆前面這些步驟，除非使用者重新安裝你的 app。

好了，認證工作完成後，接下來就簡單了，當你要存取使用者的 Dropbox 資源時，只要把 session 物件傳給 DropboxClient 就可以了。例如，當我們呼叫 account_info 時，這個 method 就會回傳一個以 dictionary 保存的使用者的帳戶資訊:

client = client.DropboxClient(sess)
print "linked account:", client.account_info()

底下是用 pprint 印出帳戶資訊的一個例子:

總結

當你看到這邊，你就已經學會 Dropbox API 的認證，這是使用 Dropbox API 最基本而且也是最重要的一堂課。底下是完整的範例:

參考資料

• Adding authentication to your app

把玩 Dropbox SDK 範例

Dropbox 官方 Python SDK 附帶了一些範例，位於 example 資料夾中：

其中 cli_client.py 是一個 Dropbox 的指令介面工具，而 web_upload_app.py 則可以讓你透過 Web 上傳檔案到 Dropbox，這兩個範例很適合入門，我們來看怎麼使用這兩個範例。

設定 App key 與 App secret

要執行這些範例，我們需要修改範例程式填入事先申請的 App key 與 App secret，並且輸入 app 所用的 access type:

# XXX Fill in your consumer key and secret below
# You can find these at http://www.dropbox.com/developers/apps
APP_KEY = 'XXX'
APP_SECRET = 'XXX'
ACCESS_TYPE = 'app_folder' # should be 'dropbox' or 'app_folder' as configured for your app

有關如何取得 App key 與 App secret，請參考「建立 app 取得 App key 與 App Secret」一文。

cli_client.py

cli_client.py 是一個 Dropbox 的指令介面工具，可以讓使用者以指令的方式上傳下載檔案。cli_client.py 的使用方法大致如下：

Step 1: 執行方式：

python cli_client.py

Step 2: 載入程式後，可以下 help 指令看有哪些指令可用：

Step 3: 第一次使用必須輸入 login 進行登入：

如上圖紅框處，輸入 login 後會自動產生一個 URL，請複製貼到瀏覽器上訪問這個 URL，接著 Dropbox 會詢問你要不要授權給 app，此時請點選 Allow:

授權後，網頁會出現成功的訊息：

Step 4: 回到 cli_client.py 的畫面，按下 Enter 鍵，這時候 Dropbox 會出多 Apps > a-demo-app 這一層資料夾：

Step 5: 之後便可以下指令來操作使用者的 a-demo-app 這個資料夾的內容了。你可以下 account_info 指令取得帳戶資訊：

下載檔案要用 get 指令，上傳檔案用 put 指令，要刪除檔案或資料夾用 rm 指令。至於指令的用法請用 help 指令查看說明文件。

web_upload_app.py

web_upload_app.py 是一個可以讓你透過 Web 上傳檔案到 Dropbox 的工具。web_upload_app.py 的使用方法大致如下：

Step 1: 執行方式：

python web_upload_app.py

執行後，程式會要求你打開瀏覽器連到 http://localhost:8000

▲ Web Server 預設開啟在 port 8000，你可以再加一個參數自行決定要用哪個 port number

Step 2: 打開瀏覽器連到 http://localhost:8000

Step 3: 一樣，Dropbox 會詢問你要不要授權給 app，此時請點選 Allow:

 

Step 4: 通過授權後，會看到一個上傳檔案用的網頁介面：

在這個網頁介面上，你可以上傳檔案，例如我上傳了一個 Main.c：

上傳完畢後，過沒多久，我的 Dropbox 就同步收到剛剛上傳的檔案了。(檔案路徑會是在 Dropbox 的 Apps > a-demo-app > Main.c)

在原來的 web_upload_app.py 視窗中，你可以看到所有的 HTTP Requests:

參考資料

• 建立 app 取得 App key 與 App Secret
• 安裝 Python SDK

安裝 Python SDK

如下表，Dropbox 官方提供了 iOS, Android, Python, Ruby, Java 以及 OS X 等 SDK，你可以從中選一個喜歡的來使用。除了官方的 SDK，社群成員也貢獻了使用其它程式語言寫成的 Third party SDKs，你可以這個頁面裏找到。在這篇我將說明 Python SDK 的安裝，我所用的環境是 Windows 7:

Step 1: 連到 Dropbox SDK 這個頁面，如下圖所示，點選 Python 右手邊的 Dropbox+ 圖示:

▲ 後來發現，其實點左手邊的語言或環境也可以下載 SDK

Step 2: 這時候會跳出底下這個小視窗，直接點選 "Add to Dropbox":

接著 Python SDK 就會裝到你的 Dropbox。如下圖，Dropbox 會多出 "dropbox-python-sdk-1.5.1" 這個資料夾:

而 "dropbox-python-sdk-1.5.1" 資料夾裏的檔案結構如下:

Step 3: 開一個 DOS 視窗，並切到 "dropbox-python-sdk-1.5.1" 資料夾，然後輸入底下指令安裝 Python SDK (注意! 在執行下列指令前，你必須先刪掉 build 這個檔，不然安裝會失敗) :

python setup.py install

Python SDK 的安裝就這麼簡單，安裝好後，你就可以用拿到的 App key 和 App secret 來存取 Dropbox API。

在 example 資料夾中有一些可供參考的 sample scripts，其中 cli_client.py 是一個 Dropbox 的指令介面工具，而 web_upload_app.py 則可以讓你透過 Web 上傳檔案到 Dropbox。下一篇我將說明如何使用這兩支工具。

參考資料

• 建立 app 取得 App key 與 App Secret

建立 app 取得 App key 與 App Secret

這篇將說明如何建立 Dropbox app 以取得 App key 與 App Secret:

Step 1: 連到 Dropbox 的 My apps 這個網頁，如果你是第一次建立 app，要先同意 Dropbox 的服務條款:

Step 2: 點選 "Create an app":

Step 3: 輸入 App name 和 Description 並選擇 Access type。Access type 有 App folder 和 Full Dropbox 兩種，一般來說使用 App folder 就好，輸入完後點選 Create:

有關 Access types 的種類，簡單說明如下 :

• App folder – 你的 app 只能存取使用者的 Dropbox 的某一個專用的資料夾 (與 app 同名)，會放在使用者 Dropbox 的 Apps 這個資料夾底下
• Full Dropbox – 你的 app 可以存取使用者整個 Dropbox

Step 4: 建立好 app 後，你就可以取得 App key 與 App secret:

App 在開發階段有一個 5 個 users 的使用限制，如果你將來要讓 app 正式產品化，要點上圖的 "Apply for production status" 提出申請。

Step 5: 在同一個頁面下方，你還可以設定 app 額外的資訊，例如 Website, Icon 檔等:

前面提到，App 在開發階段有一個 5 個 users 的使用限制，不過這個功能預設並沒有打開，你要自己點上圖的 "Enable additional users" 然後點選下圖的 Enable 才可以把 users 數量提高到 5 個:

當你取得 App key 和 App Secret 之後，就可以用 Dropbox SDK 來開發 app。目前 Dropbox 官方提供了 iOS, Android, Python, Ruby, Java 和 OSX 等多種 SDK，你可以選擇一個你喜歡的平台來用。下一篇我將說明 Python SDK 的安裝。