# SOME DESCRIPTIVE TITLE.

# Copyright (C) 2001-2025, Python Software Foundation

# This file is distributed under the same license as the Python package.

# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

#

#, fuzzy

msgid ""

msgstr ""

"Project-Id-Version: Python 3.13\n"

"Report-Msgid-Bugs-To: \n"

"POT-Creation-Date: 2025-02-10 02:51+0330\n"

"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

"Language-Team: LANGUAGE <LL@li.org>\n"

"MIME-Version: 1.0\n"

"Content-Type: text/plain; charset=UTF-8\n"

"Content-Transfer-Encoding: 8bit\n"

#: c-api/init.rst:8

msgid "Initialization, Finalization, and Threads"

msgstr ""

#: c-api/init.rst:10

msgid "See :ref:`Python Initialization Configuration <init-config>` for details on how to configure the interpreter prior to initialization."

msgstr ""

#: c-api/init.rst:16

msgid "Before Python Initialization"

msgstr ""

#: c-api/init.rst:18

msgid "In an application embedding Python, the :c:func:`Py_Initialize` function must be called before using any other Python/C API functions; with the exception of a few functions and the :ref:`global configuration variables <global-conf-vars>`."

msgstr ""

#: c-api/init.rst:23

msgid "The following functions can be safely called before Python is initialized:"

msgstr ""

#: c-api/init.rst:25

msgid "Functions that initialize the interpreter:"

msgstr ""

#: c-api/init.rst:27

msgid ":c:func:`Py_Initialize`"

msgstr ""

#: c-api/init.rst:28

msgid ":c:func:`Py_InitializeEx`"

msgstr ""

#: c-api/init.rst:29

msgid ":c:func:`Py_InitializeFromConfig`"

msgstr ""

#: c-api/init.rst:30

msgid ":c:func:`Py_BytesMain`"

msgstr ""

#: c-api/init.rst:31

msgid ":c:func:`Py_Main`"

msgstr ""

#: c-api/init.rst:32

msgid "the runtime pre-initialization functions covered in :ref:`init-config`"

msgstr ""

#: c-api/init.rst:34

msgid "Configuration functions:"

msgstr ""

#: c-api/init.rst:36

msgid ":c:func:`PyImport_AppendInittab`"

msgstr ""

#: c-api/init.rst:37

msgid ":c:func:`PyImport_ExtendInittab`"

msgstr ""

#: c-api/init.rst:38

msgid ":c:func:`!PyInitFrozenExtensions`"

msgstr ""

#: c-api/init.rst:39

msgid ":c:func:`PyMem_SetAllocator`"

msgstr ""

#: c-api/init.rst:40

msgid ":c:func:`PyMem_SetupDebugHooks`"

msgstr ""

#: c-api/init.rst:41

msgid ":c:func:`PyObject_SetArenaAllocator`"

msgstr ""

#: c-api/init.rst:42

msgid ":c:func:`Py_SetProgramName`"

msgstr ""

#: c-api/init.rst:43

msgid ":c:func:`Py_SetPythonHome`"

msgstr ""

#: c-api/init.rst:44

msgid ":c:func:`PySys_ResetWarnOptions`"

msgstr ""

#: c-api/init.rst:45

msgid "the configuration functions covered in :ref:`init-config`"

msgstr ""

#: c-api/init.rst:47

msgid "Informative functions:"

msgstr ""

#: c-api/init.rst:49

#: c-api/init.rst:57

msgid ":c:func:`Py_IsInitialized`"

msgstr ""

#: c-api/init.rst:50

msgid ":c:func:`PyMem_GetAllocator`"

msgstr ""

#: c-api/init.rst:51

msgid ":c:func:`PyObject_GetArenaAllocator`"

msgstr ""

#: c-api/init.rst:52

msgid ":c:func:`Py_GetBuildInfo`"

msgstr ""

#: c-api/init.rst:53

msgid ":c:func:`Py_GetCompiler`"

msgstr ""

#: c-api/init.rst:54

msgid ":c:func:`Py_GetCopyright`"

msgstr ""

#: c-api/init.rst:55

msgid ":c:func:`Py_GetPlatform`"

msgstr ""

#: c-api/init.rst:56

msgid ":c:func:`Py_GetVersion`"

msgstr ""

#: c-api/init.rst:59

msgid "Utilities:"

msgstr ""

#: c-api/init.rst:61

msgid ":c:func:`Py_DecodeLocale`"

msgstr ""

#: c-api/init.rst:62

msgid "the status reporting and utility functions covered in :ref:`init-config`"

msgstr ""

#: c-api/init.rst:64

msgid "Memory allocators:"

msgstr ""

#: c-api/init.rst:66

msgid ":c:func:`PyMem_RawMalloc`"

msgstr ""

#: c-api/init.rst:67

msgid ":c:func:`PyMem_RawRealloc`"

msgstr ""

#: c-api/init.rst:68

msgid ":c:func:`PyMem_RawCalloc`"

msgstr ""

#: c-api/init.rst:69

msgid ":c:func:`PyMem_RawFree`"

msgstr ""

#: c-api/init.rst:71

msgid "Synchronization:"

msgstr ""

#: c-api/init.rst:73

msgid ":c:func:`PyMutex_Lock`"

msgstr ""

#: c-api/init.rst:74

msgid ":c:func:`PyMutex_Unlock`"

msgstr ""

#: c-api/init.rst:78

msgid "Despite their apparent similarity to some of the functions listed above, the following functions **should not be called** before the interpreter has been initialized: :c:func:`Py_EncodeLocale`, :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`, :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome`, :c:func:`Py_GetProgramName`, :c:func:`PyEval_InitThreads`, and :c:func:`Py_RunMain`."

msgstr ""

#: c-api/init.rst:90

msgid "Global configuration variables"

msgstr ""

#: c-api/init.rst:92

msgid "Python has variables for the global configuration to control different features and options. By default, these flags are controlled by :ref:`command line options <using-on-interface-options>`."

msgstr ""

#: c-api/init.rst:96

msgid "When a flag is set by an option, the value of the flag is the number of times that the option was set. For example, ``-b`` sets :c:data:`Py_BytesWarningFlag` to 1 and ``-bb`` sets :c:data:`Py_BytesWarningFlag` to 2."

msgstr ""

#: c-api/init.rst:102

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.bytes_warning` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:106

msgid "Issue a warning when comparing :class:`bytes` or :class:`bytearray` with :class:`str` or :class:`bytes` with :class:`int`. Issue an error if greater or equal to ``2``."

msgstr ""

#: c-api/init.rst:110

msgid "Set by the :option:`-b` option."

msgstr ""

#: c-api/init.rst:116

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.parser_debug` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:120

msgid "Turn on parser debugging output (for expert only, depending on compilation options)."

msgstr ""

#: c-api/init.rst:123

msgid "Set by the :option:`-d` option and the :envvar:`PYTHONDEBUG` environment variable."

msgstr ""

#: c-api/init.rst:130

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.write_bytecode` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:134

msgid "If set to non-zero, Python won't try to write ``.pyc`` files on the import of source modules."

msgstr ""

#: c-api/init.rst:137

msgid "Set by the :option:`-B` option and the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable."

msgstr ""

#: c-api/init.rst:144

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.pathconfig_warnings` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:148

msgid "Suppress error messages when calculating the module search path in :c:func:`Py_GetPath`."

msgstr ""

#: c-api/init.rst:151

msgid "Private flag used by ``_freeze_module`` and ``frozenmain`` programs."

msgstr ""

#: c-api/init.rst:157

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.hash_seed` and :c:member:`PyConfig.use_hash_seed` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:162

msgid "Set to ``1`` if the :envvar:`PYTHONHASHSEED` environment variable is set to a non-empty string."

msgstr ""

#: c-api/init.rst:165

msgid "If the flag is non-zero, read the :envvar:`PYTHONHASHSEED` environment variable to initialize the secret hash seed."

msgstr ""

#: c-api/init.rst:172

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.use_environment` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:176

msgid "Ignore all :envvar:`!PYTHON*` environment variables, e.g. :envvar:`PYTHONPATH` and :envvar:`PYTHONHOME`, that might be set."

msgstr ""

#: c-api/init.rst:179

msgid "Set by the :option:`-E` and :option:`-I` options."

msgstr ""

#: c-api/init.rst:185

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.inspect` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:189

msgid "When a script is passed as first argument or the :option:`-c` option is used, enter interactive mode after executing the script or the command, even when :data:`sys.stdin` does not appear to be a terminal."

msgstr ""

#: c-api/init.rst:193

msgid "Set by the :option:`-i` option and the :envvar:`PYTHONINSPECT` environment variable."

msgstr ""

#: c-api/init.rst:200

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.interactive` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:204

msgid "Set by the :option:`-i` option."

msgstr ""

#: c-api/init.rst:210

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.isolated` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:214

msgid "Run Python in isolated mode. In isolated mode :data:`sys.path` contains neither the script's directory nor the user's site-packages directory."

msgstr ""

#: c-api/init.rst:217

msgid "Set by the :option:`-I` option."

msgstr ""

#: c-api/init.rst:225

msgid "This API is kept for backward compatibility: setting :c:member:`PyPreConfig.legacy_windows_fs_encoding` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:229

msgid "If the flag is non-zero, use the ``mbcs`` encoding with ``replace`` error handler, instead of the UTF-8 encoding with ``surrogatepass`` error handler, for the :term:`filesystem encoding and error handler`."

msgstr ""

#: c-api/init.rst:233

msgid "Set to ``1`` if the :envvar:`PYTHONLEGACYWINDOWSFSENCODING` environment variable is set to a non-empty string."

msgstr ""

#: c-api/init.rst:236

msgid "See :pep:`529` for more details."

msgstr ""

#: c-api/init.rst:238

#: c-api/init.rst:256

msgid "Availability"

msgstr ""

#: c-api/init.rst:244

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.legacy_windows_stdio` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:248

msgid "If the flag is non-zero, use :class:`io.FileIO` instead of :class:`!io._WindowsConsoleIO` for :mod:`sys` standard streams."

msgstr ""

#: c-api/init.rst:251

msgid "Set to ``1`` if the :envvar:`PYTHONLEGACYWINDOWSSTDIO` environment variable is set to a non-empty string."

msgstr ""

#: c-api/init.rst:254

msgid "See :pep:`528` for more details."

msgstr ""

#: c-api/init.rst:262

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.site_import` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:266

msgid "Disable the import of the module :mod:`site` and the site-dependent manipulations of :data:`sys.path` that it entails. Also disable these manipulations if :mod:`site` is explicitly imported later (call :func:`site.main` if you want them to be triggered)."

msgstr ""

#: c-api/init.rst:271

msgid "Set by the :option:`-S` option."

msgstr ""

#: c-api/init.rst:277

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.user_site_directory` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:281

msgid "Don't add the :data:`user site-packages directory <site.USER_SITE>` to :data:`sys.path`."

msgstr ""

#: c-api/init.rst:284

msgid "Set by the :option:`-s` and :option:`-I` options, and the :envvar:`PYTHONNOUSERSITE` environment variable."

msgstr ""

#: c-api/init.rst:291

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.optimization_level` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:295

msgid "Set by the :option:`-O` option and the :envvar:`PYTHONOPTIMIZE` environment variable."

msgstr ""

#: c-api/init.rst:302

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.quiet` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:306

msgid "Don't display the copyright and version messages even in interactive mode."

msgstr ""

#: c-api/init.rst:308

msgid "Set by the :option:`-q` option."

msgstr ""

#: c-api/init.rst:316

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.buffered_stdio` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:320

msgid "Force the stdout and stderr streams to be unbuffered."

msgstr ""

#: c-api/init.rst:322

msgid "Set by the :option:`-u` option and the :envvar:`PYTHONUNBUFFERED` environment variable."

msgstr ""

#: c-api/init.rst:329

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.verbose` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:333

msgid "Print a message each time a module is initialized, showing the place (filename or built-in module) from which it is loaded. If greater or equal to ``2``, print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit."

msgstr ""

#: c-api/init.rst:338

msgid "Set by the :option:`-v` option and the :envvar:`PYTHONVERBOSE` environment variable."

msgstr ""

#: c-api/init.rst:345

msgid "Initializing and finalizing the interpreter"

msgstr ""

#: c-api/init.rst:360

msgid "Initialize the Python interpreter. In an application embedding Python, this should be called before using any other Python/C API functions; see :ref:`Before Python Initialization <pre-init-safe>` for the few exceptions."

msgstr ""

#: c-api/init.rst:364

msgid "This initializes the table of loaded modules (``sys.modules``), and creates the fundamental modules :mod:`builtins`, :mod:`__main__` and :mod:`sys`. It also initializes the module search path (``sys.path``). It does not set ``sys.argv``; use the :ref:`Python Initialization Configuration <init-config>` API for that. This is a no-op when called for a second time (without calling :c:func:`Py_FinalizeEx` first). There is no return value; it is a fatal error if the initialization fails."

msgstr ""

#: c-api/init.rst:372

#: c-api/init.rst:386

msgid "Use :c:func:`Py_InitializeFromConfig` to customize the :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:376

msgid "On Windows, changes the console mode from ``O_TEXT`` to ``O_BINARY``, which will also affect non-Python uses of the console using the C Runtime."

msgstr ""

#: c-api/init.rst:382

msgid "This function works like :c:func:`Py_Initialize` if *initsigs* is ``1``. If *initsigs* is ``0``, it skips initialization registration of signal handlers, which may be useful when CPython is embedded as part of a larger application."

msgstr ""

#: c-api/init.rst:392

msgid "Initialize Python from *config* configuration, as described in :ref:`init-from-config`."

msgstr ""

#: c-api/init.rst:395

msgid "See the :ref:`init-config` section for details on pre-initializing the interpreter, populating the runtime configuration structure, and querying the returned status structure."

msgstr ""

#: c-api/init.rst:402

msgid "Return true (nonzero) when the Python interpreter has been initialized, false (zero) if not. After :c:func:`Py_FinalizeEx` is called, this returns false until :c:func:`Py_Initialize` is called again."

msgstr ""

#: c-api/init.rst:409

msgid "Return true (non-zero) if the main Python interpreter is :term:`shutting down <interpreter shutdown>`. Return false (zero) otherwise."

msgstr ""

#: c-api/init.rst:417

msgid "Undo all initializations made by :c:func:`Py_Initialize` and subsequent use of Python/C API functions, and destroy all sub-interpreters (see :c:func:`Py_NewInterpreter` below) that were created and not yet destroyed since the last call to :c:func:`Py_Initialize`. Ideally, this frees all memory allocated by the Python interpreter. This is a no-op when called for a second time (without calling :c:func:`Py_Initialize` again first)."

msgstr ""

#: c-api/init.rst:424

msgid "Since this is the reverse of :c:func:`Py_Initialize`, it should be called in the same thread with the same interpreter active. That means the main thread and the main interpreter. This should never be called while :c:func:`Py_RunMain` is running."

msgstr ""

#: c-api/init.rst:429

msgid "Normally the return value is ``0``. If there were errors during finalization (flushing buffered data), ``-1`` is returned."

msgstr ""

#: c-api/init.rst:433

msgid "This function is provided for a number of reasons. An embedding application might want to restart Python without having to restart the application itself. An application that has loaded the Python interpreter from a dynamically loadable library (or DLL) might want to free all memory allocated by Python before unloading the DLL. During a hunt for memory leaks in an application a developer might want to free all memory allocated by Python before exiting from the application."

msgstr ""

#: c-api/init.rst:441

msgid "**Bugs and caveats:** The destruction of modules and objects in modules is done in random order; this may cause destructors (:meth:`~object.__del__` methods) to fail when they depend on other objects (even functions) or modules. Dynamically loaded extension modules loaded by Python are not unloaded. Small amounts of memory allocated by the Python interpreter may not be freed (if you find a leak, please report it). Memory tied up in circular references between objects is not freed. Some memory allocated by extension modules may not be freed. Some extensions may not work properly if their initialization routine is called more than once; this can happen if an application calls :c:func:`Py_Initialize` and :c:func:`Py_FinalizeEx` more than once."

msgstr ""

#: c-api/init.rst:452

msgid "Raises an :ref:`auditing event <auditing>` ``cpython._PySys_ClearAuditHooks`` with no arguments."

msgstr ""

#: c-api/init.rst:459

msgid "This is a backwards-compatible version of :c:func:`Py_FinalizeEx` that disregards the return value."

msgstr ""

#: c-api/init.rst:465

msgid "Similar to :c:func:`Py_Main` but *argv* is an array of bytes strings, allowing the calling application to delegate the text decoding step to the CPython runtime."

msgstr ""

#: c-api/init.rst:474

msgid "The main program for the standard interpreter, encapsulating a full initialization/finalization cycle, as well as additional behaviour to implement reading configurations settings from the environment and command line, and then executing ``__main__`` in accordance with :ref:`using-on-cmdline`."

msgstr ""

#: c-api/init.rst:480

msgid "This is made available for programs which wish to support the full CPython command line interface, rather than just embedding a Python runtime in a larger application."

msgstr ""

#: c-api/init.rst:484

msgid "The *argc* and *argv* parameters are similar to those which are passed to a C program's :c:func:`main` function, except that the *argv* entries are first converted to ``wchar_t`` using :c:func:`Py_DecodeLocale`. It is also important to note that the argument list entries may be modified to point to strings other than those passed in (however, the contents of the strings pointed to by the argument list are not modified)."

msgstr ""

#: c-api/init.rst:491

msgid "The return value will be ``0`` if the interpreter exits normally (i.e., without an exception), ``1`` if the interpreter exits due to an exception, or ``2`` if the argument list does not represent a valid Python command line."

msgstr ""

#: c-api/init.rst:496

msgid "Note that if an otherwise unhandled :exc:`SystemExit` is raised, this function will not return ``1``, but exit the process, as long as ``Py_InspectFlag`` is not set. If ``Py_InspectFlag`` is set, execution will drop into the interactive Python prompt, at which point a second otherwise unhandled :exc:`SystemExit` will still exit the process, while any other means of exiting will set the return value as described above."

msgstr ""

#: c-api/init.rst:503

msgid "In terms of the CPython runtime configuration APIs documented in the :ref:`runtime configuration <init-config>` section (and without accounting for error handling), ``Py_Main`` is approximately equivalent to::"

msgstr ""

#: c-api/init.rst:507

msgid "PyConfig config;\n"

"PyConfig_InitPythonConfig(&config);\n"

"PyConfig_SetArgv(&config, argc, argv);\n"

"Py_InitializeFromConfig(&config);\n"

"PyConfig_Clear(&config);\n"

"\n"

"Py_RunMain();"

msgstr ""

#: c-api/init.rst:515

msgid "In normal usage, an embedding application will call this function *instead* of calling :c:func:`Py_Initialize`, :c:func:`Py_InitializeEx` or :c:func:`Py_InitializeFromConfig` directly, and all settings will be applied as described elsewhere in this documentation. If this function is instead called *after* a preceding runtime initialization API call, then exactly which environmental and command line configuration settings will be updated is version dependent (as it depends on which settings correctly support being modified after they have already been set once when the runtime was first initialized)."

msgstr ""

#: c-api/init.rst:528

msgid "Executes the main module in a fully configured CPython runtime."

msgstr ""

#: c-api/init.rst:530

msgid "Executes the command (:c:member:`PyConfig.run_command`), the script (:c:member:`PyConfig.run_filename`) or the module (:c:member:`PyConfig.run_module`) specified on the command line or in the configuration. If none of these values are set, runs the interactive Python prompt (REPL) using the ``__main__`` module's global namespace."

msgstr ""

#: c-api/init.rst:536

msgid "If :c:member:`PyConfig.inspect` is not set (the default), the return value will be ``0`` if the interpreter exits normally (that is, without raising an exception), or ``1`` if the interpreter exits due to an exception. If an otherwise unhandled :exc:`SystemExit` is raised, the function will immediately exit the process instead of returning ``1``."

msgstr ""

#: c-api/init.rst:542

msgid "If :c:member:`PyConfig.inspect` is set (such as when the :option:`-i` option is used), rather than returning when the interpreter exits, execution will instead resume in an interactive Python prompt (REPL) using the ``__main__`` module's global namespace. If the interpreter exited with an exception, it is immediately raised in the REPL session. The function return value is then determined by the way the *REPL session* terminates: returning ``0`` if the session terminates without raising an unhandled exception, exiting immediately for an unhandled :exc:`SystemExit`, and returning ``1`` for any other unhandled exception."

msgstr ""

#: c-api/init.rst:552

msgid "This function always finalizes the Python interpreter regardless of whether it returns a value or immediately exits the process due to an unhandled :exc:`SystemExit` exception."

msgstr ""

#: c-api/init.rst:556

msgid "See :ref:`Python Configuration <init-python-config>` for an example of a customized Python that always runs in isolated mode using :c:func:`Py_RunMain`."

msgstr ""

#: c-api/init.rst:562

msgid "Register an :mod:`atexit` callback for the target interpreter *interp*. This is similar to :c:func:`Py_AtExit`, but takes an explicit interpreter and data pointer for the callback."

msgstr ""

#: c-api/init.rst:566

msgid "The :term:`GIL` must be held for *interp*."

msgstr ""

#: c-api/init.rst:571

msgid "Process-wide parameters"

msgstr ""

#: c-api/init.rst:581

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.program_name` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:585

msgid "This function should be called before :c:func:`Py_Initialize` is called for the first time, if it is called at all. It tells the interpreter the value of the ``argv[0]`` argument to the :c:func:`main` function of the program (converted to wide characters). This is used by :c:func:`Py_GetPath` and some other functions below to find the Python run-time libraries relative to the interpreter executable. The default value is ``'python'``. The argument should point to a zero-terminated wide character string in static storage whose contents will not change for the duration of the program's execution. No code in the Python interpreter will change the contents of this storage."

msgstr ""

#: c-api/init.rst:596

#: c-api/init.rst:838

#: c-api/init.rst:874

#: c-api/init.rst:900

msgid "Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a :c:expr:`wchar_*` string."

msgstr ""

#: c-api/init.rst:604

msgid "Return the program name set with :c:member:`PyConfig.program_name`, or the default. The returned string points into static storage; the caller should not modify its value."

msgstr ""

#: c-api/init.rst:608

#: c-api/init.rst:630

#: c-api/init.rst:676

#: c-api/init.rst:698

#: c-api/init.rst:724

#: c-api/init.rst:912

msgid "This function should not be called before :c:func:`Py_Initialize`, otherwise it returns ``NULL``."

msgstr ""

#: c-api/init.rst:611

#: c-api/init.rst:633

#: c-api/init.rst:679

#: c-api/init.rst:701

#: c-api/init.rst:729

#: c-api/init.rst:915

msgid "It now returns ``NULL`` if called before :c:func:`Py_Initialize`."

msgstr ""

#: c-api/init.rst:614

#: c-api/init.rst:704

msgid "Get :data:`sys.executable` instead."

msgstr ""

#: c-api/init.rst:620

msgid "Return the *prefix* for installed platform-independent files. This is derived through a number of complicated rules from the program name set with :c:member:`PyConfig.program_name` and some environment variables; for example, if the program name is ``'/usr/local/bin/python'``, the prefix is ``'/usr/local'``. The returned string points into static storage; the caller should not modify its value. This corresponds to the :makevar:`prefix` variable in the top-level :file:`Makefile` and the :option:`--prefix` argument to the :program:`configure` script at build time. The value is available to Python code as ``sys.base_prefix``. It is only useful on Unix. See also the next function."

msgstr ""

#: c-api/init.rst:636

msgid "Get :data:`sys.base_prefix` instead, or :data:`sys.prefix` if :ref:`virtual environments <venv-def>` need to be handled."

msgstr ""

#: c-api/init.rst:643

msgid "Return the *exec-prefix* for installed platform-*dependent* files. This is derived through a number of complicated rules from the program name set with :c:member:`PyConfig.program_name` and some environment variables; for example, if the program name is ``'/usr/local/bin/python'``, the exec-prefix is ``'/usr/local'``. The returned string points into static storage; the caller should not modify its value. This corresponds to the :makevar:`exec_prefix` variable in the top-level :file:`Makefile` and the ``--exec-prefix`` argument to the :program:`configure` script at build time. The value is available to Python code as ``sys.base_exec_prefix``. It is only useful on Unix."

msgstr ""

#: c-api/init.rst:654

msgid "Background: The exec-prefix differs from the prefix when platform dependent files (such as executables and shared libraries) are installed in a different directory tree. In a typical installation, platform dependent files may be installed in the :file:`/usr/local/plat` subtree while platform independent may be installed in :file:`/usr/local`."

msgstr ""

#: c-api/init.rst:660

msgid "Generally speaking, a platform is a combination of hardware and software families, e.g. Sparc machines running the Solaris 2.x operating system are considered the same platform, but Intel machines running Solaris 2.x are another platform, and Intel machines running Linux are yet another platform. Different major revisions of the same operating system generally also form different platforms. Non-Unix operating systems are a different story; the installation strategies on those systems are so different that the prefix and exec-prefix are meaningless, and set to the empty string. Note that compiled Python bytecode files are platform independent (but not independent from the Python version by which they were compiled!)."

msgstr ""

#: c-api/init.rst:671

msgid "System administrators will know how to configure the :program:`mount` or :program:`automount` programs to share :file:`/usr/local` between platforms while having :file:`/usr/local/plat` be a different filesystem for each platform."

msgstr ""

#: c-api/init.rst:682

msgid "Get :data:`sys.base_exec_prefix` instead, or :data:`sys.exec_prefix` if :ref:`virtual environments <venv-def>` need to be handled."

msgstr ""

#: c-api/init.rst:692

msgid "Return the full program name of the Python executable; this is computed as a side-effect of deriving the default module search path from the program name (set by :c:member:`PyConfig.program_name`). The returned string points into static storage; the caller should not modify its value. The value is available to Python code as ``sys.executable``."

msgstr ""

#: c-api/init.rst:714

msgid "Return the default module search path; this is computed from the program name (set by :c:member:`PyConfig.program_name`) and some environment variables. The returned string consists of a series of directory names separated by a platform dependent delimiter character. The delimiter character is ``':'`` on Unix and macOS, ``';'`` on Windows. The returned string points into static storage; the caller should not modify its value. The list :data:`sys.path` is initialized with this value on interpreter startup; it can be (and usually is) modified later to change the search path for loading modules."

msgstr ""

#: c-api/init.rst:732

msgid "Get :data:`sys.path` instead."

msgstr ""

#: c-api/init.rst:738

msgid "Return the version of this Python interpreter. This is a string that looks something like ::"

msgstr ""

#: c-api/init.rst:741

msgid "\"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \\n[GCC 4.2.3]\""

msgstr ""

#: c-api/init.rst:745

msgid "The first word (up to the first space character) is the current Python version; the first characters are the major and minor version separated by a period. The returned string points into static storage; the caller should not modify its value. The value is available to Python code as :data:`sys.version`."

msgstr ""

#: c-api/init.rst:750

msgid "See also the :c:var:`Py_Version` constant."

msgstr ""

#: c-api/init.rst:757

msgid "Return the platform identifier for the current platform. On Unix, this is formed from the \"official\" name of the operating system, converted to lower case, followed by the major revision number; e.g., for Solaris 2.x, which is also known as SunOS 5.x, the value is ``'sunos5'``. On macOS, it is ``'darwin'``. On Windows, it is ``'win'``. The returned string points into static storage; the caller should not modify its value. The value is available to Python code as ``sys.platform``."

msgstr ""

#: c-api/init.rst:768

msgid "Return the official copyright string for the current Python version, for example"

msgstr ""

#: c-api/init.rst:770

msgid "``'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'``"

msgstr ""

#: c-api/init.rst:774

msgid "The returned string points into static storage; the caller should not modify its value. The value is available to Python code as ``sys.copyright``."

msgstr ""

#: c-api/init.rst:780

msgid "Return an indication of the compiler used to build the current Python version, in square brackets, for example::"

msgstr ""

#: c-api/init.rst:783

msgid "\"[GCC 2.7.2.2]\""

msgstr ""

#: c-api/init.rst:787

#: c-api/init.rst:801

msgid "The returned string points into static storage; the caller should not modify its value. The value is available to Python code as part of the variable ``sys.version``."

msgstr ""

#: c-api/init.rst:794

msgid "Return information about the sequence number and build date and time of the current Python interpreter instance, for example ::"

msgstr ""

#: c-api/init.rst:797

msgid "\"#67, Aug 1 1997, 22:34:28\""

msgstr ""

#: c-api/init.rst:813

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.argv`, :c:member:`PyConfig.parse_argv` and :c:member:`PyConfig.safe_path` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:818

msgid "Set :data:`sys.argv` based on *argc* and *argv*. These parameters are similar to those passed to the program's :c:func:`main` function with the difference that the first entry should refer to the script file to be executed rather than the executable hosting the Python interpreter. If there isn't a script that will be run, the first entry in *argv* can be an empty string. If this function fails to initialize :data:`sys.argv`, a fatal condition is signalled using :c:func:`Py_FatalError`."

msgstr ""

#: c-api/init.rst:826

msgid "If *updatepath* is zero, this is all the function does. If *updatepath* is non-zero, the function also modifies :data:`sys.path` according to the following algorithm:"

msgstr ""

#: c-api/init.rst:830

msgid "If the name of an existing script is passed in ``argv[0]``, the absolute path of the directory where the script is located is prepended to :data:`sys.path`."

msgstr ""

#: c-api/init.rst:833

msgid "Otherwise (that is, if *argc* is ``0`` or ``argv[0]`` doesn't point to an existing file name), an empty string is prepended to :data:`sys.path`, which is the same as prepending the current working directory (``\".\"``)."

msgstr ""

#: c-api/init.rst:841

#: c-api/init.rst:877

msgid "See also :c:member:`PyConfig.orig_argv` and :c:member:`PyConfig.argv` members of the :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:845

msgid "It is recommended that applications embedding the Python interpreter for purposes other than executing a single script pass ``0`` as *updatepath*, and update :data:`sys.path` themselves if desired. See :cve:`2008-5983`."

msgstr ""

#: c-api/init.rst:850

msgid "On versions before 3.1.3, you can achieve the same effect by manually popping the first :data:`sys.path` element after having called :c:func:`PySys_SetArgv`, for example using::"

msgstr ""

#: c-api/init.rst:854

msgid "PyRun_SimpleString(\"import sys; sys.path.pop(0)\\n\");"

msgstr ""

#: c-api/init.rst:866

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.argv` and :c:member:`PyConfig.parse_argv` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:870

msgid "This function works like :c:func:`PySys_SetArgvEx` with *updatepath* set to ``1`` unless the :program:`python` interpreter was started with the :option:`-I`."

msgstr ""

#: c-api/init.rst:880

msgid "The *updatepath* value depends on :option:`-I`."

msgstr ""

#: c-api/init.rst:887

msgid "This API is kept for backward compatibility: setting :c:member:`PyConfig.home` should be used instead, see :ref:`Python Initialization Configuration <init-config>`."

msgstr ""

#: c-api/init.rst:891

msgid "Set the default \"home\" directory, that is, the location of the standard Python libraries. See :envvar:`PYTHONHOME` for the meaning of the argument string."

msgstr ""

#: c-api/init.rst:895

msgid "The argument should point to a zero-terminated character string in static storage whose contents will not change for the duration of the program's execution. No code in the Python interpreter will change the contents of this storage."

msgstr ""

#: c-api/init.rst:908

msgid "Return the default \"home\", that is, the value set by :c:member:`PyConfig.home`, or the value of the :envvar:`PYTHONHOME` environment variable if it is set."

msgstr ""

#: c-api/init.rst:918

msgid "Get :c:member:`PyConfig.home` or :envvar:`PYTHONHOME` environment variable instead."

msgstr ""

#: c-api/init.rst:926

msgid "Thread State and the Global Interpreter Lock"

msgstr ""

#: c-api/init.rst:933

msgid "The Python interpreter is not fully 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 the current thread before it can safely access 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 ""

#: c-api/init.rst:943

msgid "Therefore, the rule exists that only the thread that has acquired the :term:`GIL` may operate on Python objects or call Python/C API functions. In order to emulate concurrency of execution, the interpreter regularly tries to switch threads (see :func:`sys.setswitchinterval`). The lock is also released around potentially blocking I/O operations like reading or writing a file, so that other Python threads can run in the meantime."

msgstr ""

#: c-api/init.rst:953

msgid "The Python interpreter keeps some thread-specific bookkeeping information inside a data structure called :c:type:`PyThreadState`. There's also one global variable pointing to the current :c:type:`PyThreadState`: it can be retrieved using :c:func:`PyThreadState_Get`."

msgstr ""

#: c-api/init.rst:959

msgid "Releasing the GIL from extension code"

msgstr ""

#: c-api/init.rst:961

msgid "Most extension code manipulating the :term:`GIL` has the following simple structure::"

msgstr ""

#: c-api/init.rst:964

msgid "Save the thread state in a local variable.\n"

"Release the global interpreter lock.\n"

"... Do some blocking I/O operation ...\n"

"Reacquire the global interpreter lock.\n"

"Restore the thread state from the local variable."

msgstr ""

#: c-api/init.rst:970

msgid "This is so common that a pair of macros exists to simplify it::"

msgstr ""

#: c-api/init.rst:972

msgid "Py_BEGIN_ALLOW_THREADS\n"

"... Do some blocking I/O operation ...\n"

"Py_END_ALLOW_THREADS"

msgstr ""

#: c-api/init.rst:980

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 ""

#: c-api/init.rst:984

msgid "The block above expands to the following code::"

msgstr ""

#: c-api/init.rst:986

msgid "PyThreadState *_save;\n"

"\n"

"_save = PyEval_SaveThread();\n"

"... Do some blocking I/O operation ...\n"

"PyEval_RestoreThread(_save);"

msgstr ""

#: c-api/init.rst:996

msgid "Here is how these functions work: the global interpreter lock is used to protect the pointer to the current thread state. When releasing the lock and saving the thread state, the current thread state pointer must be retrieved before the lock is released (since another thread could immediately acquire the lock and store its own thread state in the global variable). Conversely, when acquiring the lock and restoring the thread state, the lock must be acquired before storing the thread state pointer."

msgstr ""

#: c-api/init.rst:1005

msgid "Calling system I/O functions is the most common use case for releasing the GIL, but it can also be useful before calling long-running computations which don't need access to Python objects, such as compression or cryptographic functions operating over memory buffers. For example, the standard :mod:`zlib` and :mod:`hashlib` modules release the GIL when compressing or hashing data."

msgstr ""

#: c-api/init.rst:1016

msgid "Non-Python created threads"

msgstr ""

#: c-api/init.rst:1018

msgid "When threads are created using the dedicated Python APIs (such as the :mod:`threading` module), a thread state is automatically associated to them and the code showed above is therefore correct. However, when threads are created from C (for example by a third-party library with its own thread management), they don't hold the GIL, nor is there a thread state structure for them."

msgstr ""

#: c-api/init.rst:1025

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 thread state data structure, then acquiring the GIL, and finally storing their thread state pointer, before you can start using the Python/C API. When you are done, you should reset the thread state pointer, release the GIL, and finally free the thread state data structure."

msgstr ""

#: c-api/init.rst:1033

msgid "The :c:func:`PyGILState_Ensure` and :c:func:`PyGILState_Release` functions do all of the above automatically. The typical idiom for calling into Python from a C thread is::"

msgstr ""

#: c-api/init.rst:1037

msgid "PyGILState_STATE gstate;\n"

"gstate = PyGILState_Ensure();\n"

"\n"

"/* Perform Python actions here. */\n"

"result = CallSomeFunction();\n"

"/* evaluate result or handle exception */\n"

"\n"

"/* Release the thread. No Python API allowed beyond this point. */\n"

"PyGILState_Release(gstate);"

msgstr ""

#: c-api/init.rst:1047

msgid "Note that the ``PyGILState_*`` functions assume there is only one global interpreter (created automatically by :c:func:`Py_Initialize`). Python supports the creation of additional interpreters (using :c:func:`Py_NewInterpreter`), but mixing multiple interpreters and the ``PyGILState_*`` API is unsupported."

msgstr ""

#: c-api/init.rst:1057

msgid "Cautions about fork()"

msgstr ""

#: c-api/init.rst:1059

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 ""

#: c-api/init.rst:1065

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 ""

#: c-api/init.rst:1080

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 ""

#: c-api/init.rst:1093

msgid "High-level API"

msgstr ""

#: c-api/init.rst:1095

msgid "These are the most commonly used types and functions when writing C extension code, or when embedding the Python interpreter:"

msgstr ""

#: c-api/init.rst:1100

msgid "This data structure represents the state shared by a number of cooperating threads. Threads belonging to the same interpreter share their module administration and a few other internal items. There are no public members in this structure."

msgstr ""

#: c-api/init.rst:1105

msgid "Threads belonging to different interpreters initially share nothing, except process state like available memory, open file descriptors and such. The global interpreter lock is also shared by all threads, regardless of to which interpreter they belong."

msgstr ""

#: c-api/init.rst:1113

msgid "This data structure represents the state of a single thread. The only public data member is:"

msgstr ""

#: c-api/init.rst:1118

msgid "This thread's interpreter state."

msgstr ""

#: c-api/init.rst:1129

msgid "Deprecated function which does nothing."

msgstr ""

#: c-api/init.rst:1131

msgid "In Python 3.6 and older, this function created the GIL if it didn't exist."

msgstr ""

#: c-api/init.rst:1133

msgid "The function now does nothing."

msgstr ""

#: c-api/init.rst:1136

msgid "This function is now called by :c:func:`Py_Initialize()`, so you don't have to call it yourself anymore."

msgstr ""

#: c-api/init.rst:1140

msgid "This function cannot be called before :c:func:`Py_Initialize()` anymore."

msgstr ""

#: c-api/init.rst:1150

msgid "Release the global interpreter lock (if it has been created) and reset the thread state to ``NULL``, returning the previous thread state (which is not ``NULL``). If the lock has been created, the current thread must have acquired it."

msgstr ""

#: c-api/init.rst:1158

msgid "Acquire the global interpreter lock (if it has been created) and set the thread state to *tstate*, which must not be ``NULL``. If the lock has been created, the current thread must not have acquired it, otherwise deadlock ensues."

msgstr ""

#: c-api/init.rst:1164

#: c-api/init.rst:1223

#: c-api/init.rst:1519

msgid "Calling this function from a thread when the runtime is finalizing will terminate the thread, even if the thread was not created by Python. You can use :c:func:`Py_IsFinalizing` or :func:`sys.is_finalizing` to check if the interpreter is in process of being finalized before calling this function to avoid unwanted termination."

msgstr ""

#: c-api/init.rst:1172

msgid "Return the current thread state. The global interpreter lock must be held. When the current thread state is ``NULL``, this issues a fatal error (so that the caller needn't check for ``NULL``)."

msgstr ""

#: c-api/init.rst:1176

msgid "See also :c:func:`PyThreadState_GetUnchecked`."

msgstr ""

#: c-api/init.rst:1181

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 ""

#: c-api/init.rst:1185

msgid "In Python 3.5 to 3.12, the function was private and known as ``_PyThreadState_UncheckedGet()``."

msgstr ""

#: c-api/init.rst:1192

msgid "Swap the current thread state with the thread state given by the argument *tstate*, which may be ``NULL``. The global interpreter lock must be held and is not released."

msgstr ""

#: c-api/init.rst:1197

msgid "The following functions use thread-local storage, and are not compatible with sub-interpreters:"

msgstr ""

#: c-api/init.rst:1202

msgid "Ensure that the current thread is ready to call the Python C API regardless of the current state of Python, or of the global interpreter lock. 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 ""

#: c-api/init.rst:1212

msgid "The return value is an opaque \"handle\" to the 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 ""

#: c-api/init.rst:1219

msgid "When the function returns, the current thread will hold the GIL and be able to call arbitrary Python code. Failure is a fatal error."

msgstr ""

#: c-api/init.rst:1231

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 GILState API)."

msgstr ""

#: c-api/init.rst:1236

msgid "Every call to :c:func:`PyGILState_Ensure` must be matched by a call to :c:func:`PyGILState_Release` on the same thread."

msgstr ""

#: c-api/init.rst:1242

msgid "Get the current thread state for this thread. May return ``NULL`` if no GILState API has been used on the current thread. Note that the main thread always has such a thread-state, even if no auto-thread-state call has been made on the main thread. This is mainly a helper/diagnostic function."

msgstr ""

#: c-api/init.rst:1250

msgid "Return ``1`` if the current thread is holding the GIL and ``0`` otherwise. This function can be called from any thread at any time. Only if it has had its Python thread state initialized and currently is holding the GIL will it return ``1``. This is mainly a helper/diagnostic function. It can be useful for example in callback contexts or memory allocation functions when knowing that the GIL is locked can allow the caller to perform sensitive actions or otherwise behave differently."

msgstr ""

#: c-api/init.rst:1262

msgid "The following macros are normally used without a trailing semicolon; look for example usage in the Python source distribution."

msgstr ""

#: c-api/init.rst:1268

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 ""

#: c-api/init.rst:1276