pantsbuild / pants / 34821

0%

main: 93%

push

travis-ci-com

Improve errors for invalid `Get` objects (#10593)

There are two times an invalid `Get` can trigger errors: a) when parsing the AST in `rules.py`, or b) when Python creates the actual `Get` object, i.e. calling `Get.__init__()`. Typically, the former happens first, which was resulting in very confusing error messages, like this for the invalid line `await Get(str, AddressInput.parse(""))`:

```
▶ ./pants
'Attribute' object has no attribute 'id'
```

### After
Invalid # of args:

> Invalid Get. Expected either two or three arguments, but got 4 arguments. Failed for Get(Address, AddressInput, AddressInput.parse(), <class '_ast.Num'>) in /Users/eric/DocsLocal/code/projects/pants/src/python/pants/engine/internals/graph.py.

Invalid product:

> Invalid Get. The first argument should be the type of the product, like `Digest` or `ProcessResult`. Failed for Get(Address(), AddressInput, AddressInput.parse()) in /Users/eric/DocsLocal/code/projects/pants/src/python/pants/engine/internals/graph.py.

Invalid subject:

> Invalid Get. Because you are using the longhand form Get(ProductType, SubjectType, subject_instance), the second argument should be a type, like `MergeDigests` or `Process`. Failed for Get(Address, AddressInput(), AddressInput.parse()) in /Users/eric/DocsLocal/code/projects/pants/src/python/pants/engine/internals/graph.py.

> Invalid Get. Because you are using the shorthand form Get(ProductType, SubjectType(constructor args), the second argument should be a constructor call, like `MergeDigest(...)` or `Process(...)`. Failed for Get(Address, AddressInput) in /Users/eric/DocsLocal/code/projects/pants/src/python/pants/engine/internals/graph.py.

> Invalid Get. Because you are using the shorthand form Get(ProductType, SubjectType(constructor args), the second argument should be a top-level constructor function call, like `MergeDigest(...)` or `Process(...)`, rather than a method call. Failed for Get(Address, AddressInput.parse()) ... (continued)

86 of 86 new or added lines in 4 files covered. (100.0%)

0 of 29034 relevant lines covered (0.0%)

0.0 hits per line