Skip to content

bpo-22167: Updated glob.iglob doc with details on memory use #25767

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

Closed
akulakov wants to merge 2 commits into from
Closed

bpo-22167: Updated glob.iglob doc with details on memory use #25767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bc6786
Updated glob.iglob doc with details on memory use
akulakov Apr 30, 2021
0854ccd
📜🤖 Added by blurb_it.
blurb-it[bot] May 1, 2021
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
8 changes: 6 additions & 2 deletions Doc/library/glob.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,12 @@ For example, ``'[?]'`` matches the character ``'?'``.

.. function:: iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False)

Return an :term:`iterator` which yields the same values as :func:`glob`
without actually storing them all simultaneously.
Return an :term:`iterator` which yields the same values as :func:`glob.glob` without
actually storing them all simultaneously. Internally, :func:`iglob` uses
:func:`os.listdir` which may result in large amount of memory being consumed if a
single directory contains a large number of files. Unlike :func:`glob.glob`, the case
with large number of subdirectories but with small number of files per each
subdirectory, should not result in large amount of memory consumption.

.. audit-event:: glob.glob pathname,recursive glob.iglob
.. audit-event:: glob.glob/2 pathname,recursive,root_dir,dir_fd glob.iglob
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2021-05-01-00-08-04.bpo-22167.2i15sR.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:func:`glob.iglob` documentation updated with details on memory use.