-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
BUG: Don't close stream passed to PdfWriter.write() #2909
base: main
Are you sure you want to change the base?
Changes from 2 commits
1d9a52c
5568450
a905bac
dafbafc
3d6b7dc
4a1189b
6ce190f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -249,7 +249,6 @@ def _get_clone_from( | |
# to prevent overwriting | ||
self.temp_fileobj = fileobj | ||
self.fileobj = "" | ||
self.with_as_usage = False | ||
# The root of our page tree node. | ||
pages = DictionaryObject() | ||
pages.update( | ||
|
@@ -356,7 +355,6 @@ def __enter__(self) -> "PdfWriter": | |
"""Store that writer is initialized by 'with'.""" | ||
t = self.temp_fileobj | ||
self.__init__() # type: ignore | ||
self.with_as_usage = True | ||
self.fileobj = t # type: ignore | ||
return self | ||
|
||
|
@@ -369,6 +367,9 @@ def __exit__( | |
"""Write data to the fileobj.""" | ||
if self.fileobj: | ||
self.write(self.fileobj) | ||
close_attr = getattr(self.fileobj, "close", None) | ||
if callable(close_attr): | ||
self.fileobj.close() # type: ignore[attr-defined] | ||
stefan6419846 marked this conversation as resolved.
Show resolved
Hide resolved
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. looking @MasterOdin's post the stream closure should be done by the caller, not here, no ? 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. IMHO it should be closed on exit to avoid leaking resources - unless I misunderstood the existing discussions. 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 agree that if a stream is opened by the PdfWriter(eg. if a path is provided)the stream should be closed but if it is the stream (opened before the context of the PdfWriter) it should be closed out of the 'with' section. As written it is always closed at the closure. 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'm thinking this code isn't needed at all. The only way In any case, the only file I see being created is in |
||
|
||
def _repr_mimebundle_( | ||
self, | ||
|
@@ -1388,13 +1389,14 @@ def write(self, stream: Union[Path, StrByteType]) -> Tuple[bool, IO[Any]]: | |
|
||
if isinstance(stream, (str, Path)): | ||
stream = FileIO(stream, "wb") | ||
self.with_as_usage = True # | ||
my_file = True | ||
|
||
self.write_stream(stream) | ||
|
||
if self.with_as_usage: | ||
if my_file: | ||
stream.close() | ||
else: | ||
stream.flush() | ||
|
||
return my_file, stream | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2480,3 +2480,14 @@ def test_append_pdf_with_dest_without_page(caplog): | |
writer.append(reader) | ||
assert "/__WKANCHOR_8" not in writer.named_destinations | ||
assert len(writer.named_destinations) == 3 | ||
|
||
|
||
def test_stream_not_closed(): | ||
"""Tests for #2905""" | ||
src = RESOURCE_ROOT / "pdflatex-outline.pdf" | ||
with NamedTemporaryFile() as tmp: | ||
with PdfReader(src) as reader, PdfWriter() as writer: | ||
for i in range(4): | ||
writer.add_page(reader.pages[i]) | ||
writer.write(tmp) | ||
assert not tmp.file.closed | ||
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. it might be great to also have a test for where the automatic write at the closure of the context will be done 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 think I managed to add a test for this. It was a bit confusing because of the double-construct that happens in |
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.
I'm not found of removing with_as_usage attribute. it may be usefull to know that the the object has been created for a context manager.
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.
It's never used. Keeping it around would mislead someone reading the code that it matters in some way. It's dead code but easy to revive if a need arises.
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.
I agree that having a dead property/attribute is not good, but it is a public interface which tends to need a proper deprecation process.
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.
I'm happy to put
with_as_usage
back if it will reduce friction.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.
Could we please make
with_as_usage
a property which can usedeprecate_no_replacement("with_as_usage", "6.0")
?