cpython/Lib/test/libregrtest
Petr Viktorin 49f6beb56a
[3.12] gh-113993: Make interned strings mortal (GH-120520, GH-121364, GH-121903, GH-122303) (#123065)
This backports several PRs for gh-113993, making interned strings mortal so they can be garbage-collected when no longer needed.

* Allow interned strings to be mortal, and fix related issues (GH-120520)

  * Add an InternalDocs file describing how interning should work and how to use it.

  * Add internal functions to *explicitly* request what kind of interning is done:
    - `_PyUnicode_InternMortal`
    - `_PyUnicode_InternImmortal`
    - `_PyUnicode_InternStatic`

  * Switch uses of `PyUnicode_InternInPlace` to those.

  * Disallow using `_Py_SetImmortal` on strings directly.
    You should use `_PyUnicode_InternImmortal` instead:
    - Strings should be interned before immortalization, otherwise you're possibly
      interning a immortalizing copy.
    - `_Py_SetImmortal` doesn't handle the `SSTATE_INTERNED_MORTAL` to
      `SSTATE_INTERNED_IMMORTAL` update, and those flags can't be changed in
      backports, as they are now part of public API and version-specific ABI.

  * Add private `_only_immortal` argument for `sys.getunicodeinternedsize`, used in refleak test machinery.

   Make sure the statically allocated string singletons are unique. This means these sets are now disjoint:
    - `_Py_ID`
    - `_Py_STR` (including the empty string)
    - one-character latin-1 singletons

    Now, when you intern a singleton, that exact singleton will be interned.

  * Add a `_Py_LATIN1_CHR` macro, use it instead of `_Py_ID`/`_Py_STR` for one-character latin-1 singletons everywhere (including Clinic).

  * Intern `_Py_STR` singletons at startup.

  * Beef up the tests. Cover internal details (marked with `@cpython_only`).

  * Add lots of assertions

* Don't immortalize in PyUnicode_InternInPlace; keep immortalizing in other API (GH-121364)

  * Switch PyUnicode_InternInPlace to _PyUnicode_InternMortal, clarify docs

  * Document immortality in some functions that take `const char *`

  This is PyUnicode_InternFromString;
  PyDict_SetItemString, PyObject_SetAttrString;
  PyObject_DelAttrString; PyUnicode_InternFromString;
  and the PyModule_Add convenience functions.

  Always point out a non-immortalizing alternative.

  * Don't immortalize user-provided attr names in _ctypes

* Immortalize names in code objects to avoid crash (GH-121903)

* Intern latin-1 one-byte strings at startup (GH-122303)

There are some 3.12-specific changes, mainly to allow statically allocated strings in deepfreeze. (In 3.13, deepfreeze switched to the general `_Py_ID`/`_Py_STR`.)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
2024-09-27 13:28:48 -07:00
..
__init__.py
cmdline.py [3.12] gh-119050: Add XML support to libregrtest refleak checker (#119148) (#119272) 2024-05-20 22:56:34 +00:00
filter.py [3.12] gh-110918: Fix side effects of regrtest test_match_tests() (GH-116718) (#116726) 2024-03-13 14:16:23 +00:00
findtests.py [3.12] gh-108303: Move all pydoc related files to test_pydoc (GH-114506) (#115502) 2024-02-15 16:35:56 +03:00
logger.py [3.12] gh-99242 Ignore error when running regression tests under certain conditions. (GH-121663) (GH-121670) 2024-07-13 12:24:17 +02:00
main.py [3.12] Fix typos (#123775) (#123867) 2024-09-09 13:22:13 +00:00
mypy.ini [3.12] gh-109413: libregrtest: enable mypy's --strict-optional check on most files (#112586) (#112602) 2023-12-01 17:13:22 +00:00
pgo.py gh-111929: Fix regrtest --pgo: test_str => test_unicode (#111938) 2023-11-10 09:32:06 +00:00
refleak.py [3.12] gh-113993: Make interned strings mortal (GH-120520, GH-121364, GH-121903, GH-122303) (#123065) 2024-09-27 13:28:48 -07:00
result.py
results.py [3.12] gh-119050: Add type hints to libregrtest/results.py (GH-119144) (#119157) 2024-05-18 21:06:41 +00:00
run_workers.py [3.12] chore: fix typos (#116345) (#116370) 2024-03-05 18:51:17 +00:00
runtests.py [3.12] gh-83434: Sync libregrtest and test_regrtest with the main branch (#117250) 2024-03-26 08:04:28 +00:00
save_env.py
setup.py [3.12] gh-109413: libregrtest: Backport .py-file changes from #112558 (#112605) 2023-12-01 18:54:38 +00:00
single.py [3.12] gh-119050: Add XML support to libregrtest refleak checker (#119148) (#119272) 2024-05-20 22:56:34 +00:00
testresult.py [3.12] gh-121188: Sanitize invalid XML characters in regrtest (GH-121195) (#121205) 2024-07-01 08:47:38 +00:00
tsan.py [3.12] gh-112536: Add --tsan test for reasonable TSAN execution times. (gh-116601) (#116929) 2024-03-18 10:22:19 +01:00
utils.py [3.12] Fix typos (#123775) (#123867) 2024-09-09 13:22:13 +00:00
win_utils.py [3.12] gh-116103: Prevent error in WindowsLoadTracker.__del__ on permission error (GH-116105) (GH-116120) 2024-02-29 14:43:05 +00:00
worker.py [3.12] gh-83434: Sync libregrtest and test_regrtest with the main branch (#117250) 2024-03-26 08:04:28 +00:00