Skip to main content

pyo3_ffi/cpython/
initconfig.rs

1/* --- PyStatus ----------------------------------------------- */
2
3use crate::Py_ssize_t;
4use libc::wchar_t;
5use std::ffi::{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_libpython! {
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_libpython! {
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_libpython! {
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    #[cfg(Py_3_14)]
97    pub remote_debug: c_int,
98    pub import_time: c_int,
99    #[cfg(Py_3_11)]
100    pub code_debug_ranges: c_int,
101    pub show_ref_count: c_int,
102    #[cfg(not(Py_3_9))]
103    pub show_alloc_count: c_int,
104    pub dump_refs: c_int,
105    #[cfg(Py_3_11)]
106    pub dump_refs_file: *mut wchar_t,
107    pub malloc_stats: c_int,
108    #[cfg(Py_3_15)]
109    pub pymalloc_hugepages: c_int,
110    pub filesystem_encoding: *mut wchar_t,
111    pub filesystem_errors: *mut wchar_t,
112    pub pycache_prefix: *mut wchar_t,
113    pub parse_argv: c_int,
114    #[cfg(Py_3_10)]
115    pub orig_argv: PyWideStringList,
116    pub argv: PyWideStringList,
117    #[cfg(not(Py_3_10))]
118    pub program_name: *mut wchar_t,
119    pub xoptions: PyWideStringList,
120    pub warnoptions: PyWideStringList,
121    pub site_import: c_int,
122    pub bytes_warning: c_int,
123    #[cfg(Py_3_10)]
124    pub warn_default_encoding: c_int,
125    pub inspect: c_int,
126    pub interactive: c_int,
127    pub optimization_level: c_int,
128    pub parser_debug: c_int,
129    pub write_bytecode: c_int,
130    pub verbose: c_int,
131    pub quiet: c_int,
132    pub user_site_directory: c_int,
133    pub configure_c_stdio: c_int,
134    pub buffered_stdio: c_int,
135    pub stdio_encoding: *mut wchar_t,
136    pub stdio_errors: *mut wchar_t,
137
138    #[cfg(windows)]
139    pub legacy_windows_stdio: c_int,
140
141    pub check_hash_pycs_mode: *mut wchar_t,
142    #[cfg(Py_3_11)]
143    pub use_frozen_modules: c_int,
144    #[cfg(Py_3_11)]
145    pub safe_path: c_int,
146    #[cfg(Py_3_12)]
147    pub int_max_str_digits: c_int,
148    #[cfg(Py_3_14)]
149    pub thread_inherit_context: c_int,
150    #[cfg(Py_3_14)]
151    pub context_aware_warnings: c_int,
152    #[cfg(all(Py_3_14, target_os = "macos"))]
153    pub use_system_logger: c_int,
154    #[cfg(Py_3_13)]
155    pub cpu_count: c_int,
156    #[cfg(Py_GIL_DISABLED)]
157    pub enable_gil: c_int,
158    #[cfg(all(Py_3_14, Py_GIL_DISABLED))]
159    pub tlbc_enabled: c_int,
160    #[cfg(Py_3_15)]
161    pub lazy_imports: c_int,
162    pub pathconfig_warnings: c_int,
163    #[cfg(Py_3_10)]
164    pub program_name: *mut wchar_t,
165    pub pythonpath_env: *mut wchar_t,
166    pub home: *mut wchar_t,
167    #[cfg(Py_3_10)]
168    pub platlibdir: *mut wchar_t,
169
170    pub module_search_paths_set: c_int,
171    pub module_search_paths: PyWideStringList,
172    #[cfg(Py_3_11)]
173    pub stdlib_dir: *mut wchar_t,
174    pub executable: *mut wchar_t,
175    pub base_executable: *mut wchar_t,
176    pub prefix: *mut wchar_t,
177    pub base_prefix: *mut wchar_t,
178    pub exec_prefix: *mut wchar_t,
179    pub base_exec_prefix: *mut wchar_t,
180    #[cfg(all(Py_3_9, not(Py_3_10)))]
181    pub platlibdir: *mut wchar_t,
182    pub skip_source_first_line: c_int,
183    pub run_command: *mut wchar_t,
184    pub run_module: *mut wchar_t,
185    pub run_filename: *mut wchar_t,
186    #[cfg(Py_3_13)]
187    pub sys_path_0: *mut wchar_t,
188    pub _install_importlib: c_int,
189    pub _init_main: c_int,
190    #[cfg(all(Py_3_9, not(Py_3_12)))]
191    pub _isolated_interpreter: c_int,
192    #[cfg(Py_3_11)]
193    pub _is_python_build: c_int,
194    #[cfg(all(Py_3_9, not(Py_3_10)))]
195    pub _orig_argv: PyWideStringList,
196    #[cfg(all(Py_3_13, py_sys_config = "Py_DEBUG"))]
197    pub run_presite: *mut wchar_t,
198}
199
200extern_libpython! {
201    pub fn PyConfig_InitPythonConfig(config: *mut PyConfig);
202    pub fn PyConfig_InitIsolatedConfig(config: *mut PyConfig);
203    pub fn PyConfig_Clear(config: *mut PyConfig);
204    pub fn PyConfig_SetString(
205        config: *mut PyConfig,
206        config_str: *mut *mut wchar_t,
207        str: *const wchar_t,
208    ) -> PyStatus;
209    pub fn PyConfig_SetBytesString(
210        config: *mut PyConfig,
211        config_str: *mut *mut wchar_t,
212        str: *const c_char,
213    ) -> PyStatus;
214    pub fn PyConfig_Read(config: *mut PyConfig) -> PyStatus;
215    pub fn PyConfig_SetBytesArgv(
216        config: *mut PyConfig,
217        argc: Py_ssize_t,
218        argv: *mut *const c_char,
219    ) -> PyStatus;
220    pub fn PyConfig_SetArgv(
221        config: *mut PyConfig,
222        argc: Py_ssize_t,
223        argv: *mut *const wchar_t,
224    ) -> PyStatus;
225    pub fn PyConfig_SetWideStringList(
226        config: *mut PyConfig,
227        list: *mut PyWideStringList,
228        length: Py_ssize_t,
229        items: *mut *mut wchar_t,
230    ) -> PyStatus;
231}
232
233/* --- Helper functions --------------------------------------- */
234
235extern_libpython! {
236    pub fn Py_GetArgcArgv(argc: *mut c_int, argv: *mut *mut *mut wchar_t);
237}