gh-127443: add tool for linting Doc/data/refcounts.dat

.github/workflows/mypy.yml

@@ -16,6 +16,7 @@ on:
       - "Tools/jit/**"
       - "Tools/peg_generator/**"
       - "Tools/requirements-dev.txt"
+      - "Tools/refcounts/lint.py"
       - "Tools/wasm/**"
   workflow_dispatch:
 
@@ -43,6 +44,7 @@ jobs:
           "Tools/cases_generator",
           "Tools/clinic",
           "Tools/jit",
+          "Tools/refcounts",
           "Tools/peg_generator",
           "Tools/wasm",
         ]

.pre-commit-config.yaml

@@ -18,6 +18,10 @@ repos:
         name: Run Ruff (lint) on Argument Clinic
         args: [--exit-non-zero-on-fix, --config=Tools/clinic/.ruff.toml]
         files: ^Tools/clinic/|Lib/test/test_clinic.py
+      - id: ruff
+        name: Run Ruff (lint) on Tools/refcounts/lint.py
+        args: [--exit-non-zero-on-fix, --config=Tools/refcounts/.ruff.toml]
+        files: ^Tools/refcounts/lint.py
       - id: ruff-format
         name: Run Ruff (format) on Doc/
         args: [--check]

Doc/data/refcounts.dat

@@ -835,11 +835,11 @@ PyEval_EvalCodeEx:PyObject*::+1:
 PyEval_EvalCodeEx:PyObject*:co:0:
 PyEval_EvalCodeEx:PyObject*:globals:0:
 PyEval_EvalCodeEx:PyObject*:locals:0:
-PyEval_EvalCodeEx:PyObject*const*:args::
+PyEval_EvalCodeEx:PyObject*const*:args:0:
 PyEval_EvalCodeEx:int:argcount::
-PyEval_EvalCodeEx:PyObject*const*:kws::
+PyEval_EvalCodeEx:PyObject*const*:kws:0:
 PyEval_EvalCodeEx:int:kwcount::
-PyEval_EvalCodeEx:PyObject*const*:defs::
+PyEval_EvalCodeEx:PyObject*const*:defs:0:
 PyEval_EvalCodeEx:int:defcount::
 PyEval_EvalCodeEx:PyObject*:kwdefs:0:
 PyEval_EvalCodeEx:PyObject*:closure:0:
@@ -1435,22 +1435,22 @@ PyModule_CheckExact:int:::
 PyModule_CheckExact:PyObject*:p:0:
 
 PyModule_Create:PyObject*::+1:
-PyModule_Create:PyModuleDef*:def::
+PyModule_Create:PyModuleDef*:def:?:
 
 PyModule_Create2:PyObject*::+1:
-PyModule_Create2:PyModuleDef*:def::
+PyModule_Create2:PyModuleDef*:def:?:
 PyModule_Create2:int:module_api_version::
 
 PyModule_ExecDef:int:::
 PyModule_ExecDef:PyObject*:module:0:
-PyModule_ExecDef:PyModuleDef*:def::
+PyModule_ExecDef:PyModuleDef*:def:?:
 
 PyModule_FromDefAndSpec:PyObject*::+1:
-PyModule_FromDefAndSpec:PyModuleDef*:def::
+PyModule_FromDefAndSpec:PyModuleDef*:def:?:
 PyModule_FromDefAndSpec:PyObject*:spec:0:
 
 PyModule_FromDefAndSpec2:PyObject*::+1:
-PyModule_FromDefAndSpec2:PyModuleDef*:def::
+PyModule_FromDefAndSpec2:PyModuleDef*:def:?:
 PyModule_FromDefAndSpec2:PyObject*:spec:0:
 PyModule_FromDefAndSpec2:int:module_api_version::
 
@@ -1486,7 +1486,7 @@ PyModule_SetDocString:PyObject*:module:0:
 PyModule_SetDocString:const char*:docstring::
 
 PyModuleDef_Init:PyObject*::0:
-PyModuleDef_Init:PyModuleDef*:def::
+PyModuleDef_Init:PyModuleDef*:def:?:
 
 PyNumber_Absolute:PyObject*::+1:
 PyNumber_Absolute:PyObject*:o:0:
@@ -2152,13 +2152,13 @@ PySlice_Unpack:Py_ssize_t*:step::
 
 PyState_AddModule:int:::
 PyState_AddModule:PyObject*:module:+1:
-PyState_AddModule:PyModuleDef*:def::
+PyState_AddModule:PyModuleDef*:def:?:
 
 PyState_FindModule:PyObject*::0:
-PyState_FindModule:PyModuleDef*:def::
+PyState_FindModule:PyModuleDef*:def:?:
 
 PyState_RemoveModule:int:::
-PyState_RemoveModule:PyModuleDef*:def::
+PyState_RemoveModule:PyModuleDef*:def:?:
 
 PyStructSequence_GET_ITEM:PyObject*::0:
 PyStructSequence_GET_ITEM:PyObject*:p:0:

Tools/refcounts/.ruff.toml

@@ -0,0 +1,43 @@
+target-version = "py312"
+line-length = 79
+fix = true
+preview = true
+
+[lint]
+select = [
+    "I", # isort
+    "D204", # 1 blank line required after class docstring
+    "D205", # 1 blank line required between summary line and description
+    "D400", # First line should end with a period
+    "D401", # First line of docstring should be in imperative mood
+    "F", # Enable all pyflakes rules
+    "E", # Enable all pycodestyle error rules
+    "W", # Enable all pycodestyle warning rules
+    "UP", # Enable all pyupgrade rules
+    "RUF100", # Ban unused `# noqa` comments
+    "PGH003", # Use specific rule codes when ignoring type issues
+    "PGH004", # Use specific rule codes when using noqa
+    "C4", # flake8-comprehensions
+    "ISC", # flake8-implicit-str-concat
+    "TCH", # flake8-type-checking
+    "PTH", # flake8-use-pathlib
+    "PERF101", # unnecessary-list-cast
+    "PERF102", # incorrect-dict-iterator
+    "PERF401", # manual-list-comprehension
+    "PERF402", # manual-list-copy
+    "PERF403", # manual-dict-comprehension
+    "FURB101", # read-whole-file
+    "FURB103", # write-whole-file
+    "FURB110", # if-exp-instead-of-operator
+    "FURB113", # repeated-append
+    "FURB116", # f-string-number-format
+    "FURB129", # readlines-in-for
+    "FURB132", # check-and-remove-from-set
+    "FURB136", # if-expr-min-max
+    "FURB142", # for-loop-set-mutations
+    "FURB167", # regex-flag-alias
+    "FURB177", # implicit-cwd
+]
+
+[lint.pycodestyle]
+max-doc-length = 79