-
Notifications
You must be signed in to change notification settings - Fork 283
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.
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
feat: Add support for uploading files as a list #403
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
from RequestsLibrary import log | ||
from RequestsLibrary.compat import urljoin | ||
from RequestsLibrary.utils import ( | ||
is_list_or_tuple, | ||
is_file_descriptor, | ||
warn_if_equal_symbol_in_url_session_less, | ||
) | ||
|
@@ -48,14 +49,29 @@ def _common_request(self, method, session, uri, **kwargs): | |
|
||
files = kwargs.get("files", {}) or {} | ||
data = kwargs.get("data", []) or [] | ||
files_descriptor_to_close = filter( | ||
is_file_descriptor, list(files.values()) + [data] | ||
) | ||
for file_descriptor in files_descriptor_to_close: | ||
file_descriptor.close() | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. at this point I would extract the logic to close file descriptor in a dedicated function and try to cleanup this part There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I refactored the closing of file descriptors into its own static method. |
||
self._close_file_descriptors(files, data) | ||
|
||
return resp | ||
|
||
@staticmethod | ||
def _close_file_descriptors(files, data): | ||
""" | ||
Helper method that closes any open file descriptors. | ||
""" | ||
|
||
if is_list_or_tuple(files): | ||
files_descriptor_to_close = filter( | ||
is_file_descriptor, [file[1][1] for file in files] + [data] | ||
) | ||
else: | ||
files_descriptor_to_close = filter( | ||
is_file_descriptor, list(files.values()) + [data] | ||
) | ||
|
||
for file_descriptor in files_descriptor_to_close: | ||
file_descriptor.close() | ||
|
||
@staticmethod | ||
def _merge_url(session, uri): | ||
""" | ||
|
@@ -176,7 +192,7 @@ def session_less_get( | |
| ``json`` | A JSON serializable Python object to send in the body of the request. | | ||
| ``headers`` | Dictionary of HTTP Headers to send with the request. | | ||
| ``cookies`` | Dict or CookieJar object to send with the request. | | ||
| ``files`` | Dictionary of file-like-objects (or ``{'name': file-tuple}``) for multipart encoding upload. ``file-tuple`` can be a 2-tuple ``('filename', fileobj)``, 3-tuple ``('filename', fileobj, 'content_type')`` or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``, where ``'content-type'`` is a string defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers to add for the file. | | ||
| ``files`` | Dictionary of file-like-objects (or ``{'name': file-tuple}``) for multipart encoding upload. ``file-tuple`` can be a 2-tuple ``('filename', fileobj)``, 3-tuple ``('filename', fileobj, 'content_type')`` or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``, where ``'content-type'`` is a string defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers to add for the file. List or tuple of ``('key': file-tuple)`` allows uploading multiple files with the same key, resulting in a list of files on the receiving end. | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the strange thing is that even the official documentation don't mention files as list or tuple.. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I know that they don't mention it. But the support is there and I don't know how long it has been there. |
||
| ``auth`` | Auth tuple to enable Basic/Digest/Custom HTTP Auth. | | ||
| ``timeout`` | How many seconds to wait for the server to send data before giving up, as a float, or a ``(connect timeout, read timeout)`` tuple. | | ||
| ``allow_redirects`` | Boolean. Enable/disable (values ``${True}`` or ``${False}``). Only for HEAD method keywords allow_redirection defaults to ``${False}``, all others ``${True}``. | | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you also had to fix httpbin?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, as this only returned one item the way it was written. According to what I found out, you need to use the getlist(key) method to get all files for one key.