address review

Author: picnixz

Doc/c-api/expat.rst

@@ -18,22 +18,18 @@ the module state:
    if (capi == NULL) {
        goto error;
    }
-   if (!PyExpat_CheckCompatibility(capi)) {
+   if (!(
+        strcmp(capi->magic, PyExpat_CAPI_MAGIC) == 0
+        && (size_t)capi->size >= sizeof(struct PyExpat_CAPI)
+        && capi->MAJOR_VERSION == XML_MAJOR_VERSION
+        && capi->MINOR_VERSION == XML_MINOR_VERSION
+        && capi->MICRO_VERSION == XML_MICRO_VERSION
+   )) {
        PyErr_SetString(PyExc_ImportError, "pyexpat version is incompatible");
        goto error;
    }
 
 
-.. c:function:: int PyExpat_CheckCompatibility(struct PyExpat_CAPI *api)
-
-   Return ``1`` if *api* is compatible with the linked Expat library,
-   and ``0`` otherwise. This function never sets a Python exception.
-
-   *api* must not be ``NULL``.
-
-   .. versionadded:: next
-
-
 .. c:macro:: PyExpat_CAPI_MAGIC
 
    The Expat C API magic number.
@@ -148,23 +144,23 @@ the module state:
                    XML_Parser parser,\
                    unsigned long hash_salt)
 
-      Might be NULL for Expat versions prior to 2.1.0.
+      Might be ``NULL`` for Expat versions prior to 2.1.0.
 
       .. versionadded:: 3.4
 
    .. c:member:: XML_Bool (*SetReparseDeferralEnabled)(\
                    XML_Parser parser,\
                    XML_Bool enabled)
 
-      Might be NULL for Expat versions prior to 2.6.0.
+      Might be ``NULL`` for Expat versions prior to 2.6.0.
 
       .. versionadded:: 3.8
 
    .. c:member:: XML_Bool (*SetAllocTrackerActivationThreshold)(\
                    XML_Parser parser,\
                    unsigned long long activationThresholdBytes)
 
-      Might be NULL for Expat versions prior to 2.7.2.
+      Might be ``NULL`` for Expat versions prior to 2.7.2.
 
       .. uncomment this when the backport is done
       .. versionadded:: 3.10
@@ -173,7 +169,7 @@ the module state:
                    XML_Parser parser,\
                    float maxAmplificationFactor)
 
-      Might be NULL for Expat versions prior to 2.7.2.
+      Might be ``NULL`` for Expat versions prior to 2.7.2.
 
       .. uncomment this when the backport is done
       .. versionadded:: 3.10
@@ -182,7 +178,7 @@ the module state:
                    XML_Parser parser,\
                    unsigned long long activationThresholdBytes)
 
-      Might be NULL for Expat versions prior to 2.4.0.
+      Might be ``NULL`` for Expat versions prior to 2.4.0.
 
       .. uncomment this when the backport is done
       .. versionadded:: 3.10
@@ -191,7 +187,7 @@ the module state:
                    XML_Parser parser,\
                    float maxAmplificationFactor)
 
-      Might be NULL for Expat versions prior to 2.4.0.
+      Might be ``NULL`` for Expat versions prior to 2.4.0.
 
       .. uncomment this when the backport is done
       .. versionadded:: 3.10

Doc/conf.py

@@ -223,29 +223,6 @@
     ('envvar', 'USERPROFILE'),
 ]
 
-# Vendored types
-nitpick_ignore += [
-    ("c:identifier", "XML_Bool"),
-    ("c:identifier", "XML_Char"),
-    ("c:identifier", "XML_CharacterDataHandler"),
-    ("c:identifier", "XML_CommentHandler"),
-    ("c:identifier", "XML_DefaultHandler"),
-    ("c:identifier", "XML_Encoding"),
-    ("c:identifier", "XML_EndElementHandler"),
-    ("c:identifier", "XML_EndNamespaceDeclHandler"),
-    ("c:identifier", "XML_Error"),
-    ("c:identifier", "XML_LChar"),
-    ("c:identifier", "XML_Memory_Handling_Suite"),
-    ("c:identifier", "XML_Parser"),
-    ("c:identifier", "XML_ProcessingInstructionHandler"),
-    ("c:identifier", "XML_Size"),
-    ("c:identifier", "XML_StartDoctypeDeclHandler"),
-    ("c:identifier", "XML_StartElementHandler"),
-    ("c:identifier", "XML_StartNamespaceDeclHandler"),
-    ("c:identifier", "XML_Status"),
-    ("c:identifier", "XML_UnknownEncodingHandler"),
-]
-
 # Temporary undocumented names.
 # In future this list must be empty.
 nitpick_ignore += [
@@ -270,6 +247,30 @@
         nitpick_ignore.append(('c:identifier', name))
 del role, name
 
+# Vendored identifiers. The list does not need to be empty.
+c_id_attributes = [
+    # used in c-api/expat.rst
+    "XML_Bool",
+    "XML_Char",
+    "XML_CharacterDataHandler",
+    "XML_CommentHandler",
+    "XML_DefaultHandler",
+    "XML_Encoding",
+    "XML_EndElementHandler",
+    "XML_EndNamespaceDeclHandler",
+    "XML_Error",
+    "XML_LChar",
+    "XML_Memory_Handling_Suite",
+    "XML_Parser",
+    "XML_ProcessingInstructionHandler",
+    "XML_Size",
+    "XML_StartDoctypeDeclHandler",
+    "XML_StartElementHandler",
+    "XML_StartNamespaceDeclHandler",
+    "XML_Status",
+    "XML_UnknownEncodingHandler",
+]
+
 # Disable Docutils smartquotes for several translations
 smartquotes_excludes = {
     'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'],

Include/pyexpat.h

@@ -63,16 +63,3 @@ struct PyExpat_CAPI {
         XML_Parser parser, float maxAmplificationFactor);
     /* always add new stuff to the end! */
 };
-
-static inline int
-PyExpat_CheckCompatibility(struct PyExpat_CAPI *api)
-{
-    assert(api != NULL);
-    return (
-        strcmp(api->magic, PyExpat_CAPI_MAGIC) == 0
-        && (size_t)api->size >= sizeof(struct PyExpat_CAPI)
-        && api->MAJOR_VERSION == XML_MAJOR_VERSION
-        && api->MINOR_VERSION == XML_MINOR_VERSION
-        && api->MICRO_VERSION == XML_MICRO_VERSION
-    );
-}