Fix GetStr() doc; add tests on set errors

Author: vstinner

Doc/c-api/init_config.rst

@@ -155,8 +155,8 @@ UTF-8 encoded string. See :ref:`Configuration Options <pyinitconfig-opts>`.
    * Set *\*value*, and return ``0`` on success.
    * Set an error in *config* and return ``-1`` on error.
 
-   *\*value* can be set to ``NULL`` if the option is an optional string and the
-   option is unset.
+   *\*value* can be set to ``NULL`` if the option is unset or if the option is
+   an optional string.
    Optional strings are documented with the type ``str | None`` in the
    :ref:`Configuration Options <pyinitconfig-opts>` table.
 

Lib/test/test_embed.py

@@ -1977,6 +1977,9 @@ def test_initconfig_api(self):
         self.check_all_configs("test_initconfig_api", config, preconfig,
                                api=API_ISOLATED, ignore_stderr=True)
 
+    def test_initconfig_set_errors(self):
+        self.run_embedded_interpreter("test_initconfig_set_errors")
+
     def test_initconfig_get_api(self):
         self.run_embedded_interpreter("test_initconfig_get_api")
 

Programs/_testembed.c

@@ -1772,6 +1772,99 @@ static int test_initconfig_api(void)
 }
 
 
+static void
+check_initconfig_error(PyInitConfig *config, const char *expected)
+{
+    const char *err_msg;
+    assert(PyInitConfig_GetError(config, &err_msg) == 1);
+    assert(strcmp(err_msg, expected) == 0);
+}
+
+
+// Test errors of PyInitConfig_Set*() functions
+static int test_initconfig_set_errors(void)
+{
+    char* strlist[] = {"value"};
+
+    PyInitConfig *config = PyInitConfig_Create();
+    if (config == NULL) {
+        printf("Init allocation error\n");
+        return 1;
+    }
+
+    // Unknown option
+    assert(PyInitConfig_SetInt(config, "non-existent", 123) < 0);
+    check_initconfig_error(config, "unknown config option name");
+    assert(PyInitConfig_SetStr(config, "non-existent", "abc") < 0);
+    check_initconfig_error(config, "unknown config option name");
+    assert(PyInitConfig_SetStrList(config, "non-existent",
+                                   Py_ARRAY_LENGTH(strlist), strlist) < 0);
+    check_initconfig_error(config, "unknown config option name");
+
+
+    // Wrong type
+    assert(PyInitConfig_SetInt(config, "platlibdir", 123) == -1);
+    check_initconfig_error(config, "config option type is not int");
+
+    assert(PyInitConfig_SetStr(config, "cpu_count", "abc") == -1);
+    check_initconfig_error(config, "config option type is not string");
+
+    assert(PyInitConfig_SetStrList(config, "cpu_count",
+                                   Py_ARRAY_LENGTH(strlist), strlist) < 0);
+    check_initconfig_error(config, "config option type is not strings list");
+
+
+    // Test SetInt() range: cpu_count option type is PyConfig_MEMBER_INT
+    assert(PyInitConfig_SetInt(config, "cpu_count", INT_MIN) == 0);
+    assert(PyInitConfig_SetInt(config, "cpu_count", INT_MAX) == 0);
+
+    assert(PyInitConfig_SetInt(config, "cpu_count", INT64_MIN) == -1);
+    check_initconfig_error(config, "config option value is out of int range");
+    assert(PyInitConfig_SetInt(config, "cpu_count", INT64_MAX) == -1);
+    check_initconfig_error(config, "config option value is out of int range");
+
+
+    // Test SetInt() range: verbose option type is PyConfig_MEMBER_UINT
+    assert(PyInitConfig_SetInt(config, "verbose", 0) == 0);
+    assert(PyInitConfig_SetInt(config, "verbose", UINT_MAX) == 0);
+
+    assert(PyInitConfig_SetInt(config, "verbose", -1) == -1);
+    check_initconfig_error(config, "config option value is out of unsigned int range");
+    assert(PyInitConfig_SetInt(config, "verbose", INT64_MAX) == -1);
+    check_initconfig_error(config, "config option value is out of unsigned int range");
+
+
+    // SetStr() decode error
+    assert(PyInitConfig_SetStr(config, "platlibdir", "\xff") == -1);
+    check_initconfig_error(config, "decoding error");
+
+
+    // Setting a non-optional string to NULL fails with an error,
+    // but leaves the optional unchanged.
+    if (PyInitConfig_SetStr(config, "program_name", PROGRAM_NAME_UTF8) < 0) {
+        goto error;
+    }
+    assert(PyInitConfig_SetStr(config, "program_name", NULL) < 0);
+    check_initconfig_error(config, "config option string cannot be NULL");
+    char *str;
+    assert(PyInitConfig_GetStr(config, "program_name", &str) == 0);
+    assert(strcmp(str, PROGRAM_NAME_UTF8) == 0);
+    free(str);
+
+
+    PyInitConfig_Free(config);
+    return 0;
+
+error:
+    {
+        const char *err_msg;
+        (void)PyInitConfig_GetError(config, &err_msg);
+        printf("Python init failed: %s\n", err_msg);
+        exit(1);
+    }
+}
+
+
 static int test_initconfig_get_api(void)
 {
     PyInitConfig *config = PyInitConfig_Create();
@@ -1796,7 +1889,7 @@ static int test_initconfig_get_api(void)
     assert(PyInitConfig_SetInt(config, "utf8_mode", 0) == 0);
     assert(initconfig_getint(config, "utf8_mode") == 0);
 
-    // test PyInitConfig_GetStr() on an optional string (can be NULL)
+    // test PyInitConfig_GetStr() on an unset string (NULL by default)
     char *str;
     assert(PyInitConfig_GetStr(config, "program_name", &str) == 0);
     assert(str == NULL);
@@ -3199,6 +3292,7 @@ static struct TestCase TestCases[] = {
     {"test_init_is_python_build", test_init_is_python_build},
     {"test_init_warnoptions", test_init_warnoptions},
     {"test_initconfig_api", test_initconfig_api},
+    {"test_initconfig_set_errors", test_initconfig_set_errors},
     {"test_initconfig_get_api", test_initconfig_get_api},
     {"test_initconfig_exit", test_initconfig_exit},
     {"test_initconfig_module", test_initconfig_module},