issue/97 accept path like objects for file uploads #463
Conversation
|
Ok. strangely this works in the test suite but not in my downstream (fails in an actual upload). It appears the tests I added were not sufficient. I recommend not merging this yet til I figure out how to properly test this & fix the bug. |
|
|
canvasapi/upload.py
Outdated
| self.kwargs["name"] = os.path.basename(file.name) | ||
| self.kwargs["size"] = os.fstat(file.fileno()).st_size | ||
| if isinstance(file, Path): | ||
| self.kwargs.update({"name": file.name, "size": file.stat().st_size}) |
There was a problem hiding this comment.
From what I can see, I think this code is unreachable with our current public API. We open the file before we call get_upload_token, so it's never a Path.
There was a problem hiding this comment.
I believe that's correct, this change can likely be reverted.
IIRC I added this check while debugging something and didn't remove it after.
|
So, the good (and probably obvious) news: The changes work! Still able to upload files (paths and file handlers alike). This is almost ready to go, but I have a question re: coverage. Our coverage drops here because of the |
|
Sounds logical to me. pushed a commit to address that point. |
theunkn0wn1
deleted the
issue/97-accept-path-like-objects-for-file-uploads
branch
Proposed Changes
Add
canvas.upload.FileOrPathLiketype, which represents anyos.PathLike,str, oriobased file like and path like objects.Add support in
canvas.upload.Uploadto accept anyFileOrPathLike, as per #97 /Add type annotations to all consumers of
filearguments which are forwarded intocanvas.upload.Upload.Added two tests that use
pathlib.Pathobjects to assert correctness.Fixes #97 .