Repository navigation
Expand file tree
/
Copy paththreads.po
More file actions
1168 lines (955 loc) · 38.4 KB
/
Copy paththreads.po
File metadata and controls
1168 lines (955 loc) · 38.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2001 Python Software Foundation
# This file is distributed under the same license as the Python package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
# Translators:
# Bhuvansh Kataria, 2026
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Python 3.15\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-11-09 23:13+0000\n"
"PO-Revision-Date: 2026-02-25 14:46+0000\n"
"Last-Translator: Bhuvansh Kataria, 2026\n"
"Language-Team: Panjabi (Punjabi) (https://app.transifex.com/python-doc/teams/"
"5390/pa/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: pa\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
msgid "Thread states and the global interpreter lock"
msgstr ""
msgid ""
"Unless on a :term:`free-threaded build` of :term:`CPython`, the Python "
"interpreter is generally not thread-safe. In order to support multi-"
"threaded Python programs, there's a global lock, called the :term:`global "
"interpreter lock` or :term:`GIL`, that must be held by a thread before "
"accessing Python objects. Without the lock, even the simplest operations "
"could cause problems in a multi-threaded program: for example, when two "
"threads simultaneously increment the reference count of the same object, the "
"reference count could end up being incremented only once instead of twice."
msgstr ""
msgid ""
"As such, only a thread that holds the GIL may operate on Python objects or "
"invoke Python's C API."
msgstr ""
msgid ""
"In order to emulate concurrency, the interpreter regularly tries to switch "
"threads between bytecode instructions (see :func:`sys.setswitchinterval`). "
"This is why locks are also necessary for thread-safety in pure-Python code."
msgstr ""
msgid ""
"Additionally, the global interpreter lock is released around blocking I/O "
"operations, such as reading or writing to a file. From the C API, this is "
"done by :ref:`detaching the thread state <detaching-thread-state>`."
msgstr ""
msgid ""
"The Python interpreter keeps some thread-local information inside a data "
"structure called :c:type:`PyThreadState`, known as a :term:`thread state`. "
"Each thread has a thread-local pointer to a :c:type:`PyThreadState`; a "
"thread state referenced by this pointer is considered to be :term:`attached "
"<attached thread state>`."
msgstr ""
msgid ""
"A thread can only have one :term:`attached thread state` at a time. An "
"attached thread state is typically analogous with holding the GIL, except on "
"free-threaded builds. On builds with the GIL enabled, attaching a thread "
"state will block until the GIL can be acquired. However, even on builds with "
"the GIL disabled, it is still required to have an attached thread state, as "
"the interpreter needs to keep track of which threads may access Python "
"objects."
msgstr ""
msgid ""
"Even on the free-threaded build, attaching a thread state may block, as the "
"GIL can be re-enabled or threads might be temporarily suspended (such as "
"during a garbage collection)."
msgstr ""
msgid ""
"Generally, there will always be an attached thread state when using Python's "
"C API, including during embedding and when implementing methods, so it's "
"uncommon to need to set up a thread state on your own. Only in some specific "
"cases, such as in a :c:macro:`Py_BEGIN_ALLOW_THREADS` block or in a fresh "
"thread, will the thread not have an attached thread state. If uncertain, "
"check if :c:func:`PyThreadState_GetUnchecked` returns ``NULL``."
msgstr ""
msgid ""
"If it turns out that you do need to create a thread state, it is recommended "
"to use :c:func:`PyThreadState_Ensure` "
"or :c:func:`PyThreadState_EnsureFromView`, which will manage the thread "
"state for you."
msgstr ""
msgid "Detaching the thread state from extension code"
msgstr ""
msgid ""
"Most extension code manipulating the :term:`thread state` has the following "
"simple structure::"
msgstr ""
msgid ""
"Save the thread state in a local variable.\n"
"... Do some blocking I/O operation ...\n"
"Restore the thread state from the local variable."
msgstr ""
msgid "This is so common that a pair of macros exists to simplify it::"
msgstr ""
msgid ""
"Py_BEGIN_ALLOW_THREADS\n"
"... Do some blocking I/O operation ...\n"
"Py_END_ALLOW_THREADS"
msgstr ""
msgid ""
"The :c:macro:`Py_BEGIN_ALLOW_THREADS` macro opens a new block and declares a "
"hidden local variable; the :c:macro:`Py_END_ALLOW_THREADS` macro closes the "
"block."
msgstr ""
msgid "The block above expands to the following code::"
msgstr ""
msgid ""
"PyThreadState *_save;\n"
"\n"
"_save = PyEval_SaveThread();\n"
"... Do some blocking I/O operation ...\n"
"PyEval_RestoreThread(_save);"
msgstr ""
msgid "Here is how these functions work:"
msgstr ""
msgid ""
"The attached thread state implies that the GIL is held for the interpreter. "
"To detach it, :c:func:`PyEval_SaveThread` is called and the result is stored "
"in a local variable."
msgstr ""
msgid ""
"By detaching the thread state, the GIL is released, which allows other "
"threads to attach to the interpreter and execute while the current thread "
"performs blocking I/O. When the I/O operation is complete, the old thread "
"state is reattached by calling :c:func:`PyEval_RestoreThread`, which will "
"wait until the GIL can be acquired."
msgstr ""
msgid ""
"Performing blocking I/O is the most common use case for detaching the thread "
"state, but it is also useful to call it over long-running native code that "
"doesn't need access to Python objects or Python's C API. For example, the "
"standard :mod:`zlib` and :mod:`hashlib` modules detach the :term:`thread "
"state <attached thread state>` when compressing or hashing data."
msgstr ""
msgid ""
"On a :term:`free-threaded build`, the :term:`GIL` is usually out of the "
"question, but **detaching the thread state is still required**, because the "
"interpreter periodically needs to block all threads to get a consistent view "
"of Python objects without the risk of race conditions. For example, CPython "
"currently suspends all threads for a short period of time while running the "
"garbage collector."
msgstr ""
msgid ""
"Detaching the thread state can lead to unexpected behavior during "
"interpreter finalization. See :ref:`cautions-regarding-runtime-finalization` "
"for more details."
msgstr ""
msgid "APIs"
msgstr ""
msgid ""
"The following macros are normally used without a trailing semicolon; look "
"for example usage in the Python source distribution."
msgstr ""
msgid ""
"These macros are still necessary on the :term:`free-threaded build` to "
"prevent deadlocks."
msgstr ""
msgid ""
"This macro expands to ``{ PyThreadState *_save; _save = "
"PyEval_SaveThread();``. Note that it contains an opening brace; it must be "
"matched with a following :c:macro:`Py_END_ALLOW_THREADS` macro. See above "
"for further discussion of this macro."
msgstr ""
msgid ""
"This macro expands to ``PyEval_RestoreThread(_save); }``. Note that it "
"contains a closing brace; it must be matched with an "
"earlier :c:macro:`Py_BEGIN_ALLOW_THREADS` macro. See above for further "
"discussion of this macro."
msgstr ""
msgid ""
"This macro expands to ``PyEval_RestoreThread(_save);``: it is equivalent "
"to :c:macro:`Py_END_ALLOW_THREADS` without the closing brace."
msgstr ""
msgid ""
"This macro expands to ``_save = PyEval_SaveThread();``: it is equivalent "
"to :c:macro:`Py_BEGIN_ALLOW_THREADS` without the opening brace and variable "
"declaration."
msgstr ""
msgid "Using the C API from foreign threads"
msgstr ""
msgid ""
"When threads are created using the dedicated Python APIs (such as "
"the :mod:`threading` module), a thread state is automatically associated "
"with them, However, when a thread is created from native code (for example, "
"by a third-party library with its own thread management), it doesn't hold an "
"attached thread state."
msgstr ""
msgid ""
"If you need to call Python code from these threads (often this will be part "
"of a callback API provided by the aforementioned third-party library), you "
"must first register these threads with the interpreter by creating a new "
"thread state and attaching it."
msgstr ""
msgid ""
"The easiest way to do this is through :c:func:`PyThreadState_Ensure` "
"or :c:func:`PyThreadState_EnsureFromView`."
msgstr ""
msgid ""
"These functions require an argument pointing to the desired interpreter; "
"such a pointer can be acquired via a call "
"to :c:func:`PyInterpreterGuard_FromCurrent` (for ``PyThreadState_Ensure``) "
"or :c:func:`PyInterpreterView_FromCurrent` (for "
"``PyThreadState_EnsureFromView``) from the function that creates the thread. "
"If no pointer is available (such as when the given native thread library "
"doesn't provide a data argument), :c:func:`PyInterpreterView_FromMain` can "
"be used to get a view for the main interpreter, but note that this will make "
"the code incompatible with subinterpreters."
msgstr ""
msgid "For example::"
msgstr ""
msgid ""
"// The return value of PyInterpreterGuard_FromCurrent() from the\n"
"// function that created this thread.\n"
"PyInterpreterGuard *guard = thread_data->guard;\n"
"\n"
"// Create a new thread state for the interpreter.\n"
"PyThreadStateToken *token = PyThreadState_Ensure(guard);\n"
"if (token == NULL) {\n"
" PyInterpreterGuard_Close(guard);\n"
" return;\n"
"}\n"
"\n"
"// We have a valid thread state -- perform Python actions here.\n"
"result = CallSomeFunction();\n"
"// Evaluate result or handle exceptions.\n"
"\n"
"// Release the thread state. No calls to the C API are allowed beyond this\n"
"// point.\n"
"PyThreadState_Release(token);\n"
"PyInterpreterGuard_Close(guard);"
msgstr ""
msgid ""
"Keep in mind that calling ``PyThreadState_Ensure`` might not always create a "
"new thread state, and calling ``PyThreadState_Release`` might not always "
"detach it. These functions may reuse an existing attached thread state, or "
"may re-attach a thread state that was previously attached for the current "
"thread."
msgstr ""
msgid ":pep:`788`"
msgstr ""
msgid "Reusing a thread state across repeated calls"
msgstr ""
msgid ""
"Creating and destroying a :c:type:`PyThreadState` is not free, and is more "
"expensive on a :term:`free-threaded build`. A foreign thread that calls "
"into the interpreter many times -- for example, a worker thread in a native "
"thread pool -- should avoid creating a fresh thread state on every entry and "
"destroying it on every exit. Instead, set up one thread state when the "
"thread starts (or lazily on its first call into Python), attach and detach "
"it around each call, and tear it down once when the thread exits."
msgstr ""
msgid ""
"Manage the thread state explicitly with :c:func:`PyThreadState_New`, "
"attaching and detaching it with :c:func:`PyEval_RestoreThread` "
"and :c:func:`PyEval_SaveThread`. This happens in three distinct phases, at "
"different points in the thread's life."
msgstr ""
msgid ""
"When the thread starts, create one thread state for it. ``interp`` is the "
"target interpreter, captured by the code that created this thread while it "
"held an attached thread state (for example "
"via :c:func:`PyInterpreterState_Get`)::"
msgstr ""
msgid "PyThreadState *tstate = PyThreadState_New(interp);"
msgstr ""
msgid ""
"Then, on each call into Python -- which may happen many times over the "
"thread's life -- attach the thread state, make the Python C API calls that "
"require it, and detach again so the thread does not hold the GIL while off "
"doing non-Python work::"
msgstr ""
msgid ""
"PyEval_RestoreThread(tstate);\n"
"result = CallSomeFunction(); /* your Python C API calls go here */\n"
"PyEval_SaveThread();"
msgstr ""
msgid ""
"When the thread is finished calling into Python, destroy the thread state "
"once::"
msgstr ""
msgid ""
"PyEval_RestoreThread(tstate);\n"
"PyThreadState_Clear(tstate);\n"
"PyThreadState_DeleteCurrent();"
msgstr ""
msgid ""
"The general-purpose entry points for calling in from a foreign thread "
"-- :c:func:`PyThreadState_Ensure` and the older :c:func:`PyGILState_Ensure` "
"-- do *not* guarantee a persistent thread state: their thread-state lifetime "
"is deliberately implementation-defined, so a matched acquire/release pair "
"may create and destroy a thread state each time. "
"Use :c:func:`PyThreadState_New`, as shown here, whenever you specifically "
"want to reuse one thread state across calls."
msgstr ""
msgid ""
"The code that created the foreign thread must arrange for the shutdown "
"sequence to run before the thread exits, and before :c:func:`Py_FinalizeEx` "
"is called. If interpreter finalization begins first, the "
"shutdown :c:func:`PyEval_RestoreThread` call will hang the thread rather "
"than return (see :ref:`cautions-regarding-runtime-finalization`). If the "
"thread exits without running the shutdown sequence, the thread state is "
"leaked for the remainder of the process."
msgstr ""
msgid "Attaching/detaching thread states"
msgstr ""
msgid ""
"Ensure that the thread has an attached thread state for the interpreter "
"protected by *guard*, and thus can safely invoke that interpreter."
msgstr ""
msgid ""
"It is OK to call this function if the thread already has an attached thread "
"state, as long as there is a subsequent call "
"to :c:func:`PyThreadState_Release` that matches this one (meaning that "
"\"nested\" calls to this function are permitted)."
msgstr ""
msgid ""
"The function's effect (if any) will be reversed by the matching call "
"to :c:func:`PyThreadState_Release`."
msgstr ""
msgid ""
"On error, this function returns ``NULL`` *without* an exception set. Do not "
"call :c:func:`!PyThreadState_Release` in this case."
msgstr ""
msgid ""
"On success, this function returns a pointer value that must be passed to the "
"matching call to :c:func:`!PyThreadState_Release`."
msgstr ""
msgid ""
"The conditions in which this function creates a new :term:`thread state` are "
"considered unstable and implementation-dependent. If you need to control the "
"exact lifetime of a thread state, consider "
"using :c:func:`PyThreadState_New`. However, do not avoid this function "
"solely on the basis that the lifetime of the thread state may be "
"inconsistent across versions; changes to this function will be done with "
"caution and in a backwards-compatible manner. In particular, the saving of "
"thread-local variables and similar state will be retained across Python "
"versions."
msgstr ""
msgid ""
"The exact behavior of whether this function creates a new thread state is "
"described below, but be aware that this may change in the future."
msgstr ""
msgid ""
"First, this function checks if an attached thread state is present. If there "
"is, this function then checks if the interpreter of that thread state "
"matches the interpreter guarded by *guard*. If that is the case, this "
"function simply marks the thread state as being used by a "
"``PyThreadState_Ensure`` call and returns."
msgstr ""
msgid ""
"If there is no attached thread state, then this function checks if any "
"thread state has been used by the current OS thread. (This is returned "
"by :c:func:`PyGILState_GetThisThreadState`.) If there was, then this "
"function checks if that thread state's interpreter matches *guard*. If it "
"does, it is re-attached and marked as used."
msgstr ""
msgid ""
"Otherwise, if both of the above cases fail, a new thread state is created "
"for *guard*. It is then attached and marked as owned by "
"``PyThreadState_Ensure``."
msgstr ""
msgid "Get an attached thread state for the interpreter referenced by *view*."
msgstr ""
msgid ""
"The behavior and return value are the same as "
"for :c:func:`PyThreadState_Ensure`; additionally, if the function succeeds, "
"the interpreter referenced by *view* will be implicitly guarded. The guard "
"will be released upon the corresponding :c:func:`PyThreadState_Release` call."
msgstr ""
msgid ""
"Undo a :c:func:`PyThreadState_Ensure` "
"or :c:func:`PyThreadState_EnsureFromView` call."
msgstr ""
msgid ""
"This must be called exactly once for each successful *Ensure* call, with "
"*token* set to that call's return value."
msgstr ""
msgid ""
"The state that was attached before the corresponding *Ensure* call (if any) "
"will be attached when :c:func:`PyThreadState_Release` returns."
msgstr ""
msgid ""
"The exact behavior of whether this function deletes a thread state is "
"considered unstable and implementation-dependent."
msgstr ""
msgid ""
"Currently, this function will decrement an internal counter on the attached "
"thread state. If this counter ever reaches below zero, this function emits a "
"fatal error (via :c:func:`Py_FatalError`)."
msgstr ""
msgid ""
"If the attached thread state is owned by ``PyThreadState_Ensure``, then the "
"attached thread state will be deallocated and deleted upon the internal "
"counter reaching zero. Otherwise, nothing happens when the counter reaches "
"zero."
msgstr ""
msgid ""
"An opaque token retrieved from a :c:func:`PyThreadState_Ensure` call and "
"passed to a corresponding :c:func:`PyThreadState_Release` call."
msgstr ""
msgid "GIL-state APIs"
msgstr ""
msgid ""
"The following APIs are generally not compatible with subinterpreters and "
"will hang the process during interpreter finalization (see :ref:`cautions-"
"regarding-runtime-finalization`). As such, these APIs were :term:`soft "
"deprecated` in Python 3.15 in favor of the :ref:`new APIs <c-api-foreign-"
"threads>`."
msgstr ""
msgid ""
"The type of the value returned by :c:func:`PyGILState_Ensure` and passed "
"to :c:func:`PyGILState_Release`."
msgstr ""
msgid "The GIL was already held when :c:func:`PyGILState_Ensure` was called."
msgstr ""
msgid "The GIL was not held when :c:func:`PyGILState_Ensure` was called."
msgstr ""
msgid ""
"Ensure that the current thread is ready to call the Python C API regardless "
"of the current state of Python, or of the :term:`attached thread state`. "
"This may be called as many times as desired by a thread as long as each call "
"is matched with a call to :c:func:`PyGILState_Release`. In general, other "
"thread-related APIs may be used between :c:func:`PyGILState_Ensure` "
"and :c:func:`PyGILState_Release` calls as long as the thread state is "
"restored to its previous state before the Release(). For example, normal "
"usage of the :c:macro:`Py_BEGIN_ALLOW_THREADS` "
"and :c:macro:`Py_END_ALLOW_THREADS` macros is acceptable."
msgstr ""
msgid ""
"The return value is an opaque \"handle\" to the :term:`attached thread "
"state` when :c:func:`PyGILState_Ensure` was called, and must be passed "
"to :c:func:`PyGILState_Release` to ensure Python is left in the same state. "
"Even though recursive calls are allowed, these handles *cannot* be shared - "
"each unique call to :c:func:`PyGILState_Ensure` must save the handle for its "
"call to :c:func:`PyGILState_Release`."
msgstr ""
msgid ""
"When the function returns, there will be an :term:`attached thread state` "
"and the thread will be able to call arbitrary Python code."
msgstr ""
msgid ""
"This function has no way to return an error. As such, errors are either "
"fatal (that is, they send ``SIGABRT`` and crash the process; "
"see :c:func:`Py_FatalError`), or the thread will be permanently blocked "
"(such as during interpreter finalization)."
msgstr ""
msgid ""
"Calling this function when the interpreter is finalizing will infinitely "
"hang the thread, which may cause deadlocks. :ref:`cautions-regarding-runtime-"
"finalization` for more details."
msgstr ""
msgid ""
"In addition, this function generally does not work with subinterpreters when "
"used from foreign threads, because this function has no way of knowing which "
"interpreter created the thread (and as such, will implicitly pick the main "
"interpreter)."
msgstr ""
msgid ""
"Hangs the current thread, rather than terminating it, if called while the "
"interpreter is finalizing."
msgstr ""
msgid ""
"Use :c:func:`PyThreadState_Ensure` or :c:func:`PyThreadState_EnsureFromView` "
"instead."
msgstr ""
msgid ""
"Release any resources previously acquired. After this call, Python's state "
"will be the same as it was prior to the "
"corresponding :c:func:`PyGILState_Ensure` call (but generally this state "
"will be unknown to the caller, hence the use of the GIL-state API)."
msgstr ""
msgid ""
"Every call to :c:func:`PyGILState_Ensure` must be matched by a call "
"to :c:func:`PyGILState_Release` on the same thread."
msgstr ""
msgid "Use :c:func:`PyThreadState_Release` instead."
msgstr ""
msgid ""
"Get the :term:`thread state` that was most recently :term:`attached "
"<attached thread state>` for this thread. (If the most recent thread state "
"has been deleted, this returns ``NULL``.)"
msgstr ""
msgid "If the caller has an attached thread state, it is returned."
msgstr ""
msgid ""
"In other terms, this function returns the thread state that will be used "
"by :c:func:`PyGILState_Ensure`. If this returns ``NULL``, then "
"``PyGILState_Ensure`` will create a new thread state."
msgstr ""
msgid "This function cannot fail."
msgstr ""
msgid ""
"Use :c:func:`PyThreadState_Get` or :c:func:`PyThreadState_GetUnchecked` "
"instead."
msgstr ""
msgid ""
"Return ``1`` if the current thread has an :term:`attached thread state` that "
"matches the thread state returned "
"by :c:func:`PyGILState_GetThisThreadState`. If the caller has no attached "
"thread state or it otherwise doesn't match, then this returns ``0``."
msgstr ""
msgid ""
"If the current Python process has ever created a subinterpreter, this "
"function will *always* return ``1``."
msgstr ""
msgid "This is mainly a helper/diagnostic function."
msgstr ""
msgid "Use ``PyThreadState_GetUnchecked() != NULL`` instead."
msgstr ""
msgid "Cautions about fork()"
msgstr ""
msgid ""
"Another important thing to note about threads is their behaviour in the face "
"of the C :c:func:`fork` call. On most systems with :c:func:`fork`, after a "
"process forks only the thread that issued the fork will exist. This has a "
"concrete impact both on how locks must be handled and on all stored state in "
"CPython's runtime."
msgstr ""
msgid ""
"The fact that only the \"current\" thread remains means any locks held by "
"other threads will never be released. Python solves this for :func:`os.fork` "
"by acquiring the locks it uses internally before the fork, and releasing "
"them afterwards. In addition, it resets any :ref:`lock-objects` in the "
"child. When extending or embedding Python, there is no way to inform Python "
"of additional (non-Python) locks that need to be acquired before or reset "
"after a fork. OS facilities such as :c:func:`!pthread_atfork` would need to "
"be used to accomplish the same thing. Additionally, when extending or "
"embedding Python, calling :c:func:`fork` directly rather than "
"through :func:`os.fork` (and returning to or calling into Python) may result "
"in a deadlock by one of Python's internal locks being held by a thread that "
"is defunct after the fork. :c:func:`PyOS_AfterFork_Child` tries to reset the "
"necessary locks, but is not always able to."
msgstr ""
msgid ""
"The fact that all other threads go away also means that CPython's runtime "
"state there must be cleaned up properly, which :func:`os.fork` does. This "
"means finalizing all other :c:type:`PyThreadState` objects belonging to the "
"current interpreter and all other :c:type:`PyInterpreterState` objects. Due "
"to this and the special nature of the :ref:`\"main\" interpreter <sub-"
"interpreter-support>`, :c:func:`fork` should only be called in that "
"interpreter's \"main\" thread, where the CPython global runtime was "
"originally initialized. The only exception is if :c:func:`exec` will be "
"called immediately after."
msgstr ""
msgid "High-level APIs"
msgstr ""
msgid ""
"These are the most commonly used types and functions when writing multi-"
"threaded C extensions."
msgstr ""
msgid ""
"This data structure represents the state of a single thread. The only "
"public data member is:"
msgstr ""
msgid "This thread's interpreter state."
msgstr ""
msgid "Deprecated function which does nothing."
msgstr ""
msgid ""
"In Python 3.6 and older, this function created the GIL if it didn't exist."
msgstr ""
msgid "The function now does nothing."
msgstr ""
msgid ""
"This function is now called by :c:func:`Py_Initialize()`, so you don't have "
"to call it yourself anymore."
msgstr ""
msgid ""
"This function cannot be called before :c:func:`Py_Initialize()` anymore."
msgstr ""
msgid ""
"Detach the :term:`attached thread state` and return it. The thread will have "
"no :term:`thread state` upon returning."
msgstr ""
msgid ""
"Set the :term:`attached thread state` to *tstate*. The passed :term:`thread "
"state` **should not** be :term:`attached <attached thread state>`, otherwise "
"deadlock ensues. *tstate* will be attached upon returning."
msgstr ""
msgid ""
"Calling this function from a thread when the runtime is finalizing will hang "
"the thread until the program exits, even if the thread was not created by "
"Python. Refer to :ref:`cautions-regarding-runtime-finalization` for more "
"details."
msgstr ""
msgid ""
"Return the :term:`attached thread state`. If the thread has no attached "
"thread state, (such as when inside of :c:macro:`Py_BEGIN_ALLOW_THREADS` "
"block), then this issues a fatal error (so that the caller needn't check for "
"``NULL``)."
msgstr ""
msgid "See also :c:func:`PyThreadState_GetUnchecked`."
msgstr ""
msgid ""
"Similar to :c:func:`PyThreadState_Get`, but don't kill the process with a "
"fatal error if it is NULL. The caller is responsible to check if the result "
"is NULL."
msgstr ""
msgid ""
"In Python 3.5 to 3.12, the function was private and known as "
"``_PyThreadState_UncheckedGet()``."
msgstr ""
msgid ""
"Set the :term:`attached thread state` to *tstate*, and return "
"the :term:`thread state` that was attached prior to calling."
msgstr ""
msgid ""
"This function is safe to call without an :term:`attached thread state`; it "
"will simply return ``NULL`` indicating that there was no prior thread state."
msgstr ""
msgid ":c:func:`PyEval_ReleaseThread`"
msgstr ""
msgid ""
"Similar to :c:func:`PyGILState_Ensure`, this function will hang the thread "
"if the runtime is finalizing."
msgstr ""
msgid "Low-level APIs"
msgstr ""
msgid ""
"Create a new thread state object belonging to the given interpreter object. "
"An :term:`attached thread state` is not needed."
msgstr ""
msgid ""
"Reset all information in a :term:`thread state` object. *tstate* must "
"be :term:`attached <attached thread state>`"
msgstr ""
msgid ""
"This function now calls the :c:member:`!PyThreadState.on_delete` callback. "
"Previously, that happened in :c:func:`PyThreadState_Delete`."
msgstr ""
msgid "The :c:member:`!PyThreadState.on_delete` callback was removed."
msgstr ""
msgid ""
"Destroy a :term:`thread state` object. *tstate* should not "
"be :term:`attached <attached thread state>` to any thread. *tstate* must "
"have been reset with a previous call to :c:func:`PyThreadState_Clear`."
msgstr ""
msgid ""
"Detach the :term:`attached thread state` (which must have been reset with a "
"previous call to :c:func:`PyThreadState_Clear`) and then destroy it."
msgstr ""
msgid ""
"No :term:`thread state` will be :term:`attached <attached thread state>` "
"upon returning."
msgstr ""
msgid "Get the current frame of the Python thread state *tstate*."
msgstr ""
msgid ""
"Return a :term:`strong reference`. Return ``NULL`` if no frame is currently "
"executing."
msgstr ""
msgid "See also :c:func:`PyEval_GetFrame`."
msgstr ""
msgid ""
"*tstate* must not be ``NULL``, and must be :term:`attached <attached thread "
"state>`."
msgstr ""
msgid ""
"Get the unique :term:`thread state` identifier of the Python thread state "
"*tstate*."
msgstr ""
msgid "Get the interpreter of the Python thread state *tstate*."
msgstr ""
msgid "Suspend tracing and profiling in the Python thread state *tstate*."
msgstr ""
msgid "Resume them using the :c:func:`PyThreadState_LeaveTracing` function."
msgstr ""
msgid ""
"Resume tracing and profiling in the Python thread state *tstate* suspended "
"by the :c:func:`PyThreadState_EnterTracing` function."
msgstr ""
msgid ""
"See also :c:func:`PyEval_SetTrace` and :c:func:`PyEval_SetProfile` functions."
msgstr ""
msgid ""
"Set the stack protection start address and stack protection size of a Python "
"thread state."
msgstr ""
msgid ""
"On success, return ``0``. On failure, set an exception and return ``-1``."
msgstr ""
msgid ""
"CPython implements :ref:`recursion control <recursion>` for C code by "
"raising :py:exc:`RecursionError` when it notices that the machine execution "
"stack is close to overflow. See for example "
"the :c:func:`Py_EnterRecursiveCall` function. For this, it needs to know the "
"location of the current thread's stack, which it normally gets from the "
"operating system. When the stack is changed, for example using context "
"switching techniques like the Boost library's ``boost::context``, you must "
"call :c:func:`~PyUnstable_ThreadState_SetStackProtection` to inform CPython "
"of the change."
msgstr ""
msgid ""
"Call :c:func:`~PyUnstable_ThreadState_SetStackProtection` either before or "
"after changing the stack. Do not call any other Python C API between the "
"call and the stack change."
msgstr ""
msgid ""
"See :c:func:`PyUnstable_ThreadState_ResetStackProtection` for undoing this "
"operation."
msgstr ""
msgid ""
"Reset the stack protection start address and stack protection size of a "
"Python thread state to the operating system defaults."
msgstr ""
msgid ""
"See :c:func:`PyUnstable_ThreadState_SetStackProtection` for an explanation."
msgstr ""
msgid ""
"Return a dictionary in which extensions can store thread-specific state "
"information. Each extension should use a unique key to use to store state "
"in the dictionary. It is okay to call this function when no :term:`thread "
"state` is :term:`attached <attached thread state>`. If this function returns "
"``NULL``, no exception has been raised and the caller should assume no "
"thread state is attached."
msgstr ""
msgid ""
":term:`Attach <attached thread state>` *tstate* to the current thread, which "
"must not be ``NULL`` or already :term:`attached <attached thread state>`."
msgstr ""
msgid ""
"The calling thread must not already have an :term:`attached thread state`."
msgstr ""
msgid ""
"Updated to be consistent "
"with :c:func:`PyEval_RestoreThread`, :c:func:`Py_END_ALLOW_THREADS`, "
"and :c:func:`PyGILState_Ensure`, and terminate the current thread if called "
"while the interpreter is finalizing."
msgstr ""
msgid ""
":c:func:`PyEval_RestoreThread` is a higher-level function which is always "
"available (even when threads have not been initialized)."
msgstr ""
msgid ""
"Detach the :term:`attached thread state`. The *tstate* argument, which must "
"not be ``NULL``, is only used to check that it represents "
"the :term:`attached thread state` --- if it isn't, a fatal error is reported."
msgstr ""
msgid ""
":c:func:`PyEval_SaveThread` is a higher-level function which is always "
"available (even when threads have not been initialized)."
msgstr ""
msgid "Asynchronous notifications"
msgstr ""
msgid ""
"A mechanism is provided to make asynchronous notifications to the main "
"interpreter thread. These notifications take the form of a function pointer "
"and a void pointer argument."
msgstr ""
msgid ""
"Schedule a function to be called from the main interpreter thread. On "
"success, ``0`` is returned and *func* is queued for being called in the main "
"thread. On failure, ``-1`` is returned without setting any exception."
msgstr ""
msgid ""
"When successfully queued, *func* will be *eventually* called from the main "
"interpreter thread with the argument *arg*. It will be called "
"asynchronously with respect to normally running Python code, but with both "
"these conditions met:"
msgstr ""
msgid "on a :term:`bytecode` boundary;"
msgstr ""
msgid ""
"with the main thread holding an :term:`attached thread state` (*func* can "
"therefore use the full C API)."
msgstr ""
msgid ""
"*func* must return ``0`` on success, or ``-1`` on failure with an exception "
"set. *func* won't be interrupted to perform another asynchronous "
"notification recursively, but it can still be interrupted to switch threads "
"if the :term:`thread state <attached thread state>` is detached."
msgstr ""
msgid ""
"This function doesn't need an :term:`attached thread state`. However, to "
"call this function in a subinterpreter, the caller must have "
"an :term:`attached thread state`. Otherwise, the function *func* can be "
"scheduled to be called from the wrong interpreter."
msgstr ""
msgid ""
"This is a low-level function, only useful for very special cases. There is "
"no guarantee that *func* will be called as quick as possible. If the main "
"thread is busy executing a system call, *func* won't be called before the "
"system call returns. This function is generally **not** suitable for "
"calling Python code from arbitrary C threads. Instead, "
"use :c:func:`PyThreadState_EnsureFromView`."
msgstr ""
msgid ""
"If this function is called in a subinterpreter, the function *func* is now "
"scheduled to be called from the subinterpreter, rather than being called "
"from the main interpreter. Each subinterpreter now has its own list of "
"scheduled calls."
msgstr ""
msgid ""
"This function now always schedules *func* to be run in the main interpreter."
msgstr ""
msgid ""
"Execute all pending calls. This is usually executed automatically by the "
"interpreter."
msgstr ""
msgid ""
"This function returns ``0`` on success, and returns ``-1`` with an exception "
"set on failure."
msgstr ""
msgid ""
"If this is not called in the main thread of the main interpreter, this "
"function does nothing and returns ``0``. The caller must hold "
"an :term:`attached thread state`."
msgstr ""
msgid "This function only runs pending calls in the main interpreter."
msgstr ""
msgid ""
"Schedule an exception to be raised asynchronously in a thread. If the thread "
"has a previously scheduled exception, it is overwritten."
msgstr ""
msgid ""
"The *id* argument is the thread id of the target thread, as returned "
"by :c:func:`PyThread_get_thread_ident`. *exc* is the class of the exception "
"to be raised, or ``NULL`` to clear the pending exception (if any)."
msgstr ""
msgid ""
"Return the number of affected thread states. This is normally ``1`` if *id* "
"is found, even when no change was made (the given *exc* was already pending, "
"or *exc* is ``NULL`` but no exception is pending). If the thread id isn't "
"found, return ``0``. This raises no exceptions."
msgstr ""
msgid ""