Remove circular #include's between plpython.h and plpy_util.h.
authorTom Lane
Sun, 27 Apr 2025 15:43:02 +0000 (11:43 -0400)
committerTom Lane
Sun, 27 Apr 2025 15:43:02 +0000 (11:43 -0400)
commit2311f193ea7db23f68f5471ae2c35940fc0d4794
treecb11f54c0357ead1bfc291d3a42fff964574032f
parente8ca9ed1d260e214f02f7f5464f125fe86e55597
Remove circular #include's between plpython.h and plpy_util.h.

plpython.h included plpy_util.h, simply on the grounds that "it's
easier to just include it everywhere".  However, plpy_util.h must
include plpython.h, or it won't pass headerscheck.  While the
resulting circularity doesn't have any immediate bad effect,
it's poor design.  We have seen serious messes arise in the past
from overly-broad inclusion footprints created by such circularities,
so let's establish a project policy against it.

To fix, just replace *.c files' inclusions of plpython.h with
plpy_util.h.  They'll pull in plpython.h indirectly; indeed, almost
all have already done so via inclusions of other plpy_xxx.h headers.
(Any extensions using plpython.h can do likewise without breaking
the compatibility of their code with prior Postgres versions.)

Reported-by: Bertrand Drouvot
Author: Tom Lane 
Reviewed-by: Bertrand Drouvot
Discussion: https://postgr.es/m/[email protected]
16 files changed:
contrib/hstore_plpython/hstore_plpython.c
contrib/jsonb_plpython/jsonb_plpython.c
contrib/ltree_plpython/ltree_plpython.c
src/pl/plpython/plpy_cursorobject.c
src/pl/plpython/plpy_elog.c
src/pl/plpython/plpy_exec.c
src/pl/plpython/plpy_main.c
src/pl/plpython/plpy_planobject.c
src/pl/plpython/plpy_plpymodule.c
src/pl/plpython/plpy_procedure.c
src/pl/plpython/plpy_resultobject.c
src/pl/plpython/plpy_spi.c
src/pl/plpython/plpy_subxactobject.c
src/pl/plpython/plpy_typeio.c
src/pl/plpython/plpy_util.c
src/pl/plpython/plpython.h