Skip to content

Improve return type of range() function to always yield a non-empty-list #4688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ondrejmirtes merged 4 commits into from
Jan 1, 2026
Merged

Improve return type of range() function to always yield a non-empty-list #4688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a68539a
return type of `range()` function is always a `non-empty-list`
FeBe95 Dec 31, 2025
fe40eb8
add helper method for non-empty list type
FeBe95 Dec 31, 2025
f21db2b
remove redundant assertion
FeBe95 Dec 31, 2025
d326bbe
adjust tests
FeBe95 Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/Type/Constant/ConstantArrayType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,6 @@ private function getKeysOrValuesArray(array $types): self
{
$count = count($types);
$autoIndexes = range($count - count($this->optionalKeys), $count);
assert($autoIndexes !== []);

if ($this->isList->yes()) {
// Optimized version for lists: Assume that if a later key exists, then earlier keys also exist.
Expand Down
71 changes: 36 additions & 35 deletions src/Type/Php/RangeFunctionReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,39 +92,25 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
$startConstant = $endConstant;
$endConstant = $tmp;
}
return new IntersectionType([
new ArrayType(
IntegerRangeType::createAllGreaterThanOrEqualTo(0),
IntegerRangeType::fromInterval($startConstant->getValue(), $endConstant->getValue()),
return self::getNonEmptyListOfType(
IntegerRangeType::fromInterval(
$startConstant->getValue(),
$endConstant->getValue(),
),
new NonEmptyArrayType(),
new AccessoryArrayListType(),
]);
);
}

if ($stepType->isFloat()->yes()) {
return new IntersectionType([
new ArrayType(
IntegerRangeType::createAllGreaterThanOrEqualTo(0),
new FloatType(),
),
new NonEmptyArrayType(),
new AccessoryArrayListType(),
]);
return self::getNonEmptyListOfType(new FloatType());
}

return new IntersectionType([
new ArrayType(
IntegerRangeType::createAllGreaterThanOrEqualTo(0),
TypeCombinator::union(
$startConstant->generalize(GeneralizePrecision::moreSpecific()),
$endConstant->generalize(GeneralizePrecision::moreSpecific()),
$stepType->generalize(GeneralizePrecision::moreSpecific()),
),
return self::getNonEmptyListOfType(
TypeCombinator::union(
$startConstant->generalize(GeneralizePrecision::moreSpecific()),
$endConstant->generalize(GeneralizePrecision::moreSpecific()),
$stepType->generalize(GeneralizePrecision::moreSpecific()),
),
new NonEmptyArrayType(),
new AccessoryArrayListType(),
]);
);
}
$arrayBuilder = ConstantArrayTypeBuilder::createEmpty();
foreach ($rangeValues as $value) {
Expand All @@ -146,30 +132,45 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,

if ($isInteger && $isStepInteger) {
if ($argType instanceof IntegerRangeType) {
return new IntersectionType([new ArrayType(IntegerRangeType::createAllGreaterThanOrEqualTo(0), $argType), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType($argType);
}
return new IntersectionType([new ArrayType(IntegerRangeType::createAllGreaterThanOrEqualTo(0), new IntegerType()), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType(new IntegerType());
}

if ($argType->isFloat()->yes()) {
return new IntersectionType([new ArrayType(IntegerRangeType::createAllGreaterThanOrEqualTo(0), new FloatType()), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType(new FloatType());
}

$numberType = new UnionType([new IntegerType(), new FloatType()]);
$isNumber = $numberType->isSuperTypeOf($argType)->yes();
$isNumericString = $argType->isNumericString()->yes();
if ($isNumber || $isNumericString) {
return new IntersectionType([new ArrayType(IntegerRangeType::createAllGreaterThanOrEqualTo(0), $numberType), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType($numberType);
}

if ($argType->isString()->yes()) {
return new IntersectionType([new ArrayType(IntegerRangeType::createAllGreaterThanOrEqualTo(0), new StringType()), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType(new StringType());
}

return new IntersectionType([new ArrayType(
IntegerRangeType::createAllGreaterThanOrEqualTo(0),
new BenevolentUnionType([new IntegerType(), new FloatType(), new StringType()]),
), new AccessoryArrayListType()]);
return self::getNonEmptyListOfType(
new BenevolentUnionType([
new IntegerType(),
new FloatType(),
new StringType(),
]),
);
}

private static function getNonEmptyListOfType(Type $type): IntersectionType
{
return new IntersectionType([
new ArrayType(
IntegerRangeType::createAllGreaterThanOrEqualTo(0),
$type,
),
new NonEmptyArrayType(),
new AccessoryArrayListType(),
]);
}

}
8 changes: 4 additions & 4 deletions tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5594,19 +5594,19 @@ public static function dataRangeFunction(): array
'range(2.1, 5)',
],
[
'list<int>',
'non-empty-list<int>',
'range(2, 5, $integer)',
],
[
'list<float|int>',
'non-empty-list<float|int>',
'range($float, 5, $integer)',
],
[
'list<(float|int|string)>',
'non-empty-list<(float|int|string)>',
'range($float, $mixed, $integer)',
],
[
'list<(float|int|string)>',
'non-empty-list<(float|int|string)>',
'range($integer, $mixed)',
],
[
Expand Down
11 changes: 5 additions & 6 deletions tests/PHPStan/Analyser/nsrt/bug-11692.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ function doFoo(int $i, float $f, $floatOrInt): void {
assertType('non-empty-list<float>', range(1, 9999, .01));
assertType('non-empty-list<int<1, 9999>>', range(1, 9999, 3));

assertType('list<float|int>', range(1, 9999, $floatOrInt));
assertType('list<float|int>', range(1, 9999, $floatOrInt));
assertType('non-empty-list<float|int>', range(1, 9999, $floatOrInt));

assertType('list<int>', range(1, 3, $i));
assertType('list<float|int>', range(1, 3, $f));
assertType('non-empty-list<int>', range(1, 3, $i));
assertType('non-empty-list<float|int>', range(1, 3, $f));

assertType('list<int>', range(1, 9999, $i));
assertType('list<float|int>', range(1, 9999, $f));
assertType('non-empty-list<int>', range(1, 9999, $i));
assertType('non-empty-list<float|int>', range(1, 9999, $f));
}

2 changes: 1 addition & 1 deletion tests/PHPStan/Analyser/nsrt/bug-2378.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public function doFoo(
assertType('array{\'a\', \'b\', \'c\', \'d\'}', range('a', 'd'));
assertType('array{\'a\', \'c\', \'e\', \'g\', \'i\'}', range('a', 'i', 2));

assertType('list<string>', range($s, $s));
assertType('non-empty-list<string>', range($s, $s));
}

}
6 changes: 3 additions & 3 deletions tests/PHPStan/Analyser/nsrt/range-int-range.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public function zeroToMax(
int $b
): void
{
assertType('list<int<0, max>>', range($a, $b));
assertType('non-empty-list<int<0, max>>', range($a, $b));
}

/**
Expand All @@ -28,7 +28,7 @@ public function twoToTwenty(
int $b
): void
{
assertType('list<int<2, 20>>', range($a, $b));
assertType('non-empty-list<int<2, 20>>', range($a, $b));
}

/**
Expand All @@ -40,7 +40,7 @@ public function fifteenTo5(
int $b
): void
{
assertType('list<int<5, 30>>', range($a, $b));
assertType('non-empty-list<int<5, 30>>', range($a, $b));
}

public function knownRange(
Expand Down
2 changes: 1 addition & 1 deletion tests/PHPStan/Analyser/nsrt/range-numeric-string.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public function doFoo(
string $b
): void
{
assertType('list<float|int>', range($a, $b));
assertType('non-empty-list<float|int>', range($a, $b));
}

}
Loading