泛型for迭代器的类型推导漏掉了带__call的类

[blanhhy]

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Type Checking

Expected Behaviour

---@class Iter
---@operator call:number?
local iter

for i in iter do end -- 'i' should be 'number'

Actual Behaviour

---@class Iter
---@operator call:number?
local iter

for i in iter do end -- 'i' is 'unknown'

Reproduction steps

1. copy the code above into IDE
2. hover the mouse over the var i

Additional Notes

原因是luals在构造迭代器节点时，只对第一个表达式使用getReturn，而后者只能用来得到函数的返回类型。后续未处理__call的情况，导致除了函数之外的所有callable都被忽略。

Log File

No response

[Issues-translate-bot]

Sumneko Lua translate bot

---

Title: The type deduction of the generic for iterator misses the class with __call

[tomlau10]

我印象中 @operator call 有很多功能還未有實裝
按 maintainer 建議是用 @overload fun():...
#2143 (comment)

現狀來說可以寫成如下

---@class Iter
---@overload fun():number?
local iter

for i in iter do end -- 'i' is 'number' now

[blanhhy]

我印象中 @operator call 有很多功能還未有實裝 按 maintainer 建議是用 @overload fun():... #2143 (comment)

現狀來說可以寫成如下

---@Class Iter
---@overload fun():number?
local iter

for i in iter do end -- 'i' is 'number' now

@tomlau10 我知道这样能行。但是也有不太适用的情况，比如假如是这种情形：

---@class Iter
---@class MyIter : Iter
---@overload fun():number?
local myiter

---@param iter Iter
local function takeIter(iter) end

takeIter(myiter) ---> param-type-mismatch

@overload 会给它联合一个函数类型，然后阻碍多态

[tomlau10]

@overload 会给它联合一个函数类型，然后阻碍多态

確實會出現以下 error

Cannot assign `MyIter` to parameter `Iter`.
- `unknown` cannot match `Iter`
- Type `unknown` cannot match `Iter`Lua Diagnostics.(param-type-mismatch)

感覺上是另外的 bug，因為 error msg 中是說 unknown cannot match Iter 而不是說 function cannot match Iter ? 🤔

---

我試到的 workaround (當然你或許也會認為未必適合)

1. 我項目的 .luarc.json 一般還會打開 "type.weakUnionCheck": true
   => 只要傳入的 param 其中1個 type 滿足 function param 要求，就不會報 param-type-mismatch
   https://luals.github.io/wiki/settings/#typeweakunioncheck

2. 另1個 workaround: 考慮將 ---@class Iter 也繼承 function
   試了這個情況下不會報錯

---@class Iter: function

3. 單獨在 takeIter 的 function param annotation 增加 function type

---@param iter Iter|function
local function takeIter(iter) end

[blanhhy]

感觉上是另外的 bug，因为 error msg 中是说 cannot match而不是说 cannot match？🤔unknown``Iter``function``Iter

这个呢，貌似和缓存污染有关...我没有深究也不确定。而且看起来是 @class + @overload 组合会出现的特有问题，如果都用 @type 的话是正常的：

---@class Iter
---@class MyIter : Iter
---@type MyIter|fun(): number?
local myiter

---@param iter Iter
local function takeIter(iter) end
takeIter(myiter) --> `fun():number?` cannot match `Iter`

我试到的 workaround （当然你或许也会认为未必適合）

给形参或实参标 function 或多或少都会导致其他地方出问题。

打开 "type.weakUnionCheck": true 也许确实是个好办法（因为印象中在别的场景下也有联合类型检查被烦到...）。

不过，我暂时在使用补丁，能很好的解决眼下的问题。

for_call_operator.lua

但是还是希望修复能进入到luals本身啊。