Keyerror data token

[RichieB2B]

Breaking change

Proposed change

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New service (thank you!)
• New feature (which adds functionality to an existing service)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests
• Documentation or code sample

Example of code:

api = PyiCloudService(username.strip(), password.strip())
drive = api.drive
for i in api.drive.dir()
    item = drive[i]
    if item.type == "file":
        localfile = os.path.join('.', item.name)
        with item.open(stream=True) as response:
            with open(localfile, "wb") as file_out:
                copyfileobj(response.raw, file_out)

This produces a KeyError: 'data_token' before this patch when a packaged file like a keynote presentation is attempted to be downloaded.

Additional information

I was unable to download keynote files. Even though they have type FILE they do not contain a data_token URL. Instead they have a package_token URL. This patch tries them in that order or returns None if neither are available.

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated to README

[RichieB2B]

I chose to return None because get_file() also returns None when response.ok is false. This actually makes detecting why get_file() failed pretty hard.

Maybe get_file() should raise a PyiCloudAPIResponseException instead when response.ok is false, and a KeyError when neither data_token and package_token are found?

[mandarons]

Any plan to merge this PR?

[RichieB2B]

Maybe @nzapponi can approve it?

[osheanlee]

Hi! I was also working on a code that's on the README right now, i.e.:

with drive_file.open(stream=True) as response:
  with open(drive_file.name, 'wb') as file_out:
    copyfileobj(response.raw, file_out)

Then I got the KeyError: 'data_toke' message. And I happened to see this. Would this be somehow related? The error is being produced by the first line of the ^ code.

[RichieB2B]

Would this be somehow related? The error is being produced by the first line of the ^ code.

If you try to open a package file like a Keynote or similar: yes, definitely.

[RichieB2B]

@balloob Please consider this PR that fixed an import bug. It merges nicely with the current master.

[balloob]

Suggested change

	else:
	raise KeyError("'data_token' nor 'package_token'")
	raise PyiCloudAPIResponseException("'data_token' nor 'package_token' found")

[RichieB2B]

Before my patch get_file did return a KeyError just like get_children also does. IMHO KeyError is the correct exception because the data_token is missing the expected keys.

pyicloud/pyicloud/services/drive.py

Lines 242 to 253 in a14a577

	def get_children(self):
	"""Gets the node children."""
	if not self._children:
	if "items" not in self.data:
	self.data.update(self.connection.get_node_data(self.data["docwsid"]))
	if "items" not in self.data:
	raise KeyError("No items in folder, status: %s" % self.data["status"])
	self._children = [
	DriveNode(self.connection, item_data)
	for item_data in self.data["items"]
	]
	return self._children