KEMBAR78
gh-107006: Move `threading.local` docstring to docs by lysnikolaou · Pull Request #131840 · python/cpython · GitHub
Skip to content

gh-107006: Move threading.local docstring to docs #131840

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

Jump to bottom
Merged
merged 4 commits into from
May 5, 2025
Merged

gh-107006: Move threading.local docstring to docs #131840

merged 4 commits into from
May 5, 2025

Conversation

@lysnikolaou
Copy link
Member

@lysnikolaou lysnikolaou commented Mar 28, 2025 •
edited by github-actions bot
Loading

Move threading.local docs from its docstring to the docs. Especially now that threading.local will become more widely used due to free-threading, having a quick how-to in the docs is going to be very helpful.

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

@bedevere-app bedevere-app bot mentioned this pull request Mar 28, 2025
Closed
@lysnikolaou lysnikolaou added the docs Documentation in the Doc dir label Mar 28, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 28, 2025
StanFromIreland
StanFromIreland reviewed Mar 28, 2025
View reviewed changes
@python-cla-bot
Copy link

python-cla-bot bot commented Apr 6, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

hugovk
hugovk approved these changes May 5, 2025
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovk hugovk added the needs backport to 3.13 bugs and security fixes label May 5, 2025
@lysnikolaou @hugovk
Apply suggestions from code review
63f54b1 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@hugovk hugovk merged commit b97328e into python:main May 5, 2025
39 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs May 5, 2025
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 5, 2025
@lysnikolaou @hugovk @miss-islington
pythongh-107006: Move threading.local docstring to docs (pythonGH-1…
1fa4134 
…31840)

(cherry picked from commit b97328e)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented May 5, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 5, 2025
hugovk added a commit that referenced this pull request May 5, 2025
@miss-islington @lysnikolaou @hugovk
[3.13] gh-107006: Move threading.local docstring to docs (GH-131840) (
f371b23 
#133432)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

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

Hi! The buildbot AMD64 Windows11 Bigmem 3.x (tier-1) has failed when building commit b97328e.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1079/builds/6436) and take a look at the build logs.
  4. Check if the failure is related to this commit (b97328e) or if it is a false positive.
  5. 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/1079/builds/6436

Failed tests:

  • test_frame

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

==

Click to see traceback logs 
Traceback (most recent call last):
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 143, in _print_exception_bltin
    return print_exception(exc, limit=BUILTIN_EXCEPTION_LIMIT, file=file, colorize=colorize)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 134, in print_exception
    te.print(file=file, chain=chain, colorize=colorize)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 1577, in print
    for line in self.format(chain=chain, colorize=colorize):
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 1514, in format
    yield from _ctx.emit(exc.format_exception_only(colorize=colorize))
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 1001, in emit
    for text in text_gen:
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\traceback.py", line 1268, in format_exception_only
    isinstance(self.__notes__, collections.abc.Sequence)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\abc.py", line 119, in __instancecheck__
    return _abc_instancecheck(cls, instance)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\abc.py", line 123, in __subclasscheck__
    return _abc_subclasscheck(cls, subclass)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\abc.py", line 123, in __subclasscheck__
    return _abc_subclasscheck(cls, subclass)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\abc.py", line 123, in __subclasscheck__
    return _abc_subclasscheck(cls, subclass)
RecursionError: Stack overflow (used 11719 kB)


Traceback (most recent call last):
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\test\support\os_helper.py", line 524, in temp_dir
    os.mkdir(path)
    ~~~~~~~~^^^^^^
FileExistsError: [WinError 183] Cannot create a file when that file already exists: 'R:\\buildarea\\3.x.ambv-bb-win11.bigmem\\build\\build\\test_python_9472�'
Stack (most recent call last):
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\runpy.py", line 198, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\runpy.py", line 88, in _run_code
    exec(code, run_globals)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\test\libregrtest\worker.py", line 131, in <module>
    main()
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\test\libregrtest\worker.py", line 126, in main
    with os_helper.temp_cwd(work_dir, quiet=True):
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\contextlib.py", line 141, in __enter__
    return next(self.gen)
  File "R:\buildarea\3.x.ambv-bb-win11.bigmem\build\Lib\test\support\os_helper.py", line 597, in temp_cwd
    with temp_dir(path=name, quiet=quiet) as temp_path:

@hugovk
Copy link
Member

hugovk commented May 5, 2025

The buildbot test_frame failure is unrelated, should be fixed in #133261.

Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@lysnikolaou @hugovk @Pranjal095
pythongh-107006: Move threading.local docstring to docs (python#131840
46cfad9 
)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

@hugovk hugovk hugovk approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lysnikolaou @bedevere-bot @hugovk @StanFromIreland