CDRIVER-6085 Reorder + annotate include directives with "IWYU pragma: export" (#2167)

* Reorder and annotate component include directives with "IWYU pragma: export"
* Apply "keep" pragma to unused headers in compat.h
* Rename bson-private.h -> bson_t-private.h
* Drive-by Python script format fixes

Author: eramongodb

.evergreen/config_generator/components/earthly.py

@@ -274,7 +274,7 @@ def earthly_task(
 
 CONTAINER_RUN_DISTROS = [
     'amazon2',
-    "debian11-latest-large",
+    'debian11-latest-large',
     'debian12-latest-large',
     'ubuntu2204-large',
     'ubuntu2404-large',

.evergreen/config_generator/components/oidc.py

@@ -1,14 +1,14 @@
 from shrub.v3.evg_build_variant import BuildVariant
-from shrub.v3.evg_command import EvgCommandType, ec2_assume_role, KeyValueParam, expansions_update
+from shrub.v3.evg_command import EvgCommandType, KeyValueParam, ec2_assume_role, expansions_update
 from shrub.v3.evg_task import EvgTask, EvgTaskRef
 from shrub.v3.evg_task_group import EvgTaskGroup
 
-from config_generator.components.funcs.run_tests import RunTests
 from config_generator.components.funcs.fetch_det import FetchDET
 from config_generator.components.funcs.fetch_source import FetchSource
+from config_generator.components.funcs.run_tests import RunTests
 from config_generator.components.sasl.openssl import SaslCyrusOpenSSLCompile
-from config_generator.etc.utils import bash_exec
 from config_generator.etc.distros import find_small_distro
+from config_generator.etc.utils import bash_exec
 
 
 def task_groups():

.evergreen/legacy_config_generator/evergreen_config_lib/testazurekms.py

@@ -101,7 +101,7 @@ def _create_variant():
         name='testazurekms-variant',
         display_name='Azure KMS',
         # Azure Virtual Machine created is Debian 11.
-        run_on='debian11-small', # TODO: switch to 'debian11-latest-small' after DEVPROD-23011 fixed.
+        run_on='debian11-small',  # TODO: switch to 'debian11-latest-small' after DEVPROD-23011 fixed.
         tasks=['testazurekms_task_group', 'testazurekms-fail-task'],
         batchtime=20160,
     )  # Use a batchtime of 14 days as suggested by the CSFLE test README

src/common/src/mlib/platform.h

@@ -37,15 +37,15 @@
         #define _WIN32_WINNT 0x601
     #endif
     // Winsock must be included before windows.h
-    #include <winsock2.h>
-    #include <windows.h>
+    #include <winsock2.h> // IWYU pragma: export
+    #include <windows.h>  // IWYU pragma: export
 #endif
 
 // POSIX headers
 #if defined(__unix__) || defined(__unix) || defined(__APPLE__)
-    #include <unistd.h>
-    #include <fcntl.h>
-    #include <sys/types.h>
+    #include <unistd.h>    // IWYU pragma: export
+    #include <fcntl.h>     // IWYU pragma: export
+    #include <sys/types.h> // IWYU pragma: export
 #endif
 
 // clang-format on

src/libbson/src/bson/bson-context-private.h

@@ -20,10 +20,11 @@
 #ifndef BSON_CONTEXT_PRIVATE_H
 #define BSON_CONTEXT_PRIVATE_H
 
+#include <bson/bson-context.h> // IWYU pragma: export
 
-#include <common-thread-private.h>
+//
 
-#include <bson/bson-context.h>
+#include <common-thread-private.h>
 
 
 BSON_BEGIN_DECLS

src/libbson/src/bson/bson-error-private.h

@@ -19,7 +19,10 @@
 #ifndef BSON_ERROR_PRIVATE_H
 #define BSON_ERROR_PRIVATE_H
 
-#include <bson/error.h>
+#include <bson/error.h> // IWYU pragma: export
+
+//
+
 #include <bson/macros.h>
 
 

src/libbson/src/bson/bson-json-private.h

@@ -19,6 +19,7 @@
 #ifndef BSON_JSON_PRIVATE_H
 #define BSON_JSON_PRIVATE_H
 
+#include <bson/bson-json.h> // IWYU pragma: export
 
 struct _bson_json_opts_t {
    bson_json_mode_t mode;

src/libbson/src/bson/bson-vector-private.h

@@ -19,6 +19,10 @@
 #ifndef BSON_VECTOR_PRIVATE_H
 #define BSON_VECTOR_PRIVATE_H
 
+#include <bson/bson-vector.h> // IWYU pragma: export
+
+//
+
 #include <bson/compat.h>
 #include <bson/macros.h>
 

src/libbson/src/bson/bson-vector.h

@@ -20,6 +20,8 @@
 #define BSON_VECTOR_H
 
 #include <bson/bson-endian.h>
+#include <bson/bson-types.h>
+#include <bson/bson_t.h>
 #include <bson/compat.h>
 #include <bson/macros.h>
 

src/libbson/src/bson/bson-writer.c

@@ -17,7 +17,7 @@
 
 #include <bson/bson-writer.h>
 
-#include <bson/bson-private.h>
+#include <bson/bson_t-private.h>
 
 
 struct _bson_writer_t {