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
// Copyright 2022 Gregory Szorc.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
/*! Functionality related to running Python interpreters. */
use {
crate::resource::BytecodeOptimizationLevel,
std::{ffi::OsString, os::raw::c_ulong, path::PathBuf, str::FromStr},
};
#[cfg(feature = "serialization")]
use serde::{Deserialize, Serialize};
/// Defines the profile to use to configure a Python interpreter.
///
/// This effectively provides a template for seeding the initial values of
/// `PyPreConfig` and `PyConfig` C structs.
///
/// Serialization type: `string`.
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum PythonInterpreterProfile {
/// Python is isolated from the system.
///
/// See <https://docs.python.org/3/c-api/init_config.html#isolated-configuration>.
///
/// Serialized value: `isolated`
Isolated,
/// Python interpreter behaves like `python`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#python-configuration>.
///
/// Serialized value: `python`
Python,
}
impl Default for PythonInterpreterProfile {
fn default() -> Self {
PythonInterpreterProfile::Isolated
}
}
impl ToString for PythonInterpreterProfile {
fn to_string(&self) -> String {
match self {
Self::Isolated => "isolated",
Self::Python => "python",
}
.to_string()
}
}
impl From<PythonInterpreterProfile> for String {
fn from(v: PythonInterpreterProfile) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for PythonInterpreterProfile {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"isolated" => Ok(Self::Isolated),
"python" => Ok(Self::Python),
_ => Err(format!(
"{} is not a valid profile; use 'isolated' or 'python'",
value
)),
}
}
}
impl TryFrom<String> for PythonInterpreterProfile {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Defines `terminfo` database resolution semantics.
///
/// Python links against libraries like `readline`, `libedit`, and `ncurses`
/// which need to utilize a `terminfo` database (a set of files defining
/// terminals and their capabilities) in order to work properly.
///
/// The absolute path to the terminfo database is typically compiled into these
/// libraries at build time. If the compiled path on the building machine doesn't
/// match the path on the runtime machine, these libraries cannot find the terminfo
/// database and terminal interactions won't work correctly because these libraries
/// don't know how to resolve terminal features. This can result in quirks like
/// the backspace key not working in prompts.
///
/// The `pyembed` Rust crate is able to point libraries at a terminfo database
/// at runtime, overriding the compiled-in default path. This enum is used
/// to control that behavior.
///
/// Serialization type: `string`.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum TerminfoResolution {
/// Resolve `terminfo` database using appropriate behavior for current OS.
///
/// We will look for the terminfo database in paths that are common for the
/// current OS / distribution. The terminfo database is present in most systems
/// (except the most barebones containers or sandboxes) and this method is
/// usually successfully in locating the terminfo database.
///
/// Serialized value: `dynamic`
Dynamic,
/// Do not attempt to resolve the `terminfo` database. Basically a no-op.
///
/// This is what should be used for applications that don't interact with the
/// terminal. Using this option will prevent some I/O syscalls that would
/// be incurred by `dynamic`.
///
/// Serialized value: `none`
None,
/// Use a specified string as the `TERMINFO_DIRS` value.
///
/// Serialized value: `static:<path>`
///
/// e.g. `static:/usr/share/terminfo`.
Static(String),
}
impl ToString for TerminfoResolution {
fn to_string(&self) -> String {
match self {
Self::Dynamic => "dynamic".to_string(),
Self::None => "none".to_string(),
Self::Static(value) => format!("static:{}", value),
}
}
}
impl From<TerminfoResolution> for String {
fn from(t: TerminfoResolution) -> Self {
t.to_string()
}
}
impl TryFrom<&str> for TerminfoResolution {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
if value == "dynamic" {
Ok(Self::Dynamic)
} else if value == "none" {
Ok(Self::None)
} else if let Some(suffix) = value.strip_prefix("static:") {
Ok(Self::Static(suffix.to_string()))
} else {
Err(format!(
"{} is not a valid terminfo resolution value",
value
))
}
}
}
impl TryFrom<String> for TerminfoResolution {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Defines a backend for a memory allocator.
///
/// This says which memory allocator API / library to configure the Python
/// interpreter to use.
///
/// Not all allocators are available in all program builds.
///
/// Serialization type: `string`
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum MemoryAllocatorBackend {
/// The default allocator as configured by Python.
///
/// This likely utilizes the system default allocator, normally the
/// `malloc()`, `free()`, etc functions from the libc implementation being
/// linked against.
///
/// Serialized value: `default`
Default,
/// Use the jemalloc allocator.
///
/// Requires the binary to be built with jemalloc support.
///
/// Never available on Windows.
///
/// Serialized value: `jemalloc`
Jemalloc,
/// Use the mimalloc allocator (<https://github.com/microsoft/mimalloc>).
///
/// Requires the binary to be built with mimalloc support.
///
/// Serialized value: `mimalloc`
Mimalloc,
/// Use the snmalloc allocator (<https://github.com/microsoft/snmalloc>).
///
/// Not always available.
///
/// Serialized value: `snmalloc`
Snmalloc,
/// Use Rust's global allocator.
///
/// The Rust allocator is less efficient than other allocators because of
/// overhead tracking allocations. For optimal performance, use the default
/// allocator. Or if Rust is using a custom global allocator, use the enum
/// variant corresponding to that allocator.
///
/// Serialized value: `rust`
Rust,
}
impl Default for MemoryAllocatorBackend {
fn default() -> Self {
if cfg!(windows) {
Self::Default
} else {
Self::Jemalloc
}
}
}
impl ToString for MemoryAllocatorBackend {
fn to_string(&self) -> String {
match self {
Self::Default => "default",
Self::Jemalloc => "jemalloc",
Self::Mimalloc => "mimalloc",
Self::Snmalloc => "snmalloc",
Self::Rust => "rust",
}
.to_string()
}
}
impl From<MemoryAllocatorBackend> for String {
fn from(v: MemoryAllocatorBackend) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for MemoryAllocatorBackend {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"default" => Ok(Self::Default),
"jemalloc" => Ok(Self::Jemalloc),
"mimalloc" => Ok(Self::Mimalloc),
"snmalloc" => Ok(Self::Snmalloc),
"rust" => Ok(Self::Rust),
_ => Err(format!("{} is not a valid memory allocator backend", value)),
}
}
}
impl TryFrom<String> for MemoryAllocatorBackend {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Holds values for `coerce_c_locale`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.coerce_c_locale>.
///
/// Serialization type: `string`
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum CoerceCLocale {
/// Read the LC_CTYPE locale to decide if it should be coerced.
///
/// Serialized value: `LC_CTYPE`
#[allow(clippy::upper_case_acronyms)]
LCCtype = 1,
/// Coerce the C locale.
///
/// Serialized value: `C`
C = 2,
}
impl ToString for CoerceCLocale {
fn to_string(&self) -> String {
match self {
Self::LCCtype => "LC_CTYPE",
Self::C => "C",
}
.to_string()
}
}
impl From<CoerceCLocale> for String {
fn from(v: CoerceCLocale) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for CoerceCLocale {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"LC_CTYPE" => Ok(Self::LCCtype),
"C" => Ok(Self::C),
_ => Err(format!("{} is not a valid C locale coercion value", value)),
}
}
}
impl TryFrom<String> for CoerceCLocale {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Defines what to do when comparing `bytes` or `bytesarray` with `str` or comparing `bytes` with `int`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.bytes_warning>.
///
/// Serialization type: `string`
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum BytesWarning {
/// Do nothing.
///
/// Serialization value: `none`
None = 0,
/// Issue a warning.
///
/// Serialization value: `warn`
Warn = 1,
/// Raise a `BytesWarning`.
///
/// Serialization value: `raise`
Raise = 2,
}
impl ToString for BytesWarning {
fn to_string(&self) -> String {
match self {
Self::None => "none",
Self::Warn => "warn",
Self::Raise => "raise",
}
.to_string()
}
}
impl From<BytesWarning> for String {
fn from(v: BytesWarning) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for BytesWarning {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"none" => Ok(Self::None),
"warn" => Ok(Self::Warn),
"raise" => Ok(Self::Raise),
_ => Err(format!("{} is not a valid bytes warning value", value)),
}
}
}
impl TryFrom<String> for BytesWarning {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
impl From<i32> for BytesWarning {
fn from(value: i32) -> BytesWarning {
match value {
0 => Self::None,
1 => Self::Warn,
_ => Self::Raise,
}
}
}
/// Control the validation behavior of hash-based .pyc files.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.check_hash_pycs_mode>.
///
/// Serialization type: `string`
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum CheckHashPycsMode {
/// Hash the source file for invalidation regardless of value of the `check_source` flag.
///
/// Serialized value: `always`
Always,
/// Assume that hash-based pycs always are valid.
///
/// Serialized value: `never`
Never,
/// The `check_source` flag in hash-based pycs determines invalidation.
///
/// Serialized value: `default`
Default,
}
impl ToString for CheckHashPycsMode {
fn to_string(&self) -> String {
match self {
Self::Always => "always",
Self::Never => "never",
Self::Default => "default",
}
.to_string()
}
}
impl From<CheckHashPycsMode> for String {
fn from(v: CheckHashPycsMode) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for CheckHashPycsMode {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"always" => Ok(Self::Always),
"never" => Ok(Self::Never),
"default" => Ok(Self::Default),
_ => Err(format!(
"{} is not a valid check hash pycs mode value",
value
)),
}
}
}
impl TryFrom<String> for CheckHashPycsMode {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Name of the Python memory allocators.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.allocator>.
///
/// Serialization type: `string`
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum Allocator {
/// Don’t change memory allocators (use defaults).
///
/// Serialized value: `not-set`
NotSet = 0,
/// Default memory allocators.
///
/// Serialized value: `default`
Default = 1,
/// Default memory allocators with debug hooks.
///
/// Serialized value: `debug`
Debug = 2,
/// Use `malloc()` from the C library.
///
/// Serialized value: `malloc`
Malloc = 3,
/// Force usage of `malloc()` with debug hooks.
///
/// Serialized value: `malloc-debug`
MallocDebug = 4,
/// Python `pymalloc` allocator.
///
/// Serialized value: `py-malloc`
PyMalloc = 5,
/// Python `pymalloc` allocator with debug hooks.
///
/// Serialized value: `py-malloc-debug`
PyMallocDebug = 6,
}
impl ToString for Allocator {
fn to_string(&self) -> String {
match self {
Self::NotSet => "not-set",
Self::Default => "default",
Self::Debug => "debug",
Self::Malloc => "malloc",
Self::MallocDebug => "malloc-debug",
Self::PyMalloc => "py-malloc",
Self::PyMallocDebug => "py-malloc-debug",
}
.to_string()
}
}
impl From<Allocator> for String {
fn from(v: Allocator) -> Self {
v.to_string()
}
}
impl TryFrom<&str> for Allocator {
type Error = String;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"not-set" => Ok(Self::NotSet),
"default" => Ok(Self::Default),
"debug" => Ok(Self::Debug),
"malloc" => Ok(Self::Malloc),
"malloc-debug" => Ok(Self::MallocDebug),
"py-malloc" => Ok(Self::PyMalloc),
"py-malloc-debug" => Ok(Self::PyMallocDebug),
_ => Err(format!("{} is not a valid allocator value", value)),
}
}
}
impl TryFrom<String> for Allocator {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Defines how to call `multiprocessing.set_start_method()` when `multiprocessing` is imported.
///
/// When set to a value that is not `none`, when `oxidized_importer.OxidizedFinder` services
/// an import of the `multiprocessing` module, it will automatically call
/// `multiprocessing.set_start_method()` to configure how worker processes are created.
///
/// If the `multiprocessing` module is not imported by `oxidized_importer.OxidizedFinder`,
/// this setting has no effect.
///
/// Serialization type: `string`
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(try_from = "String", into = "String"))]
pub enum MultiprocessingStartMethod {
/// Do not call `multiprocessing.set_start_method()`.
///
/// This mode is what Python programs do by default.
///
/// Serialized value: `none`
None,
/// Call with value `fork`.
///
/// Serialized value: `fork`
Fork,
/// Call with value `forkserver`
///
/// Serialized value: `forkserver`
ForkServer,
/// Call with value `spawn`
///
/// Serialized value: `spawn`
Spawn,
/// Call with a valid appropriate for the given environment.
///
/// This likely maps to `spawn` on Windows and `fork` on non-Windows.
///
/// Serialized value: `auto`
Auto,
}
impl ToString for MultiprocessingStartMethod {
fn to_string(&self) -> String {
match self {
Self::None => "none",
Self::Fork => "fork",
Self::ForkServer => "forkserver",
Self::Spawn => "spawn",
Self::Auto => "auto",
}
.to_string()
}
}
impl From<MultiprocessingStartMethod> for String {
fn from(v: MultiprocessingStartMethod) -> Self {
v.to_string()
}
}
impl FromStr for MultiprocessingStartMethod {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"none" => Ok(Self::None),
"fork" => Ok(Self::Fork),
"forkserver" => Ok(Self::ForkServer),
"spawn" => Ok(Self::Spawn),
"auto" => Ok(Self::Auto),
_ => Err(format!("{} is not a valid multiprocessing start method", s)),
}
}
}
impl TryFrom<&str> for MultiprocessingStartMethod {
type Error = String;
fn try_from(v: &str) -> Result<Self, Self::Error> {
Self::from_str(v)
}
}
impl TryFrom<String> for MultiprocessingStartMethod {
type Error = String;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::try_from(value.as_str())
}
}
/// Holds configuration of a Python interpreter.
///
/// This struct holds fields that are exposed by `PyPreConfig` and
/// `PyConfig` in the CPython API.
///
/// Other than the profile (which is used to initialize instances of
/// `PyPreConfig` and `PyConfig`), all fields are optional. Only fields
/// with `Some(T)` will be updated from the defaults.
#[derive(Clone, Debug, Default, PartialEq)]
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(default))]
pub struct PythonInterpreterConfig {
/// Profile to use to initialize pre-config and config state of interpreter.
pub profile: PythonInterpreterProfile,
// The following fields are from PyPreConfig or are shared with PyConfig.
/// Name of the memory allocator.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.allocator>.
pub allocator: Option<Allocator>,
/// Whether to set the LC_CTYPE locale to the user preferred locale.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.configure_locale>.
pub configure_locale: Option<bool>,
/// How to coerce the locale settings.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.coerce_c_locale>.
pub coerce_c_locale: Option<CoerceCLocale>,
/// Whether to emit a warning if the C locale is coerced.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.coerce_c_locale_warn>.
pub coerce_c_locale_warn: Option<bool>,
/// Whether to enable Python development mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.dev_mode>.
pub development_mode: Option<bool>,
/// Isolated mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.isolated>.
pub isolated: Option<bool>,
/// Whether to use legacy filesystem encodings on Windows.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.legacy_windows_fs_encoding>.
pub legacy_windows_fs_encoding: Option<bool>,
/// Whether argv should be parsed the way `python` parses them.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.parse_argv>.
pub parse_argv: Option<bool>,
/// Whether environment variables are read to control the interpreter configuration.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.use_environment>.
pub use_environment: Option<bool>,
/// Controls Python UTF-8 mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyPreConfig.utf8_mode>.
pub utf8_mode: Option<bool>,
// The following fields are from PyConfig.
/// Command line arguments.
///
/// These will become `sys.argv`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.argv>.
pub argv: Option<Vec<OsString>>,
/// Controls `sys.base_exec_prefix`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.base_exec_prefix>.
pub base_exec_prefix: Option<PathBuf>,
/// Controls `sys._base_executable`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.base_executable>.
pub base_executable: Option<PathBuf>,
/// Controls `sys.base_prefix`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.base_prefix>.
pub base_prefix: Option<PathBuf>,
/// Controls buffering on `stdout` and `stderr`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.buffered_stdio>.
pub buffered_stdio: Option<bool>,
/// Controls warnings/errors for some bytes type coercions.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.bytes_warning>.
pub bytes_warning: Option<BytesWarning>,
/// Validation mode for `.pyc` files.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.check_hash_pycs_mode>.
pub check_hash_pycs_mode: Option<CheckHashPycsMode>,
/// Controls binary mode and buffering on C standard streams.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.configure_c_stdio>.
pub configure_c_stdio: Option<bool>,
/// Dump Python references.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.dump_refs>.
pub dump_refs: Option<bool>,
/// Controls `sys.exec_prefix`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.exec_prefix>.
pub exec_prefix: Option<PathBuf>,
/// Controls `sys.executable`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.executable>.
pub executable: Option<PathBuf>,
/// Enable `faulthandler`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.faulthandler>.
pub fault_handler: Option<bool>,
/// Controls the encoding to use for filesystems/paths.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.filesystem_encoding>.
pub filesystem_encoding: Option<String>,
/// Filesystem encoding error handler.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.filesystem_errors>.
pub filesystem_errors: Option<String>,
/// Randomized hash function seed.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.hash_seed>.
pub hash_seed: Option<c_ulong>,
/// Python home directory.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.home>.
pub home: Option<PathBuf>,
/// Whether to profile `import` time.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.import_time>.
pub import_time: Option<bool>,
/// Enter interactive mode after executing a script or a command.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.inspect>.
pub inspect: Option<bool>,
/// Whether to install Python signal handlers.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.install_signal_handlers>.
pub install_signal_handlers: Option<bool>,
/// Whether to enable the interactive REPL mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.interactive>.
pub interactive: Option<bool>,
/// Controls legacy stdio behavior on Windows.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.legacy_windows_stdio>.
pub legacy_windows_stdio: Option<bool>,
/// Whether to dump statistics from the `pymalloc` allocator on exit.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.malloc_stats>.
pub malloc_stats: Option<bool>,
/// Defines `sys.path`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.module_search_paths>.
///
/// This value effectively controls the initial value of `sys.path`.
///
/// The special string `$ORIGIN` in values will be expanded to the absolute path of the
/// directory of the executable at run-time. For example, if the executable is
/// `/opt/my-application/pyapp`, `$ORIGIN` will expand to `/opt/my-application` and the
/// value `$ORIGIN/lib` will expand to `/opt/my-application/lib`.
pub module_search_paths: Option<Vec<PathBuf>>,
/// Bytecode optimization level.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.optimization_level>.
///
/// This setting is only relevant if `write_bytecode` is true and Python modules are
/// being imported from the filesystem using Python’s standard filesystem importer.
pub optimization_level: Option<BytecodeOptimizationLevel>,
/// Parser debug mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.parser_debug>.
pub parser_debug: Option<bool>,
/// Whether calculating the Python path configuration can emit warnings.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.pathconfig_warnings>.
pub pathconfig_warnings: Option<bool>,
/// Defines `sys.prefix`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.prefix>.
pub prefix: Option<PathBuf>,
/// Program named used to initialize state during path configuration.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.program_name>.
pub program_name: Option<PathBuf>,
/// Directory where `.pyc` files are written.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.pycache_prefix>.
pub pycache_prefix: Option<PathBuf>,
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.pythonpath_env>.
pub python_path_env: Option<String>,
/// Quiet mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.quiet>.
pub quiet: Option<bool>,
/// Value of the `-c` command line option.
///
/// Effectively defines Python code to evaluate in `Py_RunMain()`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.run_command>.
pub run_command: Option<String>,
/// Filename passed on the command line.
///
/// Effectively defines the Python file to run in `Py_RunMain()`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.run_filename>.
pub run_filename: Option<PathBuf>,
/// Value of the `-m` command line option.
///
/// Effectively defines the Python module to run as `__main__` in `Py_RunMain()`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.run_module>.
pub run_module: Option<String>,
/// Whether to show the total reference count at exit.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.show_ref_count>.
pub show_ref_count: Option<bool>,
/// Whether to import the `site` module at startup.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.site_import>.
///
/// The `site` module is typically not needed for standalone applications and disabling
/// it can reduce application startup time.
pub site_import: Option<bool>,
/// Whether to skip the first line of [Self::run_filename].
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.skip_source_first_line>.
pub skip_first_source_line: Option<bool>,
/// Encoding of `sys.stdout`, `sys.stderr`, and `sys.stdin`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.stdio_encoding>.
pub stdio_encoding: Option<String>,
/// Encoding error handler for `sys.stdout` and `sys.stdin`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.stdio_errors>.
pub stdio_errors: Option<String>,
/// Whether to enable `tracemalloc`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.tracemalloc>.
pub tracemalloc: Option<bool>,
/// Whether to add the user site directory to `sys.path`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.user_site_directory>.
pub user_site_directory: Option<bool>,
/// Verbose mode.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.verbose>.
pub verbose: Option<bool>,
/// Options of the `warning` module to control behavior.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.warnoptions>.
pub warn_options: Option<Vec<String>>,
/// Controls `sys.dont_write_bytecode`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.write_bytecode>.
pub write_bytecode: Option<bool>,
/// Values of the `-X` command line options / `sys._xoptions`.
///
/// See <https://docs.python.org/3/c-api/init_config.html#c.PyConfig.xoptions>.
pub x_options: Option<Vec<String>>,
}