@@ -17,8 +17,8 @@ Got a question?
17
17
18
18
We are always happy to answer questions! Here are some good places to ask them:
19
19
20
- - for anything you're curious about, try [ gitter chat] ( https://gitter.im/python/typing )
21
20
- for general questions about Python typing, try [ typing discussions] ( https://github.com/python/typing/discussions )
21
+ - for anything you're curious about, try [ gitter chat] ( https://gitter.im/python/typing )
22
22
23
23
If you're just getting started,
24
24
[ the documentation] ( https://mypy.readthedocs.io/en/stable/index.html )
@@ -30,7 +30,6 @@ If you think you've found a bug:
30
30
- check our [ common issues page] ( https://mypy.readthedocs.io/en/stable/common_issues.html )
31
31
- search our [ issue tracker] ( https://github.com/python/mypy/issues ) to see if
32
32
it's already been reported
33
- - consider asking on [ gitter chat] ( https://gitter.im/python/typing )
34
33
35
34
To report a bug or request an enhancement:
36
35
@@ -101,8 +100,6 @@ repo directly:
101
100
102
101
``` bash
103
102
python3 -m pip install -U git+https://github.com/python/mypy.git
104
- # or if you don't have 'git' installed
105
- python3 -m pip install -U https://github.com/python/mypy/zipball/master
106
103
```
107
104
108
105
Now you can type-check the [ statically typed parts] of a program like this:
@@ -118,14 +115,16 @@ programs, even if mypy reports type errors:
118
115
python3 PROGRAM
119
116
```
120
117
121
- You can also try mypy in an [ online playground] ( https://mypy-play.net/ ) (developed by
122
- Yusuke Miyazaki). If you are working with large code bases, you can run mypy in
118
+ If you are working with large code bases, you can run mypy in
123
119
[ daemon mode] , that will give much faster (often sub-second) incremental updates:
124
120
125
121
``` bash
126
122
dmypy run -- PROGRAM
127
123
```
128
124
125
+ You can also try mypy in an [ online playground] ( https://mypy-play.net/ ) (developed by
126
+ Yusuke Miyazaki).
127
+
129
128
[ statically typed parts ] : https://mypy.readthedocs.io/en/latest/getting_started.html#function-signatures-and-dynamic-vs-static-typing
130
129
[ daemon mode ] : https://mypy.readthedocs.io/en/stable/mypy_daemon.html
131
130
@@ -134,18 +133,17 @@ Integrations
134
133
135
134
Mypy can be integrated into popular IDEs:
136
135
136
+ - VS Code: provides [ basic integration] ( https://code.visualstudio.com/docs/python/linting#_mypy ) with mypy.
137
137
- Vim:
138
138
- Using [ Syntastic] ( https://github.com/vim-syntastic/syntastic ) : in ` ~/.vimrc ` add
139
139
` let g:syntastic_python_checkers=['mypy'] `
140
140
- Using [ ALE] ( https://github.com/dense-analysis/ale ) : should be enabled by default when ` mypy ` is installed,
141
141
or can be explicitly enabled by adding ` let b:ale_linters = ['mypy'] ` in ` ~/vim/ftplugin/python.vim `
142
142
- Emacs: using [ Flycheck] ( https://github.com/flycheck/ )
143
143
- Sublime Text: [ SublimeLinter-contrib-mypy] ( https://github.com/fredcallaway/SublimeLinter-contrib-mypy )
144
- - Atom: [ linter-mypy] ( https://atom.io/packages/linter-mypy )
145
- - PyCharm: [ mypy plugin] ( https://github.com/dropbox/mypy-PyCharm-plugin ) (PyCharm integrates
146
- [ its own implementation] ( https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html ) of [ PEP 484] ( https://peps.python.org/pep-0484/ ) )
147
- - VS Code: provides [ basic integration] ( https://code.visualstudio.com/docs/python/linting#_mypy ) with mypy.
148
- - pre-commit: use [ pre-commit mirrors-mypy] ( https://github.com/pre-commit/mirrors-mypy ) .
144
+ - PyCharm: [ mypy plugin] ( https://github.com/dropbox/mypy-PyCharm-plugin )
145
+ - pre-commit: use [ pre-commit mirrors-mypy] ( https://github.com/pre-commit/mirrors-mypy ) , although
146
+ note by default this will limit mypy's ability to analyse your third party dependencies.
149
147
150
148
Web site and documentation
151
149
--------------------------
@@ -171,8 +169,6 @@ contributors of all experience levels.
171
169
172
170
To get started with developing mypy, see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
173
171
174
- If you need help getting started, don't hesitate to ask on [ gitter] ( https://gitter.im/python/typing ) .
175
-
176
172
Mypyc and compiled version of mypy
177
173
----------------------------------
178
174
@@ -190,4 +186,4 @@ To use a compiled version of a development
190
186
version of mypy, directly install a binary from
191
187
< https://github.com/mypyc/mypy_mypyc-wheels/releases/latest > .
192
188
193
- To contribute to the mypyc project, check out < https://github.com/mypyc/mypyc >
189
+ To contribute to the mypyc project, check out the issue tracker at < https://github.com/mypyc/mypyc >
0 commit comments