This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Fully implement IOBase abstract on SpooledTemporaryFile
Type: behavior Stage: patch review
Components: Library (Lib) Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: Gary Fernie, adriangb, danieljewell, eric.araujo, giampaolo.rodola, iritkatriel, martin.panter, nubirstein, pR0Ps, terry.reedy, ztane
Priority: normal Keywords: patch

Created on 2016-01-21 21:54 by Gary Fernie, last changed 2022-04-11 14:58 by admin.

Files
File name Uploaded Description Edit
fix-SpooledTemporaryFile-IOBase-abstract.patch Gary Fernie, 2016-01-21 21:54 Patch review
Pull Requests
URL Status Linked Edit
PR 3249 open python-dev, 2017-08-30 21:57
PR 29560 open pR0Ps, 2021-11-15 02:40
Messages (14)
msg258769 - (view) Author: Gary Fernie (Gary Fernie) * Date: 2016-01-21 21:54
SpooledTemporaryFile does not fully satisfy the abstract for IOBase.
Namely, `seekable`, `readable`, and `writable` are missing.

This was discovered when seeking a SpooledTemporaryFile-backed lzma file.
You may quickly repro this:
`lzma.open(SpooledTemporaryFile()).seek(0)`
msg258782 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-01-22 02:30
It would be nice to add test cases for this.

Looking at <https://docs.python.org/release/3.4.3/library/tempfile.html#tempfile.SpooledTemporaryFile>, there is a version changed notice for the truncate() method. So perhaps this should be added as a new feature for 3.6. On the other hand, the documentation doesn’t mention the specific API, so I would assume the relevant IOBase subclass, and this would be a bug.
msg310298 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2018-01-19 22:59
It may also be worth implementing BufferedIOBase and TextIOBase. (It seems buffering=0 isn’t reliable, e.g. rollover with limited disk space, so it may not be worth implementing RawIOBase.)

To implement BufferedIOBase, “read1” and “readinto1” should be added.

To implement TextIOBase, “errors” should be added, and “newlines” should only list translated newlines, not the “newline” constructor argument.

Technically, “detach” should also be implemented, although it doesn’t have to do anything useful.
msg319089 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-06-08 17:56
Martin, the PR has one 'approved' review, not from you.  You appear to be requesting changes here, but it is not clear to me which are 'maybe' and which are 'must'.

It is not obvious to me whether this should be treated as enhancement or behavior issue, but backporting is moot until something is merged into master.
msg319145 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2018-06-09 12:25
I was making suggestions, not demanding anything. Except for the quirk with __del__, Gary’s changes (revision fb28362) look okay to add on their own as a bug fix.

I wouldn’t claim that IOBase is “fully implemented” however, until the return values for “seek” and “truncate” are fixed.

The underlying problem is the original SpooledTemporaryFile imitated Python 2’s file class/type, and wasn’t completely adapted for Python 3’s file classes.
msg328908 - (view) Author: (nubirstein) Date: 2018-10-30 12:25
Should I have been added my request there? Anyway I do suffer from lack of 'seekable()' implementation there
msg328911 - (view) Author: (nubirstein) Date: 2018-10-30 12:43
My last comment meant to land somewhere else, but nonetheless it is related to this topic, so:

SpooledTemporaryFile class from lib/tempfile.py still does not implement seekable() method. It could be like this (just two lines of code and my Flask.Request tests with sending files started again to work on 3.7:

    def seekable(self):
        return self._file.seekable()

Is it possible to add this method?
msg368801 - (view) Author: Daniel Jewell (danieljewell) Date: 2020-05-13 20:16
To add something additional here:

The current documentation for tempfile.SpooledTemporaryFile indicates "This function operates exactly as TemporaryFile() does, except that data is spooled in memory until the file size exceeds max_size[...]" (see https://docs.python.org/3/library/tempfile.html)

Except that SpooledTemporaryFile *doesn't* act _exactly_ like TemporaryFile() - as documented here. TemporaryFile() returns an "_io.BufferedRandom" which implements all of the expected "file-like" goodies - like [.readable, .seekable, ...etc]. SpooledTemporaryFile does not.

In comparing to the 2.x docs, the text for SpooledTemporaryFile() appears to be identical or nearly identical to the 3.8.x current docs. This goes in line with what has already been discussed here.

At a _very minimum_ the documentation should be updated to reflect the current differences between TemporaryFile() and SpooledTemporaryFile(). 

Perhaps an easier change would be to extend TemporaryFile() to have a parameter that enables functionality similar to SpooledTemporaryFile? Namely, *memory-only* storage up to a max_size? Or perhaps there is an alternate solution that already exists? 

Ultimately, the functionality that appears to be missing is to be able to easily create a file-like object backed primarily by memory for reading/writing data ... (i.e. one 100% compatible with 'the usual' file objects returned by open()...)
msg379957 - (view) Author: Antti Haapala (ztane) * Date: 2020-10-30 12:51
Another test case:

import tempfile
import io
import json


with tempfile.SpooledTemporaryFile(max_size=2**20) as f:
    tf = io.TextIOWrapper(f, encoding='utf-8')
    json.dump({}, fp=tf)

I was writing json to a file-like object that I need to read in as binary (to upload to S3). Originally the code used BytesIO and I thought it would be wise to actually spool this to disk as I was operating with possible limited RAM... except that of course it didn't work.
msg379958 - (view) Author: Antti Haapala (ztane) * Date: 2020-10-30 12:54
... to further clarify, it is disappointing that either BytesIO or TemporaryFile would work alone, but the one that merges these two doesn't.
msg413973 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2022-02-25 11:01
I believe the PR is in good shape.
Can someone with expertise in tempfile review it?

It would also be useful if the people who had a bug could test the new code.
msg414033 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2022-02-25 19:05
Éric, you might use git log or git blame to see who that is active has patched the relevant file in the last few years.
msg414035 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2022-02-25 19:08
Also, which of the two patches.

Irit, you just patched Temp file doc, can you look at the PR code?
msg414218 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2022-02-28 19:38
> Irit, you just patched Temp file doc, can you look at the PR code?


I don't consider myself and expert here, but I left a comment on PR29560 just to be a good sport.
History
Date User Action Args
2022-04-11 14:58:26adminsetgithub: 70363
2022-02-28 19:38:17iritkatrielsetmessages: + msg414218
2022-02-25 19:08:36terry.reedysetnosy: + iritkatriel
messages: + msg414035
2022-02-25 19:05:17terry.reedysetmessages: + msg414033
2022-02-25 11:01:51eric.araujosetnosy: + eric.araujo, giampaolo.rodola

messages: + msg413973
versions: + Python 3.11, - Python 3.8
2021-11-16 18:24:20adriangbsetnosy: + adriangb
2021-11-15 02:40:18pR0Pssetnosy: + pR0Ps
pull_requests: + pull_request27808
2020-10-30 12:54:02ztanesetmessages: + msg379958
2020-10-30 12:51:51ztanesetnosy: + ztane
messages: + msg379957
2020-05-13 20:16:00danieljewellsetnosy: + danieljewell
messages: + msg368801
2018-10-30 12:54:02xtreaklinkissue35112 superseder
2018-10-30 12:43:59nubirsteinsetmessages: + msg328911
2018-10-30 12:25:10nubirsteinsetnosy: + nubirstein
messages: + msg328908
2018-06-09 12:25:56martin.pantersetmessages: + msg319145
2018-06-08 17:56:16terry.reedysetnosy: + terry.reedy

messages: + msg319089
versions: + Python 3.8, - Python 2.7, Python 3.5, Python 3.6
2018-01-19 22:59:40martin.pantersetmessages: + msg310298
2018-01-19 21:45:34martin.panterlinkissue32600 superseder
2017-08-30 21:57:48python-devsetpull_requests: + pull_request3295
2016-01-22 02:30:11martin.pantersetversions: - Python 3.2, Python 3.3, Python 3.4
nosy: + martin.panter

messages: + msg258782

components: + Library (Lib)
stage: patch review
2016-01-21 21:54:34Gary Ferniecreate