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.

Sign up for GitHub

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

bpo-41395: use context manager to close filetype objects #21702

Closed
wants to merge 8 commits into from
Closed

bpo-41395: use context manager to close filetype objects #21702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1be2e8d
use context manager to close filetype objects and avoid ResourceWarning
amiremohamadi Aug 2, 2020
3d8113e
use context manager to close filetype objects and avoid ResourceWarning
amiremohamadi Aug 2, 2020
733a085
add news
amiremohamadi Aug 2, 2020
2b4c192
update ACKS entry
amiremohamadi Aug 2, 2020
4b52ff3
move pprint outside of context manager
amiremohamadi Aug 2, 2020
ce19169
simplify `with` statements
amiremohamadi Aug 2, 2020
8991975
update news entry
amiremohamadi Aug 2, 2020
5732db0
Merge branch 'main' into bpo-41395-close-file
serhiy-storchaka Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Lib/pickle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1810,5 +1810,6 @@ def _test():
else:
import pprint
for f in args.pickle_file:
obj = load(f)
with f:
obj = load(f)
pprint.pprint(obj)
15 changes: 9 additions & 6 deletions Lib/pickletools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2880,11 +2880,14 @@ def _test():
if not args.pickle_file:
parser.print_help()
elif len(args.pickle_file) == 1:
dis(args.pickle_file[0], args.output, None,
args.indentlevel, annotate)
with args.pickle_file[0], args.output:
dis(args.pickle_file[0], args.output, None,
args.indentlevel, annotate)
else:
memo = {} if args.memo else None
for f in args.pickle_file:
preamble = args.preamble.format(name=f.name)
args.output.write(preamble + '\n')
dis(f, args.output, memo, args.indentlevel, annotate)
with args.output:
for f in args.pickle_file:
with f:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be improved as if there is an error while processing some files, the files that have not been already processed will not be closed. By using contextlib.ExitStack() here we could make sure that the files would always be closed even if some error occurs as we would register them all before starting processing them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good!
Just for making sure, you mean sth like this?

with contextlib.ExitStack() as stack:                            
    output = stack.enter_context(args.output)                    
    infiles = [stack.enter_context(f) for f in args.pickle_file] 
    for f in infiles:                                            
        preamble = args.preamble.format(name=f.name)
        output.write(preamble + '\n')
        dis(f, output, memo, args.indentlevel, annotate)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about just using try/finally? Looks simpler to me:

            try:
                for f in args.pickle_file:
                    preamble = args.preamble.format(name=f.name)
                    args.output.write(preamble + '\n')
                    dis(f, args.output, memo, args.indentlevel, annotate)
            finally:
                args.output.close()
                for f in args.pickle_file:
                    f.close()

preamble = args.preamble.format(name=f.name)
args.output.write(preamble + '\n')
dis(f, args.output, memo, args.indentlevel, annotate)
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1240,6 +1240,7 @@ Zubin Mithra
Florian Mladitsch
Kevin Modzelewski
Doug Moen
Amir Mohammadi
Jakub Molinski
Juliette Monsel
Paul Monson
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2020-08-02-11-40-31.bpo-41395.NR20Rh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Use context manager to close filetype objects automatically and avoid
ResourceWarning. Patch contributed by Amir Mohammadi.
Loading