pyo3_ffi/cpython/
initconfig.rs

1/* --- PyStatus ----------------------------------------------- */
2
3use crate::Py_ssize_t;
4use libc::wchar_t;
5use std::os::raw::{c_char, c_int, c_ulong};
6
7#[repr(C)]
8#[derive(Copy, Clone, Debug, PartialEq, Eq)]
9pub enum _PyStatus_TYPE {
10    _PyStatus_TYPE_OK = 0,
11    _PyStatus_TYPE_ERROR = 1,
12    _PyStatus_TYPE_EXIT = 2,
13}
14
15#[repr(C)]
16#[derive(Copy, Clone)]
17pub struct PyStatus {
18    pub _type: _PyStatus_TYPE,
19    pub func: *const c_char,
20    pub err_msg: *const c_char,
21    pub exitcode: c_int,
22}
23
24extern "C" {
25    pub fn PyStatus_Ok() -> PyStatus;
26    pub fn PyStatus_Error(err_msg: *const c_char) -> PyStatus;
27    pub fn PyStatus_NoMemory() -> PyStatus;
28    pub fn PyStatus_Exit(exitcode: c_int) -> PyStatus;
29    pub fn PyStatus_IsError(err: PyStatus) -> c_int;
30    pub fn PyStatus_IsExit(err: PyStatus) -> c_int;
31    pub fn PyStatus_Exception(err: PyStatus) -> c_int;
32}
33
34/* --- PyWideStringList ------------------------------------------------ */
35
36#[repr(C)]
37#[derive(Copy, Clone)]
38pub struct PyWideStringList {
39    pub length: Py_ssize_t,
40    pub items: *mut *mut wchar_t,
41}
42
43extern "C" {
44    pub fn PyWideStringList_Append(list: *mut PyWideStringList, item: *const wchar_t) -> PyStatus;
45    pub fn PyWideStringList_Insert(
46        list: *mut PyWideStringList,
47        index: Py_ssize_t,
48        item: *const wchar_t,
49    ) -> PyStatus;
50}
51
52/* --- PyPreConfig ----------------------------------------------- */
53
54#[repr(C)]
55#[derive(Copy, Clone)]
56pub struct PyPreConfig {
57    pub _config_init: c_int,
58    pub parse_argv: c_int,
59    pub isolated: c_int,
60    pub use_environment: c_int,
61    pub configure_locale: c_int,
62    pub coerce_c_locale: c_int,
63    pub coerce_c_locale_warn: c_int,
64
65    #[cfg(windows)]
66    pub legacy_windows_fs_encoding: c_int,
67
68    pub utf8_mode: c_int,
69    pub dev_mode: c_int,
70    pub allocator: c_int,
71}
72
73extern "C" {
74    pub fn PyPreConfig_InitPythonConfig(config: *mut PyPreConfig);
75    pub fn PyPreConfig_InitIsolatedConfig(config: *mut PyPreConfig);
76}
77
78/* --- PyConfig ---------------------------------------------- */
79
80#[repr(C)]
81#[derive(Copy, Clone)]
82pub struct PyConfig {
83    pub _config_init: c_int,
84    pub isolated: c_int,
85    pub use_environment: c_int,
86    pub dev_mode: c_int,
87    pub install_signal_handlers: c_int,
88    pub use_hash_seed: c_int,
89    pub hash_seed: c_ulong,
90    pub faulthandler: c_int,
91    #[cfg(all(Py_3_9, not(Py_3_10)))]
92    pub _use_peg_parser: c_int,
93    pub tracemalloc: c_int,
94    #[cfg(Py_3_12)]
95    pub perf_profiling: c_int,
96    pub import_time: c_int,
97    #[cfg(Py_3_11)]
98    pub code_debug_ranges: c_int,
99    pub show_ref_count: c_int,
100    #[cfg(not(Py_3_9))]
101    pub show_alloc_count: c_int,
102    pub dump_refs: c_int,
103    #[cfg(Py_3_11)]
104    pub dump_refs_file: *mut wchar_t,
105    pub malloc_stats: c_int,
106    pub filesystem_encoding: *mut wchar_t,
107    pub filesystem_errors: *mut wchar_t,
108    pub pycache_prefix: *mut wchar_t,
109    pub parse_argv: c_int,
110    #[cfg(Py_3_10)]
111    pub orig_argv: PyWideStringList,
112    pub argv: PyWideStringList,
113    #[cfg(not(Py_3_10))]
114    pub program_name: *mut wchar_t,
115    pub xoptions: PyWideStringList,
116    pub warnoptions: PyWideStringList,
117    pub site_import: c_int,
118    pub bytes_warning: c_int,
119    #[cfg(Py_3_10)]
120    pub warn_default_encoding: c_int,
121    pub inspect: c_int,
122    pub interactive: c_int,
123    pub optimization_level: c_int,
124    pub parser_debug: c_int,
125    pub write_bytecode: c_int,
126    pub verbose: c_int,
127    pub quiet: c_int,
128    pub user_site_directory: c_int,
129    pub configure_c_stdio: c_int,
130    pub buffered_stdio: c_int,
131    pub stdio_encoding: *mut wchar_t,
132    pub stdio_errors: *mut wchar_t,
133
134    #[cfg(windows)]
135    pub legacy_windows_stdio: c_int,
136
137    pub check_hash_pycs_mode: *mut wchar_t,
138    #[cfg(Py_3_11)]
139    pub use_frozen_modules: c_int,
140    #[cfg(Py_3_11)]
141    pub safe_path: c_int,
142    #[cfg(Py_3_12)]
143    pub int_max_str_digits: c_int,
144    // FIXME: this was backported to 3.13.2
145    #[cfg(all(Py_3_14, target_os = "macos"))]
146    pub use_system_logger: c_int,
147    #[cfg(Py_3_13)]
148    pub cpu_count: c_int,
149    #[cfg(Py_GIL_DISABLED)]
150    pub enable_gil: c_int,
151    #[cfg(all(Py_3_14, Py_GIL_DISABLED))]
152    pub tlbc_enabled: c_int,
153    pub pathconfig_warnings: c_int,
154    #[cfg(Py_3_10)]
155    pub program_name: *mut wchar_t,
156    pub pythonpath_env: *mut wchar_t,
157    pub home: *mut wchar_t,
158    #[cfg(Py_3_10)]
159    pub platlibdir: *mut wchar_t,
160
161    pub module_search_paths_set: c_int,
162    pub module_search_paths: PyWideStringList,
163    #[cfg(Py_3_11)]
164    pub stdlib_dir: *mut wchar_t,
165    pub executable: *mut wchar_t,
166    pub base_executable: *mut wchar_t,
167    pub prefix: *mut wchar_t,
168    pub base_prefix: *mut wchar_t,
169    pub exec_prefix: *mut wchar_t,
170    pub base_exec_prefix: *mut wchar_t,
171    #[cfg(all(Py_3_9, not(Py_3_10)))]
172    pub platlibdir: *mut wchar_t,
173    pub skip_source_first_line: c_int,
174    pub run_command: *mut wchar_t,
175    pub run_module: *mut wchar_t,
176    pub run_filename: *mut wchar_t,
177    #[cfg(Py_3_13)]
178    pub sys_path_0: *mut wchar_t,
179    pub _install_importlib: c_int,
180    pub _init_main: c_int,
181    #[cfg(all(Py_3_9, not(Py_3_12)))]
182    pub _isolated_interpreter: c_int,
183    #[cfg(Py_3_11)]
184    pub _is_python_build: c_int,
185    #[cfg(all(Py_3_9, not(Py_3_10)))]
186    pub _orig_argv: PyWideStringList,
187    #[cfg(all(Py_3_13, py_sys_config = "Py_DEBUG"))]
188    pub run_presite: *mut wchar_t,
189}
190
191extern "C" {
192    pub fn PyConfig_InitPythonConfig(config: *mut PyConfig);
193    pub fn PyConfig_InitIsolatedConfig(config: *mut PyConfig);
194    pub fn PyConfig_Clear(config: *mut PyConfig);
195    pub fn PyConfig_SetString(
196        config: *mut PyConfig,
197        config_str: *mut *mut wchar_t,
198        str: *const wchar_t,
199    ) -> PyStatus;
200    pub fn PyConfig_SetBytesString(
201        config: *mut PyConfig,
202        config_str: *mut *mut wchar_t,
203        str: *const c_char,
204    ) -> PyStatus;
205    pub fn PyConfig_Read(config: *mut PyConfig) -> PyStatus;
206    pub fn PyConfig_SetBytesArgv(
207        config: *mut PyConfig,
208        argc: Py_ssize_t,
209        argv: *mut *const c_char,
210    ) -> PyStatus;
211    pub fn PyConfig_SetArgv(
212        config: *mut PyConfig,
213        argc: Py_ssize_t,
214        argv: *mut *const wchar_t,
215    ) -> PyStatus;
216    pub fn PyConfig_SetWideStringList(
217        config: *mut PyConfig,
218        list: *mut PyWideStringList,
219        length: Py_ssize_t,
220        items: *mut *mut wchar_t,
221    ) -> PyStatus;
222}
223
224/* --- Helper functions --------------------------------------- */
225
226extern "C" {
227    pub fn Py_GetArgcArgv(argc: *mut c_int, argv: *mut *mut *mut wchar_t);
228}
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here