Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow a timeout to be passed to the requests library #20

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow a timeout to be passed to the requests library #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bb682c
Allow timeout to be defined for requests (#1)
lewis-spears Oct 18, 2020
90eaa5d
Remove global timeout (#2)
lewis-spears Oct 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 52 additions & 35 deletions akamai/netstorage/netstorage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,102 +105,117 @@ def _request(self, **kwargs):
'Accept-Encoding': 'identity',
'User-Agent': 'NetStorageKit-Python'
}

timeout = kwargs['timeout'] if 'timeout' in kwargs else None

response = None
if kwargs['method'] == 'GET':
if kwargs['action'] == 'download':
response = self.http_client.get(request_url, headers=headers, stream=True)
response = self.http_client.get(request_url, headers=headers, timeout=timeout, stream=True)
if 'stream' not in kwargs.keys():
self._download_data_from_response(response, kwargs['path'], kwargs['destination'])
else:
response = self.http_client.get(request_url, headers=headers)
response = self.http_client.get(request_url, headers=headers, timeout=timeout)

elif kwargs['method'] == 'POST':
response = self.http_client.post(request_url, headers=headers)
response = self.http_client.post(request_url, headers=headers, timeout=timeout)

elif kwargs['method'] == 'PUT': # Use only upload
if 'stream' in kwargs.keys():
response = self.http_client.put(request_url, headers=headers, data=kwargs['stream'])
response = self.http_client.put(request_url, headers=headers, timeout=timeout, data=kwargs['stream'])
elif kwargs['action'].startswith('upload'):
mmapped_data = self._upload_data_to_request(kwargs['source'])
response = self.http_client.put(request_url, headers=headers, data=mmapped_data)
response = self.http_client.put(request_url, headers=headers, timeout=timeout, data=mmapped_data)
if not isinstance(mmapped_data, str):
mmapped_data.close()

return response.status_code == 200, response

def dir(self, ns_path, option={}):
def dir(self, ns_path, option={}, timeout=None):
option = "dir&format=xml&{0}".format(urlencode(option))
return self._request(action=option,
method='GET',
path=ns_path)
path=ns_path,
timeout=timeout)

def list(self, ns_path, option={}):
def list(self, ns_path, option={}, timeout=None):
option = "list&format=xml&{0}".format(urlencode(option))
return self._request(action=option,
method='GET',
path=ns_path)
path=ns_path,
timeout=timeout)

def download(self, ns_source, local_destination=''):
def download(self, ns_source, local_destination='', timeout=None):
if ns_source.endswith('/'):
raise NetstorageError("[NetstorageError] Nestorage download path shouldn't be a directory: {0}".format(ns_source))
return self._request(action='download',
method='GET',
path=ns_source,
destination=local_destination)
destination=local_destination,
timeout=timeout)

def stream_download(self, ns_source):
def stream_download(self, ns_source, timeout=None):
return self._request(action='download',
method='GET',
path=ns_source,
stream=True)
stream=True,
timeout=timeout)

def du(self, ns_path):
def du(self, ns_path, timeout=None):
return self._request(action='du&format=xml',
method='GET',
path=ns_path)
path=ns_path,
timeout=timeout)

def stat(self, ns_path):
def stat(self, ns_path, timeout=None):
return self._request(action='stat&format=xml',
method='GET',
path=ns_path)
path=ns_path,
timeout=timeout)

def mkdir(self, ns_path):
def mkdir(self, ns_path, timeout=None):
return self._request(action='mkdir',
method='POST',
path=ns_path)
path=ns_path,
timeout=timeout)

def rmdir(self, ns_path):
def rmdir(self, ns_path, timeout=None):
return self._request(action='rmdir',
method='POST',
path=ns_path)
path=ns_path,
timeout=timeout)

def mtime(self, ns_path, mtime):
def mtime(self, ns_path, mtime, timeout=None):
return self._request(action='mtime&format=xml&mtime={0}'.format(mtime),
method='POST',
path=ns_path)
path=ns_path,
timeout=timeout)

def delete(self, ns_path):
def delete(self, ns_path, timeout=None):
return self._request(action='delete',
method='POST',
path=ns_path)
path=ns_path,
timeout=timeout)

def quick_delete(self, ns_path):
def quick_delete(self, ns_path, timeout=None):
return self._request(action='quick-delete&quick-delete=imreallyreallysure',
method='POST',
path=ns_path)
path=ns_path,
timeout=timeout)

def rename(self, ns_target, ns_destination):
def rename(self, ns_target, ns_destination, timeout=None):
return self._request(action='rename&destination={0}'.format(quote_plus(ns_destination)),
method='POST',
path=ns_target)
path=ns_target,
timeout=timeout)

def symlink(self, ns_target, ns_destination):
def symlink(self, ns_target, ns_destination, timeout=None):
return self._request(action='symlink&target={0}'.format(quote_plus(ns_target)),
method='POST',
path=ns_destination)
path=ns_destination,
timeout=timeout)

def upload(self, local_source, ns_destination, index_zip=False):
def upload(self, local_source, ns_destination, index_zip=False, timeout=None):
if os.path.isfile(local_source):
if ns_destination.endswith('/'):
ns_destination = "{0}{1}".format(ns_destination, ntpath.basename(local_source))
Expand All @@ -214,10 +229,12 @@ def upload(self, local_source, ns_destination, index_zip=False):
return self._request(action=action,
method='PUT',
source=local_source,
path=ns_destination)
path=ns_destination,
timeout=timeout)

def stream_upload(self, data, ns_destination):
def stream_upload(self, data, ns_destination, timeout=None):
return self._request(action='upload',
method='PUT',
stream=data,
path=ns_destination)
path=ns_destination,
timeout=timeout)
40 changes: 24 additions & 16 deletions cms_netstorage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def print_result(response, action):
rmdir: to delete /123456/dir1 (directory needs to be empty)
rmdir /123456/dir1
'''
usage = 'Usage: python cms_netstorage.py -H [hostname] -k [keyname] -K [key] -a [action_options] ..'
usage = 'Usage: python cms_netstorage.py -H [hostname] -k [keyname] -K [key] -t [timeout] -s [use ssl] -a [action_options] ..'
parser = NetstorageParser(usage=usage, epilog=action_list)

parser.add_option(
Expand All @@ -83,49 +83,57 @@ def print_result(response, action):
help='Netstorage API key ex) xxxxxxxxxxxxx')
parser.add_option(
'-a', '--action', dest='action')
parser.add_option(
'-s', '--ssl', dest='ssl')
parser.add_option(
'-t', '--timeout', dest='timeout')

(options, args) = parser.parse_args()

if options.hostname and options.keyname and options.key and options.action:
ns = Netstorage(options.hostname, options.keyname, options.key)
ssl = options.ssl if hasattr(options, 'ssl') else False
ns = Netstorage(options.hostname, options.keyname, options.key, ssl)

def _arg(key, default=None):
return args[key] if key in args else default

try:
res = None
if options.action == 'delete':
ok, res = ns.delete(args[0])
ok, res = ns.delete(args[0], _arg(1))
elif options.action == 'dir':
if len(args) >= 2:
ok, res = ns.dir(args[0], ast.literal_eval(args[1]))
ok, res = ns.dir(args[0], ast.literal_eval(args[1]), _arg(2))
else:
ok, res = ns.dir(args[0])
elif options.action == 'list':
if len(args) >= 2:
ok, res = ns.list(args[0], ast.literal_eval(args[1]))
ok, res = ns.list(args[0], ast.literal_eval(args[1]), _arg(2))
else:
ok, res = ns.list(args[0])
elif options.action == 'download':
ok, res = ns.download(args[0], args[1])
ok, res = ns.download(args[0], args[1], _arg(2))
elif options.action == 'du':
ok, res = ns.du(args[0])
ok, res = ns.du(args[0], _arg(1))
elif options.action == 'mkdir':
ok, res = ns.mkdir(args[0])
ok, res = ns.mkdir(args[0], _arg(1))
elif options.action == 'mtime':
ok, res = ns.mtime(args[0], args[1])
ok, res = ns.mtime(args[0], args[1], _arg(2))
elif options.action == 'quick-delete':
ok, res = ns.quick_delete(args[0])
ok, res = ns.quick_delete(args[0], _arg(1))
elif options.action == 'rmdir':
ok, res = ns.rmdir(args[0])
ok, res = ns.rmdir(args[0], _arg(1))
elif options.action == 'stat':
ok, res = ns.stat(args[0])
ok, res = ns.stat(args[0], _arg(1))
elif options.action == 'symlink':
ok, res = ns.symlink(args[0], args[1])
ok, res = ns.symlink(args[0], args[1], _arg(2))
elif options.action == 'upload':
if len(args) >= 3:
ok, res = ns.upload(args[0], args[1], args[2])
ok, res = ns.upload(args[0], args[1], args[2], _arg(3))
else:
ok, res = ns.upload(args[0], args[1])
elif options.action == 'rename':
ok, res = ns.rename(args[0], args[1])
ok, res = ns.rename(args[0], args[1], _arg(1))
else:
print("Invalid action.\nUse option -h or --help")
exit()
Expand All @@ -134,7 +142,7 @@ def print_result(response, action):

except IndexError as e:
if options.action == 'download' and args[0]:
ok, res = ns.download(args[0])
ok, res = ns.download(args[0], '', _arg(1))
print_result(res, options.action)
else:
print("Invalid argument.\n")
Expand Down