mypy icon indicating copy to clipboard operation
mypy copied to clipboard

Missing list of incomplete features

Open Barry1 opened this issue 3 years ago • 1 comments

Documentation

Within the CLI we have the command line switch --enable-incomplete-feature which expects a feature name to enable. Until now I have not been able to find a list of possible (incomplete/under development) features, which I could enable over here.

Have I missed something?

Barry1 avatar Jan 15 '23 09:01 Barry1

It's defined here, but you're right that it's not documented anywhere:

https://github.com/python/mypy/blob/83660d0ad72ab5a61cea5fe5955e66c33ef54111/mypy/options.py#L70-L73

tmke8 avatar Jan 20 '23 14:01 tmke8

So, we have to go through the codebase to identify all of the features that can be enabled with the --enable-incomplete-feature switch if I am not wrong?

som-sama avatar Jan 22 '23 08:01 som-sama

I also noticed that the enable_incomplete_feature settings key is not documented. But if I add enable_incomplete_feature = ["Unpack"] to my pyproject.toml, it seems to work as expected.

intgr avatar Mar 09 '23 14:03 intgr

I think this is somewhat intentional; incomplete features are experimental and incomplete and may be broken in some way, so we don't want to advertise them too much.

However, it should be fine to add a list to the documentation with a note that these features are experimental, we don't guarantee any form of backward compatibility, use at your own risk, etc.

JelleZijlstra avatar Mar 09 '23 17:03 JelleZijlstra

However, it should be fine to add a list to the documentation with a note that these features are experimental, we don't guarantee any form of backward compatibility, use at your own risk, etc.

I think the latter is a great idea. I'll add a TODO to look into this when I find the time otherwise feel free to pick up this issue and resolve it.

jgarte avatar Apr 12 '23 13:04 jgarte

By the way, the enable_incomplete_feature setting is still undocumented.

intgr avatar Dec 13 '23 21:12 intgr