fix: add explicit ordering to includes

henryiii · henryiii · commit 9057962d40ca · 2022-02-03T16:06:30.000-05:00
diff --git a/.clang-format b/.clang-format
@@ -9,11 +9,27 @@ BinPackParameters: false
 BreakBeforeBinaryOperators: All
 BreakConstructorInitializers: BeforeColon
 ColumnLimit: 99
+IncludeBlocks: Regroup
 IndentCaseLabels: true
 IndentPPDirectives: AfterHash
 IndentWidth: 4
 Language: Cpp
 SpaceAfterCStyleCast: true
 Standard: Cpp11
 TabWidth: 4
+IncludeCategories:
+  - Regex:           '<pybind11/.*'
+    Priority:        -1
+  - Regex:           'pybind11.h"$'
+    Priority:        1
+  - Regex:           '^".*/?detail/'
+    Priority:        1
+    SortPriority:    2
+  - Regex:           '^"'
+    Priority:        1
+    SortPriority:    3
+  - Regex:           '<[[:alnum:]._]+>'
+    Priority:        4
+  - Regex:           '.*'
+    Priority:        5
 ...
diff --git a/include/pybind11/cast.h b/include/pybind11/cast.h
@@ -15,6 +15,7 @@
 #include "detail/type_caster_base.h"
 #include "detail/typeid.h"
 #include "pytypes.h"
+
 #include <array>
 #include <cstring>
 #include <functional>
diff --git a/include/pybind11/chrono.h b/include/pybind11/chrono.h
@@ -15,9 +15,8 @@
 #include <chrono>
 #include <cmath>
 #include <ctime>
-#include <mutex>
-
 #include <datetime.h>
+#include <mutex>
 
 // Backport the PyDateTime_DELTA functions from Python3.3 if required
 #ifndef PyDateTime_DELTA_GET_DAYS
diff --git a/include/pybind11/complex.h b/include/pybind11/complex.h
@@ -10,6 +10,7 @@
 #pragma once
 
 #include "pybind11.h"
+
 #include <complex>
 
 /// glibc defines I as a macro which breaks things, e.g., boost template names
diff --git a/include/pybind11/detail/internals.h b/include/pybind11/detail/internals.h
@@ -10,6 +10,7 @@
 #pragma once
 
 #include "../pytypes.h"
+
 #include <exception>
 
 /// Tracks the `internals` and `type_info` ABI version independent of the main library version.
diff --git a/include/pybind11/detail/type_caster_base.h b/include/pybind11/detail/type_caster_base.h
@@ -14,6 +14,7 @@
 #include "descr.h"
 #include "internals.h"
 #include "typeid.h"
+
 #include <cstdint>
 #include <iterator>
 #include <new>
diff --git a/include/pybind11/embed.h b/include/pybind11/embed.h
@@ -9,8 +9,8 @@
 
 #pragma once
 
-#include "eval.h"
 #include "pybind11.h"
+#include "eval.h"
 
 #include <memory>
 #include <vector>
diff --git a/include/pybind11/eval.h b/include/pybind11/eval.h
@@ -11,10 +11,10 @@
 
 #pragma once
 
-#include <utility>
-
 #include "pybind11.h"
 
+#include <utility>
+
 PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE)
 PYBIND11_NAMESPACE_BEGIN(detail)
 
diff --git a/include/pybind11/functional.h b/include/pybind11/functional.h
@@ -10,6 +10,7 @@
 #pragma once
 
 #include "pybind11.h"
+
 #include <functional>
 
 PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE)
diff --git a/include/pybind11/numpy.h b/include/pybind11/numpy.h
@@ -9,8 +9,9 @@
 
 #pragma once
 
-#include "complex.h"
 #include "pybind11.h"
+#include "complex.h"
+
 #include <algorithm>
 #include <array>
 #include <cstdint>
diff --git a/include/pybind11/pybind11.h b/include/pybind11/pybind11.h
@@ -10,21 +10,20 @@
 
 #pragma once
 
-#include "attr.h"
 #include "detail/class.h"
 #include "detail/init.h"
+#include "attr.h"
 #include "gil.h"
 #include "options.h"
 
 #include <cstdlib>
+#include <cstring>
 #include <memory>
 #include <new>
 #include <string>
 #include <utility>
 #include <vector>
 
-#include <cstring>
-
 #if defined(__cpp_lib_launder) && !(defined(_MSC_VER) && (_MSC_VER < 1914))
 #    define PYBIND11_STD_LAUNDER std::launder
 #    define PYBIND11_HAS_STD_LAUNDER 1
diff --git a/include/pybind11/pytypes.h b/include/pybind11/pytypes.h
@@ -9,8 +9,9 @@
 
 #pragma once
 
-#include "buffer_info.h"
 #include "detail/common.h"
+#include "buffer_info.h"
+
 #include <type_traits>
 #include <utility>
 
diff --git a/include/pybind11/stl.h b/include/pybind11/stl.h
@@ -9,8 +9,9 @@
 
 #pragma once
 
-#include "detail/common.h"
 #include "pybind11.h"
+#include "detail/common.h"
+
 #include <deque>
 #include <iostream>
 #include <list>
diff --git a/include/pybind11/stl/filesystem.h b/include/pybind11/stl/filesystem.h
@@ -4,12 +4,11 @@
 
 #pragma once
 
-#include "../cast.h"
 #include "../pybind11.h"
-#include "../pytypes.h"
-
 #include "../detail/common.h"
 #include "../detail/descr.h"
+#include "../cast.h"
+#include "../pytypes.h"
 
 #include <string>
 
diff --git a/tests/constructor_stats.h b/tests/constructor_stats.h
@@ -66,6 +66,7 @@ inspection/testing in python) by using the functions with `print_` replaced with
 */
 
 #include "pybind11_tests.h"
+
 #include <list>
 #include <sstream>
 #include <typeindex>
diff --git a/tests/cross_module_gil_utils.cpp b/tests/cross_module_gil_utils.cpp
@@ -6,9 +6,10 @@
     All rights reserved. Use of this source code is governed by a
     BSD-style license that can be found in the LICENSE file.
 */
-#include <cstdint>
 #include <pybind11/pybind11.h>
 
+#include <cstdint>
+
 // This file mimics a DSO that makes pybind11 calls but does not define a
 // PYBIND11_MODULE. The purpose is to test that such a DSO can create a
 // py::gil_scoped_acquire when the running thread is in a GIL-released state.
diff --git a/tests/local_bindings.h b/tests/local_bindings.h
@@ -1,8 +1,8 @@
 #pragma once
-#include <utility>
-
 #include "pybind11_tests.h"
 
+#include <utility>
+
 /// Simple class used to test py::local:
 template <int>
 class LocalBase {
diff --git a/tests/object.h b/tests/object.h
@@ -2,6 +2,7 @@
 #    define __OBJECT_H
 
 #    include "constructor_stats.h"
+
 #    include <atomic>
 
 /// Reference counted object base class
diff --git a/tests/pybind11_cross_module_tests.cpp b/tests/pybind11_cross_module_tests.cpp
@@ -7,12 +7,12 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
+#include <pybind11/stl_bind.h>
+
 #include "local_bindings.h"
 #include "pybind11_tests.h"
 #include "test_exceptions.h"
 
-#include <pybind11/stl_bind.h>
-
 #include <numeric>
 #include <utility>
 
diff --git a/tests/pybind11_tests.cpp b/tests/pybind11_tests.cpp
@@ -8,6 +8,7 @@
 */
 
 #include "pybind11_tests.h"
+
 #include "constructor_stats.h"
 
 #include <functional>
diff --git a/tests/test_buffers.cpp b/tests/test_buffers.cpp
@@ -7,9 +7,10 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
+#include <pybind11/stl.h>
+
 #include "constructor_stats.h"
 #include "pybind11_tests.h"
-#include <pybind11/stl.h>
 
 TEST_SUBMODULE(buffers, m) {
     // test_from_python / test_to_python:
diff --git a/tests/test_builtin_casters.cpp b/tests/test_builtin_casters.cpp
@@ -7,9 +7,10 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
-#include "pybind11_tests.h"
 #include <pybind11/complex.h>
 
+#include "pybind11_tests.h"
+
 struct ConstRefCasted {
     int tag;
 };
diff --git a/tests/test_callbacks.cpp b/tests/test_callbacks.cpp
@@ -7,9 +7,11 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
+#include <pybind11/functional.h>
+
 #include "constructor_stats.h"
 #include "pybind11_tests.h"
-#include <pybind11/functional.h>
+
 #include <thread>
 
 int dummy_function(int i) { return i + 1; }
diff --git a/tests/test_chrono.cpp b/tests/test_chrono.cpp
@@ -8,9 +8,11 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
+#include <pybind11/chrono.h>
+
 #include "pybind11_tests.h"
+
 #include <chrono>
-#include <pybind11/chrono.h>
 
 struct different_resolutions {
     using time_point_h = std::chrono::time_point<std::chrono::system_clock, std::chrono::hours>;
diff --git a/tests/test_class.cpp b/tests/test_class.cpp
@@ -14,10 +14,11 @@
 #    include <aligned_new>
 #endif
 
+#include <pybind11/stl.h>
+
 #include "constructor_stats.h"
 #include "local_bindings.h"
 #include "pybind11_tests.h"
-#include <pybind11/stl.h>
 
 #include <utility>
 
diff --git a/tests/test_copy_move.cpp b/tests/test_copy_move.cpp
@@ -8,9 +8,10 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
+#include <pybind11/stl.h>
+
 #include "constructor_stats.h"
 #include "pybind11_tests.h"
-#include <pybind11/stl.h>
 
 template <typename derived>
 struct empty {
diff --git a/tests/test_eigen.cpp b/tests/test_eigen.cpp
@@ -7,11 +7,12 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
-#include "constructor_stats.h"
-#include "pybind11_tests.h"
 #include <pybind11/eigen.h>
 #include <pybind11/stl.h>
 
+#include "constructor_stats.h"
+#include "pybind11_tests.h"
+
 #if defined(_MSC_VER)
 #    if _MSC_VER < 1910                 // VS 2015's MSVC
 #        pragma warning(disable : 4127) // C4127: conditional expression is constant
diff --git a/tests/test_embed/test_interpreter.cpp b/tests/test_embed/test_interpreter.cpp
@@ -7,7 +7,6 @@
 #endif
 
 #include <catch.hpp>
-
 #include <cstdlib>
 #include <fstream>
 #include <functional>
diff --git a/tests/test_eval.cpp b/tests/test_eval.cpp
@@ -10,6 +10,7 @@
 #include <pybind11/eval.h>
 
 #include "pybind11_tests.h"
+
 #include <utility>
 
 TEST_SUBMODULE(eval_, m) {
diff --git a/tests/test_exceptions.cpp b/tests/test_exceptions.cpp
@@ -9,8 +9,8 @@
 #include "test_exceptions.h"
 
 #include "local_bindings.h"
-
 #include "pybind11_tests.h"
+
 #include <exception>
 #include <stdexcept>
 #include <utility>
diff --git a/tests/test_exceptions.h b/tests/test_exceptions.h
@@ -1,5 +1,6 @@
 #pragma once
 #include "pybind11_tests.h"
+
 #include <stdexcept>
 
 // shared exceptions for cross_module_tests
diff --git a/tests/test_factory_constructors.cpp b/tests/test_factory_constructors.cpp
@@ -10,6 +10,7 @@
 
 #include "constructor_stats.h"
 #include "pybind11_tests.h"
+
 #include <cmath>
 #include <new>
 #include <utility>
diff --git a/tests/test_gil_scoped.cpp b/tests/test_gil_scoped.cpp
@@ -7,9 +7,10 @@
     BSD-style license that can be found in the LICENSE file.
 */
 
-#include "pybind11_tests.h"
 #include <pybind11/functional.h>
 
+#include "pybind11_tests.h"
+
 class VirtClass {
 public:
     virtual ~VirtClass() = default;
diff --git a/tests/test_iostream.cpp b/tests/test_iostream.cpp
@@ -11,11 +11,13 @@
 #    pragma warning(disable : 4702)      // unreachable code in system header (xatomic.h(382))
 #endif
 
+#include <pybind11/iostream.h>
+
 #include "pybind11_tests.h"
+
 #include <atomic>
 #include <iostream>
 #include <mutex>
-#include <pybind11/iostream.h>
 #include <string>
 #include <thread>
 
diff --git a/tests/test_kwargs_and_defaults.cpp b/tests/test_kwargs_and_defaults.cpp
diff --git a/tests/test_local_bindings.cpp b/tests/test_local_bindings.cpp
diff --git a/tests/test_numpy_array.cpp b/tests/test_numpy_array.cpp
diff --git a/tests/test_numpy_dtypes.cpp b/tests/test_numpy_dtypes.cpp
diff --git a/tests/test_numpy_vectorize.cpp b/tests/test_numpy_vectorize.cpp
diff --git a/tests/test_opaque_types.cpp b/tests/test_opaque_types.cpp
diff --git a/tests/test_operator_overloading.cpp b/tests/test_operator_overloading.cpp
diff --git a/tests/test_pytypes.cpp b/tests/test_pytypes.cpp
diff --git a/tests/test_sequences_and_iterators.cpp b/tests/test_sequences_and_iterators.cpp
diff --git a/tests/test_stl.cpp b/tests/test_stl.cpp
diff --git a/tests/test_stl_binders.cpp b/tests/test_stl_binders.cpp
diff --git a/tests/test_tagbased_polymorphic.cpp b/tests/test_tagbased_polymorphic.cpp
diff --git a/tests/test_thread.cpp b/tests/test_thread.cpp
diff --git a/tests/test_virtual_functions.cpp b/tests/test_virtual_functions.cpp
