gh-127541: Update os.walk example #127765

totosuki · 2024-12-09T15:20:48Z

I updated the example to exclude __pycache__ directories instead of CVS.
While the issue suggested replacing CVS with .git, a comment pointed out that .git is usually found only in the root directory, making it not equivalent to CVS, which can appear in multiple subdirectories.
On the other hand, __pycache__ directories often appear across various levels of a directory tree, making them a more practical modern example!

Issue: Update os.walk example to avoid .git subdirs instead of CVS subdirs #127541

📚 Documentation preview 📚: https://cpython-previews--127765.org.readthedocs.build/

ghost · 2024-12-09T15:20:52Z

All commit authors signed the Contributor License Agreement.

Doc/library/os.rst

Co-authored-by: Bénédikt Tran <[email protected]>

picnixz

See my latest comment: https://github.com/python/cpython/pull/127765/files#r1876269560.

serhiy-storchaka

This is a better example. But look also at the fwalk() example and docstrings.

bedevere-app · 2024-12-09T23:35:38Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

totosuki · 2024-12-10T00:31:06Z

I have made the requested changes; please review again.

bedevere-app · 2024-12-10T00:31:11Z

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

serhiy-storchaka

LGTM.

Doc/library/os.rst

totosuki · 2024-12-10T14:18:33Z

Thank you!
You're absolutely right that going into .git isn't ideal. I'll update it to python/Lib/xml now.

…h-127541-os-walk

totosuki · 2025-03-28T07:38:26Z

Hi @gpshead , just pinging in case this PR was missed. Appreciate any final review!

gpshead

thanks! and good practical idea to use __pycache__ for the example directory to skip.

miss-islington-app · 2025-03-29T06:25:28Z

Thanks @totosuki for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. (cherry picked from commit a594998) Co-authored-by: Totosuki <[email protected]> Co-authored-by: Bénédikt Tran <[email protected]>

bedevere-app · 2025-03-29T06:25:49Z

GH-131869 is a backport of this pull request to the 3.13 branch.

gh-127541: Update os.walk example (GH-127765) Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. (cherry picked from commit a594998) Co-authored-by: Totosuki <[email protected]> Co-authored-by: Bénédikt Tran <[email protected]>

bedevere-bot · 2025-03-29T07:57:08Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD Refleaks 3.x (tier-3) has failed when building commit a594998.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1613/builds/1042) and take a look at the build logs.
Check if the failure is related to this commit (a594998) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1613/builds/1042

Failed tests:

test.test_concurrent_futures.test_process_pool

Failed subtests:

test_idle_process_reuse_one - test.test_concurrent_futures.test_process_pool.ProcessPoolSpawnProcessPoolExecutorTest.test_idle_process_reuse_one

Test leaking resources:

test_process_pool: memory blocks

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd.refleak/build/Lib/test/test_concurrent_futures/test_process_pool.py", line 146, in test_idle_process_reuse_one
    self.assertEqual(len(executor._processes), 1)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 2 != 1


Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd.refleak/build/Lib/test/support/__init__.py", line 814, in gc_collect
    gc.collect()
ResourceWarning: unclosed <ssl.SSLSocket fd=6, family=2, type=1, proto=0, laddr=('127.0.0.1', 40156)>
.


Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd.refleak/build/Lib/test/support/__init__.py", line 814, in gc_collect
    gc.collect()
ResourceWarning: unclosed <ssl.SSLSocket fd=7, family=2, type=1, proto=0, laddr=('127.0.0.1', 46237)>
.


Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd.refleak/build/Lib/test/support/__init__.py", line 814, in gc_collect
    gc.collect()
ResourceWarning: unclosed <ssl.SSLSocket fd=6, family=2, type=1, proto=0, laddr=('127.0.0.1', 39619)>
.test__all__ (test.test_ftplib.MiscTestCase.test__all__) ... ok

bedevere-bot · 2025-03-29T08:30:17Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 CentOS9 NoGIL Refleaks 3.13 (tier-1) has failed when building commit 9ffa80f.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1605/builds/597) and take a look at the build logs.
Check if the failure is related to this commit (9ffa80f) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1605/builds/597

Failed tests:

test_free_threading

Test leaking resources:

test_free_threading: memory blocks

Summary of the results of the build (if available):

==

Click to see traceback logs

remote: Enumerating objects: 7, done.        
remote: Counting objects:  14% (1/7)        
remote: Counting objects:  28% (2/7)        
remote: Counting objects:  42% (3/7)        
remote: Counting objects:  57% (4/7)        
remote: Counting objects:  71% (5/7)        
remote: Counting objects:  85% (6/7)        
remote: Counting objects: 100% (7/7)        
remote: Counting objects: 100% (7/7), done.        
remote: Total 7 (delta 6), reused 7 (delta 6), pack-reused 0 (from 0)        
From https://github.com/python/cpython
 * branch                    3.13       -> FETCH_HEAD
Note: switching to '9ffa80f21edcfec5092388b8b7f3cc7dd29692bb'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 9ffa80f21ed [3.13] gh-127541: Update os.walk example (GH-127765) (GH-131869)
Switched to and reset branch '3.13'

configure: WARNING: no system libmpdecimal found; falling back to bundled libmpdecimal (deprecated and scheduled for removal in Python 3.15)

make: *** [Makefile:2240: buildbottest] Error 2

miss-islington-app · 2025-03-29T10:16:00Z

Thanks @totosuki for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. (cherry picked from commit a594998) Co-authored-by: Totosuki <[email protected]> Co-authored-by: Bénédikt Tran <[email protected]>

bedevere-app · 2025-03-29T10:16:09Z

GH-131873 is a backport of this pull request to the 3.12 branch.

gh-127541: Update os.walk example (GH-127765) Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. (cherry picked from commit a594998) Co-authored-by: Totosuki <[email protected]> Co-authored-by: Bénédikt Tran <[email protected]>

Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. Co-authored-by: Bénédikt Tran <[email protected]>

Update os.walk example

b55d8e8

bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Dec 9, 2024

bedevere-app bot mentioned this pull request Dec 9, 2024

Update os.walk example to avoid .git subdirs instead of CVS subdirs #127541

Closed

picnixz reviewed Dec 9, 2024

View reviewed changes

Doc/library/os.rst Outdated Show resolved Hide resolved

Doc/library/os.rst Show resolved Hide resolved

totosuki and others added 2 commits December 10, 2024 00:56

Update Doc/library/os.rst

3da9a2a

Co-authored-by: Bénédikt Tran <[email protected]>

Replace path with os.getcwd()

108b40c

totosuki requested a review from picnixz December 9, 2024 16:25

picnixz reviewed Dec 9, 2024

View reviewed changes

totosuki and others added 3 commits December 10, 2024 01:30

Replace path with python/Lib

0409ac8

Fix quotes

d14831c

Merge branch 'main' into pythongh-127541-os-walk

fef82c9

totosuki requested a review from picnixz December 9, 2024 22:06

picnixz approved these changes Dec 9, 2024

View reviewed changes

bedevere-app bot added awaiting core review and removed awaiting review labels Dec 9, 2024

picnixz requested a review from serhiy-storchaka December 9, 2024 22:21

serhiy-storchaka requested changes Dec 9, 2024

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting core review labels Dec 9, 2024

totosuki added 3 commits December 10, 2024 09:18

Update os.walk docstrings

f819a76

Update os.fwalk docstrings

51c58e3

Update os.fwalk example

00753f5

bedevere-app bot added awaiting change review and removed awaiting changes labels Dec 10, 2024

bedevere-app bot requested a review from serhiy-storchaka December 10, 2024 00:31

serhiy-storchaka approved these changes Dec 10, 2024

View reviewed changes

Doc/library/os.rst Show resolved Hide resolved

bedevere-app bot added awaiting merge and removed awaiting change review labels Dec 10, 2024

serhiy-storchaka requested a review from gpshead December 10, 2024 14:05

totosuki added 2 commits December 10, 2024 23:20

Merge branch 'main' of https://github.com/python/cpython into pythong…

10fcbec

…h-127541-os-walk

Use python/Lib/xml in example

87e0dcd

gpshead approved these changes Mar 29, 2025

View reviewed changes

gpshead merged commit a594998 into python:main Mar 29, 2025
38 checks passed

bedevere-app bot removed the awaiting merge label Mar 29, 2025

github-project-automation bot moved this from Todo to Done in Docs PRs Mar 29, 2025

gpshead added the needs backport to 3.13 bugs and security fixes label Mar 29, 2025

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 29, 2025

picnixz added the needs backport to 3.12 only security fixes label Mar 29, 2025

bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 29, 2025

Uh oh!

Uh oh!

gh-127541: Update os.walk example #127765

gh-127541: Update os.walk example #127765

Uh oh!

Conversation

totosuki commented Dec 9, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Dec 9, 2024 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-app bot commented Dec 9, 2024

Uh oh!

totosuki commented Dec 10, 2024

Uh oh!

bedevere-app bot commented Dec 10, 2024

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

totosuki commented Dec 10, 2024

Uh oh!

totosuki commented Mar 28, 2025

Uh oh!

gpshead left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app bot commented Mar 29, 2025

Uh oh!

bedevere-app bot commented Mar 29, 2025

Uh oh!

bedevere-bot commented Mar 29, 2025

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

bedevere-bot commented Mar 29, 2025

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

miss-islington-app bot commented Mar 29, 2025

Uh oh!

bedevere-app bot commented Mar 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

totosuki commented Dec 9, 2024 •

edited by github-actions bot

Loading

ghost commented Dec 9, 2024 •

edited by ghost

Loading