mirrors/pyright
1
0
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2025-12-23 09:19:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed bug that results in a false positive when a namedtuple functional form is used with a field starting with an underscore and rename=True. This addresses #11033. (#11034)
Some checks failed
Run mypy_primer on push / Run mypy_primer on push (push) Has been cancelled
Details
Validation / Typecheck (push) Has been cancelled
Details
Validation / Style (push) Has been cancelled
Details
Validation / Test macos-latest (push) Has been cancelled
Details
Validation / Test ubuntu-latest (push) Has been cancelled
Details
Validation / Test windows-latest (push) Has been cancelled
Details
Validation / Build (push) Has been cancelled
Details
Validation / Required (push) Has been cancelled
Details

Browse source
This commit is contained in:
Eric Traut 2025-10-14 22:01:39 -07:00 • committed by GitHub
parent 80eb0dccbe
commit ba3f0d4313
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 33 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

62
packages/pyright-internal/src/analyzer/namedTuples.ts
View file

@ -12,7 +12,7 @@ import { DiagnosticRule } from '../common/diagnosticRules';
import { convertOffsetsToRange } from '../common/positionUtils';
import { TextRange } from '../common/textRange';
import { LocMessage } from '../localization/localize';
import { ArgCategory, ExpressionNode, ParamCategory, ParseNodeType, StringListNode } from '../parser/parseNodes';
import { ArgCategory, ExpressionNode, ParamCategory, ParseNodeType } from '../parser/parseNodes';
import { Tokenizer } from '../parser/tokenizer';
import { getFileInfo } from './analyzerNodeInfo';
import { DeclarationType, VariableDeclaration } from './declaration';
@ -170,6 +170,7 @@ export function createNamedTupleType(
entriesArg.valueExpression &&
entriesArg.valueExpression.nodeType === ParseNodeType.StringList
) {
const entryNameNode = entriesArg.valueExpression;
const entries = entriesArg.valueExpression.d.strings
.map((s) => s.d.value)
.join('')
@ -179,23 +180,8 @@ export function createNamedTupleType(
entries.forEach((entryName, index) => {
entryName = entryName.trim();
if (entryName) {
// Named tuples don't allow leading underscores in the field names.
if (entryName.startsWith('_')) {
evaluator.addDiagnostic(
DiagnosticRule.reportGeneralTypeIssues,
LocMessage.namedTupleFieldUnderscore(),
entriesArg.valueExpression!
);
return;
}
entryName = renameKeyword(
evaluator,
entryName,
allowRename,
entriesArg.valueExpression!,
index
);
entryName = renameUnderscore(evaluator, entryName, allowRename, entryNameNode, index);
entryName = renameKeyword(evaluator, entryName, allowRename, entryNameNode, index);
const entryType = UnknownType.create();
const paramInfo = FunctionParam.create(
@ -214,15 +200,14 @@ export function createNamedTupleType(
// In this case it's just part of a string literal value.
// The definition provider won't necessarily take the
// user to the exact spot in the string, but it's close enough.
const stringNode = entriesArg.valueExpression!;
const declaration: VariableDeclaration = {
type: DeclarationType.Variable,
node: stringNode as StringListNode,
node: entryNameNode,
isRuntimeTypeExpression: true,
uri: fileInfo.fileUri,
range: convertOffsetsToRange(
stringNode.start,
TextRange.getEnd(stringNode),
entryNameNode.start,
TextRange.getEnd(entryNameNode),
fileInfo.lines
),
moduleName: fileInfo.moduleName,
@ -289,16 +274,7 @@ export function createNamedTupleType(
entryNameNode
);
} else {
// Named tuples don't allow leading underscores in the field names.
if (entryName.startsWith('_')) {
evaluator.addDiagnostic(
DiagnosticRule.reportGeneralTypeIssues,
LocMessage.namedTupleFieldUnderscore(),
entryNameNode
);
return;
}
entryName = renameUnderscore(evaluator, entryName, allowRename, entryNameNode, index);
entryName = renameKeyword(evaluator, entryName, allowRename, entryNameNode, index);
}
} else {
@ -513,3 +489,25 @@ function renameKeyword(
evaluator.addDiagnostic(DiagnosticRule.reportGeneralTypeIssues, LocMessage.namedTupleNameKeyword(), errorNode);
return name;
}
function renameUnderscore(
evaluator: TypeEvaluator,
name: string,
allowRename: boolean,
errorNode: ExpressionNode,
index: number
): string {
if (!name.startsWith('_')) {
// No rename necessary.
return name;
}
if (allowRename) {
// Rename based on index.
return `_${index}`;
}
evaluator.addDiagnostic(DiagnosticRule.reportGeneralTypeIssues, LocMessage.namedTupleFieldUnderscore(), errorNode);
return name;
}

3
packages/pyright-internal/src/tests/samples/namedTuple11.py
View file

@ -17,3 +17,6 @@ class NT3(NamedTuple):
# This should generate an error because a field name starting with an
# underscore isn't allowed.
_oops: int
NT4 = namedtuple("NT4", "a, b, _c", rename=True)