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.

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

Document streaming payload inputs #833

Merged
merged 2 commits into from Mar 7, 2016
Merged

Conversation

kyleknap
Copy link
Member

@kyleknap kyleknap commented Mar 4, 2016

Fixes boto/boto3#477

Here are samples of how it looks:
screen shot 2016-03-04 at 1 45 42 pm

cc @jamesls @JordonPhillips

@jamesls
Copy link
Member

jamesls commented Mar 4, 2016

Do we define SeekableStream anywhere?

Is it worth just saying it's a file type?

@kyleknap
Copy link
Member Author

kyleknap commented Mar 4, 2016

I just made up a class name. We can call it file if we want. I just want to make the point that we accept file like objects that must be seekable. Thoughts?

@JordonPhillips
Copy link
Contributor

It's unfortunate that there's no IO base class that is defined by seek support. Maybe call it file and inject something in the doc string about it requiring seek?

@jamesls
Copy link
Member

jamesls commented Mar 7, 2016

Yeah something like that would work. My main concern is that someone sees SeekableStream, thinks that's some base class/interface they need to implement, and can't find any information about that.

@kyleknap
Copy link
Member Author

kyleknap commented Mar 7, 2016

Alright how about this one?

@jamesls
Copy link
Member

jamesls commented Mar 7, 2016

:shipit: Looks good.

kyleknap added a commit that referenced this pull request Mar 7, 2016
Document streaming payload inputs
@kyleknap kyleknap merged commit 2ef2c56 into boto:develop Mar 7, 2016
@kyleknap kyleknap deleted the request-stream branch March 7, 2016 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants