Chilkat2-Python

REST Download Bandwidth Throttle

See more REST Examples

Demonstrates how to use download bandwidth throttling with the REST API. This example will download a file from Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer. Chilkat2-Python

import sys
import chilkat2

success = False

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# A Dropbox access token should have been previously obtained.
# Dropbox access tokens do not expire.
# See Dropbox Access Token.

# To use bandwidth throttling, the connection should be made using the socket API.
# This provides numerous properties to customize the connection, such as
# BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
# KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
# SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

socket = chilkat2.Socket()
maxWaitMs = 5000
success = socket.Connect("content.dropboxapi.com",443,True,maxWaitMs)
if (success != True):
    print(socket.LastErrorText)
    print("Connect Fail Reason: " + str(socket.ConnectFailReason))
    sys.exit()

# Set the download bandwidth throttle rate to 50000 bytes per second.
socket.BandwidthThrottleDown = 50000

rest = chilkat2.Rest()

# Tell the REST object to use the connected socket.
rest.UseConnection(socket,True)

# The remainder of this example is identical to the example at:
# Dropbox Download File.

# Add request headers.
rest.AddHeader("Authorization","Bearer DROPBOX_ACCESS_TOKEN")

# The download "parameters" are contained in JSON passed in an HTTP request header.
# This is the JSON indicating the file to be downloaded:
# { 
#    "path": "/Homework/lit/hamlet.xml",
# }

json = chilkat2.JsonObject()
json.AppendString("path","/Homework/lit/hamlet.xml")
rest.AddHeader("Dropbox-API-Arg",json.Emit())

# Setup a file stream for the download
fileStream = chilkat2.Stream()
fileStream.SinkFile = "qa_output/hamletFromDropbox.xml"

# Indicate that the call to FullRequestNoBody should send the response body
# to fileStream if the response status code is 200.
# If a non-success response status code is received, then nothing
# is streamed to the output file and the error response is returned by FullRequestNoBody.
expectedStatus = 200
rest.SetResponseBodyStream(expectedStatus,True,fileStream)

responseStr = rest.FullRequestNoBody("POST","/2/files/download")
if (rest.LastMethodSuccess == False):
    print(rest.LastErrorText)
    sys.exit()

# When successful, Dropbox responds with a 200 response code.
if (rest.ResponseStatusCode != 200):
    # Examine the request/response to see what happened.
    print("response status code = " + str(rest.ResponseStatusCode))
    print("response status text = " + rest.ResponseStatusText)
    print("response header: " + rest.ResponseHeader)
    print("response body (if any): " + responseStr)
    print("---")
    print("LastRequestStartLine: " + rest.LastRequestStartLine)
    print("LastRequestHeader: " + rest.LastRequestHeader)
    sys.exit()

# Information about the downloaded file is also available as JSON in a response header.
# The "dropbox-api-result" response header contains the information.  For example:
apiResult = rest.ResponseHdrByName("dropbox-api-result")
print(apiResult)

# In this case, the pretty-formatted dropbox-api-result JSON looks like this:
# { 
#   "name": "hamlet.xml",
#   "path_lower": "/homework/lit/hamlet.xml",
#   "path_display": "/Homework/lit/hamlet.xml",
#   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
#   "client_modified": "2016-06-02T23:19:00Z",
#   "server_modified": "2016-06-02T23:19:00Z",
#   "rev": "9482db15f",
#   "size": 279658
# }

# Load the JSON, pretty-print it, and demonstrate how to get some values...
jsonResult = chilkat2.JsonObject()
jsonResult.EmitCompact = False
jsonResult.Load(apiResult)
# Show the JSON pretty-printed...
print(jsonResult.Emit())

# Sample code to get data from the JSON response:
size = jsonResult.IntOf("size")
print("size = " + str(size))

rev = jsonResult.StringOf("rev")
print("rev = " + rev)

clientModified = jsonResult.StringOf("client_modified")
ckdt = chilkat2.CkDateTime()
ckdt.SetFromTimestamp(clientModified)
bLocalTime = True
dt = chilkat2.DtObj()
ckdt.ToDtObj(bLocalTime,dt)

print(str(dt.Day) + "/" + str(dt.Month) + "/" + str(dt.Year) + " " + str(dt.Hour)\
     + ":" + str(dt.Minute))