GH-51260: [Python][Docs][CI] Disabled numpydoc PR02 check may skip PR03 #51261

Original file line number	Diff line number	Diff line change
Expand Up		@@ -1556,7 +1556,7 @@ services:
		["/arrow/ci/scripts/cpp_build.sh /arrow /build &&
		/arrow/ci/scripts/python_build.sh /arrow /build &&
		pip install -e /arrow/dev/archery[numpydoc] &&
	archery numpydoc --allow-rule GL10,PR01,PR03,PR04,PR05,PR10,RT03,YD01 &&
	archery numpydoc --allow-rule GL10,PR01,PR02,PR03,PR04,PR05,PR10,RT03,YD01 &&
		/arrow/ci/scripts/python_test.sh /arrow &&
		/arrow/ci/scripts/python_test_type_annotations.sh /arrow/python"]

Expand Down

14 changes: 14 additions & 0 deletions dev/archery/archery/lang/python.py

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -93,6 +93,10 @@ class NumpyDoc:
		EnumMeta: ["PR01"]
		}

	# When there's no signature (like for Cython classes where it can't parse
	# __init__), numpydoc sees zero parameters and reports "Unknown parameters"
	PARAMETER_CHECKS = ("PR01", "PR02", "PR03")

		def __init__(self, symbols=None):
		if not have_numpydoc:
		raise RuntimeError(
Expand Down Expand Up		@@ -203,6 +207,13 @@ def callback(obj):
		logger.warning(f"Unable to validate `{symbol}` due to `{e}`")
		return

	try:
	inspect.signature(obj)
	except (TypeError, ValueError):
	has_signature = False
	else:
	has_signature = True

		errors = []
		for errcode, errmsg in result.get('errors', []):
		if allow_rules and errcode not in allow_rules:
Expand All		@@ -213,6 +224,9 @@ def callback(obj):
		for obj_type, errcode_list
		in NumpyDoc.IGNORE_VALIDATION_ERRORS_FOR_TYPE.items()):
		continue
	if (not has_signature and
	errcode in NumpyDoc.PARAMETER_CHECKS):
	continue
		errors.append((errcode, errmsg))

		if len(errors):
Expand Down

1 change: 1 addition & 0 deletions python/pyproject.toml

Show comments View file Open in desktop

Navigation Menu