Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coolcat467/idlemypyextension
Python IDLE extension to preform mypy analysis on an open file
https://github.com/coolcat467/idlemypyextension
analysis coolcat467 daemon extension hacktoberfest idle mypy python python-idle python3 tkinter tkinter-gui tkinter-python
Last synced: 2 months ago
JSON representation
Python IDLE extension to preform mypy analysis on an open file
- Host: GitHub
- URL: https://github.com/coolcat467/idlemypyextension
- Owner: CoolCat467
- License: gpl-3.0
- Created: 2022-11-28T05:14:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T04:15:30.000Z (4 months ago)
- Last Synced: 2024-09-23T16:09:19.995Z (3 months ago)
- Topics: analysis, coolcat467, daemon, extension, hacktoberfest, idle, mypy, python, python-idle, python3, tkinter, tkinter-gui, tkinter-python
- Language: Python
- Homepage: https://pypi.org/project/idlemypyextension
- Size: 244 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# IdleMypyExtension
Python IDLE extension to perform mypy analysis on an open file
[](https://github.com/CoolCat467/idlemypyextension/actions/workflows/tests.yml)
[](https://results.pre-commit.ci/latest/github/CoolCat467/idlemypyextension/main)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
## What does this extension do?
This IDLE extension hooks into the mypy daemon to type check the currently
open file or provide a function signature suggestion for the nearest function
to the top from the current input cursor location. When type checking the
currently open file with the "Type Check File" command, it will add comments
to your code wherever mypy had something to say about about that line.
You can remove type comments from the currently selected text with the
"Remove Type Comments" command.
Additionally, you can jump to the next comment this extension created in
your file with the "Find Next Type Comment" command. Finally, you can add
an inferred function signature to your file with the "Suggest Signature"
command when you are close by a function definition.
Note: On use, creates folder `mypy` within the idle user directory.
On Linux systems, this is usually `~/.idlerc/mypy`.
## Installation (Without root permissions)
1) Go to terminal and install with `pip install idlemypyextension[user]`.
2) Run command `idleuserextend; idlemypyextension`. You should see the following
output: `Config should be good! Config should be good!`.
3) Open IDLE, go to `Options` -> `Configure IDLE` -> `Extensions`.
If everything went well, alongside `ZzDummy` there should be and
option called `idlemypyextension`. This is where you can configure how
idlemypyextension works.
## Installation (Legacy, needs root permission)
1) Go to terminal and install with `pip install idlemypyextension`.
2) Run command `idlemypyextension`. You will likely see a message saying
`idlemypyextension not in system registered extensions!`. Run the command
given to add idlemypyextension to your system's IDLE extension config file.
3) Again run command `idlemypyextension`. This time, you should see the
following output: `Config should be good!`.
4) Open IDLE, go to `Options` -> `Configure IDLE` -> `Extensions`.
If everything went well, alongside `ZzDummy` there should be and
option called `idlemypyextension`. This is where you can configure how
idlemypyextension works.
## Information on options
`action_max_sec` controls how long an action is allowed to take at most,
in seconds. Default is "None".
For `daemon_flags`, see `mypy --help` for a list of valid flags.
This extension sets the following flags to be able to work properly:
```
--hide-error-context
--no-color-output
--show-absolute-path
--no-error-summary
--soft-error-limit=-1
--show-traceback
--cache-dir="~/.idlerc/mypy"
```
If you add the `--show-column-numbers` flag to `daemon_flags`, when using the
"Type Check File" command, it will add a helpful little `^` sign
in a new line below the location of the mypy message that provided a column
number, as long as that comment wouldn't break your file's indentation too much.
If you add the `--show-error-codes` flag to `daemon_flags`, when using the
"Type Check File" command, when it puts mypy's comments in your code, it will
tell you what type of error that comment is. For example, it would change the
error comment
```python
# types: error: Incompatible types in assignment (expression has type "str", variable has type "int")
```
to
```python
# types: assignment error: Incompatible types in assignment (expression has type "str", variable has type "int")
```
`search_wrap` toggles weather searching for next type comment will wrap
around or not.
`suggest_replace` toggles weather Suggest Signature will replace the
existing function definition or just add a comment with the suggested
definition
`timeout_mins` controls how long the mypy daemon will time out after,
in minutes.