# flake8-tkinter
A [flake8](https://github.com/PyCQA/flake8) plugin that helps you write better Tkinter code
_Project idea by [@insolor](https://github.com/insolor)_
## Installation
```
pip install flake8-tkinter
```
## List of warnings
Common mistakes
- **`TK102`**: Using multiple mainloop calls is unnecessary. One call is perfectly enough. ([example](#tk102))
- **`TK111`**: Calling `callback_handler()` instead of passing the reference for on-click or binding callback. ([example](#tk111))
- **`TK112`**: Calling `callback_handler()` with arguments instead of passing the reference for on-click or binding callback. If you need to call `callback_handler` with arguments, use lambda or functools.partial. ([example](#tk112))
- **`TK131`**: Assigning result of geometry manager call to a variable. ([example](#tk131))
Best practices
- **`TK141`**: Using bind without `add=True` will overwrite any existing bindings to this sequence on this widget. Either overwrite them explicitly with `add=False` or use `add=True` to keep existing bindings. ([example](#tk141))
- **`TK142`**: Creating tag bindings in a loop can lead to memory leaks. Store the returned command names in a list to clean them up later. ([example](#tk142))
- **`TK201`**: Using `from tkinter import *` is generally a bad practice and discouraged. Use `import tkinter as tk` or simply `import tkinter` instead. ([example](#tk201))
- **`TK202`**: Using `from tkinter.ttk import *` is generally a bad practice and discouraged. Use `from tkinter import ttk` instead. ([example](#tk202))
- **`TK211`**: Using `import tkinter.ttk as ttk` is pointless. Use `from tkinter import ttk` instead. ([example](#tk211))
- **`TK221`**: Using tkinter.TRUE, tkinter.FALSE, etc. is pointless. Use an appropriate Python boolean instead. ([example](#tk221))
- **`TK251`**: Using `tkinter.Message` widget. It's redundant since `tkinter.Label` provides the same functionality. ([example](#tk251))
Code quality
- **`TK304`**: Value for `add` in bind methods should be a boolean. ([example](#tk304))
Opinionated warnings
- **`TK504`**: Using a tkinter constant. Use a string literal instead (disabled by default). ([example](#tk504))
## Examples
### TK102
```python
# Bad
def foo():
top = tk.Toplevel()
...
top.mainloop()
root.mainloop()
# Good
def foo():
top = tk.Toplevel()
...
root.mainloop()
```
### TK111
```python
# Bad
tk.Button(..., command=foo())
button.config(command=bar())
button.bind("<Button-3>", baz())
# Good
tk.Button(..., command=foo)
button.config(command=bar)
button.bind("<Button-3>", baz)
```
### TK112
```python
# Bad
tk.Button(..., command=foo(arg, kwarg=...))
button.config(command=bar(arg, kwarg=...))
button.bind("<Button-3>", baz(arg, kwarg=...))
# Good
tk.Button(..., command=lambda: foo(arg, kwarg=...))
button.config(command=lambda: bar(arg, kwarg=...))
button.bind("<Button-3>", lambda e: baz(arg, kwarg=...))
```
### TK131
```python
# Bad
btn = tk.Button().grid()
# Good
btn = tk.Button()
btn.grid()
```
### TK201
```python
# Bad
from tkinter import *
# Good
import tkinter
# OR
import tkinter as tk
```
### TK202
```python
# Bad
from tkinter.ttk import *
# Good
from tkinter import ttk
```
### TK211
```python
# Bad
import tkinter.ttk as ttk
# Good
from tkinter import ttk
```
### TK221
```python
# Bad
w.pack(expand=tk.TRUE)
w.pack(expand=tk.FALSE)
w.pack(expand=tk.YES)
w.pack(expand=tk.NO)
w.pack(expand=tk.ON)
w.pack(expand=tk.OFF)
# Good
w.pack(expand=True)
w.pack(expand=False)
```
### TK141
```python
# Bad
w.bind("<Button-1>", foo)
# Good
w.bind("<Button-1>", foo, add=True)
# OR
w.bind("<Button-1>", foo, add=False)
```
### TK142
```python
# Bad
for index, foo in enumerate(foos):
w.tag_bind(f"bar_{index}", "<Button-1>", baz)
# Good
for index, foo in enumerate(foos):
tcl_command = w.tag_bind(f"bar_{index}", "<Button-1>", baz)
bindings.append(tcl_command) # Clean them up later with `.deletecommand()`
```
### TK251
_Yes, there's some minor diffrence in text wrapping, but that can be easily fixed
```python
# Bad
w = tkinter.Message()
# Good
w = tkinter.Label()
```
### TK304
```python
# Bad
w.bind("<Button-1>", foo, add="+")
# Good
w.bind("<Button-1>", foo, add=True)
```
### TK504
```python
# Bad
w.pack(side=tkinter.BOTTOM, fill=tkinter.BOTH)
# Good
w.pack(side="bottom", fill="both")
```
## Planned warnings
- Common mistakes (TK101-TK179)
- `TK101`: Using multiple `tkinter.Tk` instances. Child windows must be created from `tkinter.Toplevel`.
- `TK103`: Suggest refactoring code that uses `.update()`, as it's usually pointless, [potentially harmful](https://wiki.tcl-lang.org/page/Update+considered+harmful), and considered a code smell.
- `TK113`: Callback handler should be a callable
- `TK121`: Using `time.sleep()` in tkinter code. Use `.after()` in some form instead.
- `TK122`: Using an infinite loop in callback handler. Propose to use recursive function with `.after()`.
- `TK???`: Suggest keeping reference of local `PhotoImage` instance to avoid GC.
- `TK151`: Don't use `w.setup()` directly. Use init args, or `w.configure()`.
- Extend `TK111` and `Tk112` to check in `w.after()` calls.
- Cross platform (TK181-TK199)
- `TK181`: Using `<MouseWheel>` binding. It doesn't work on Linux with Tk 8.6 (use button4-5 instead)
- `TK182`: Using `<Shift-Tab>` binding. It doesn't work on Linux (use `<ISO_Left_Tab>` instead)
- `TK183`: Using `<Menu>` binding. It doesn't work on Windows (use `<App>` instead)
- `TK184`: Binding to control or alt with constant values. It probably won't work on macOS.
- `TK191`: Not calling `wait_visibility` before `wm_attributes("-alpha")`.
- `TK192`: Using `w.state("zoomed")`. It throws an error on Linux (and on mac too?). Use `wm_attributes("-zoomed", True)`
- Best practices (TK201-TK299)
- `TK222`: Using `tk.N+tk.S+tk.E+tk.W` and combinations like that. Use `tk.NSEW`, or some other constant instead.
- `TK241`: Creating a widget without parent specified, and there is a container in the same scope.
- `TK252`: Using `tkinter.Menu` without `tearoff=False`
- `TK261`: Using subsequent `wm_attributes` calls. It can take value pairs.
- Code quality (TK301-TK399)
- `TK301`: Suggest using more clear binding sequences, like `<Button-1>` instead of `<1>` and `<Key-a>` instead of `<a>`.
- `TK302`: Suggest using more clear `tkinter.Text` indexes, like `end - 1 chars` instead of `end-1c`.
- `TK303`: Using a float as `tkinter.Text` index. It works because how Tkinter translates Python objects to Tcl, but it shouldn't.
- OO (TK401-TK499)
- `TK401`: Consider refactoring a huge app with OOP.
- `TK402`: Consider refactoring widget into separate class.
- Opinionated rules (TK501-TK599)
- `TK501`: Calling `mainloop()` on something other than the root window.
- `TK502`: Using things like `root.wm_title()`. Use `root.title()`. (But there should be exceptions, like `wm_attributes`, and instead warn on plain `attributes`)
- `TK503`: Using subscripting for widget cget and configure. Use `.cget()` and `.configure()` instead.
## Development
1. Clone the repo
2. Set up a virtual environment, activate, and install `flake8` and `pytest` in it
3. Run `pip install -e .` to install `flake8-tkinter` in editable format
4. Run `python3 -m pytest` to test your changes
Raw data
{
"_id": null,
"home_page": "https://github.com/rdbende/flake8-tkinter",
"name": "flake8-tkinter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "rdbende",
"author_email": "rdbende@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/56/f4/2b7f4f1b24e7fffcd1fb2bfc544c815b31d051a1e8390c0da72034e28e58/flake8_tkinter-0.6.0.tar.gz",
"platform": null,
"description": "# flake8-tkinter\n\nA [flake8](https://github.com/PyCQA/flake8) plugin that helps you write better Tkinter code\n\n_Project idea by [@insolor](https://github.com/insolor)_\n\n\n## Installation\n\n```\npip install flake8-tkinter\n```\n\n\n## List of warnings\n\nCommon mistakes\n- **`TK102`**: Using multiple mainloop calls is unnecessary. One call is perfectly enough. ([example](#tk102))\n- **`TK111`**: Calling `callback_handler()` instead of passing the reference for on-click or binding callback. ([example](#tk111))\n- **`TK112`**: Calling `callback_handler()` with arguments instead of passing the reference for on-click or binding callback. If you need to call `callback_handler` with arguments, use lambda or functools.partial. ([example](#tk112))\n- **`TK131`**: Assigning result of geometry manager call to a variable. ([example](#tk131))\n\nBest practices\n- **`TK141`**: Using bind without `add=True` will overwrite any existing bindings to this sequence on this widget. Either overwrite them explicitly with `add=False` or use `add=True` to keep existing bindings. ([example](#tk141))\n- **`TK142`**: Creating tag bindings in a loop can lead to memory leaks. Store the returned command names in a list to clean them up later. ([example](#tk142))\n- **`TK201`**: Using `from tkinter import *` is generally a bad practice and discouraged. Use `import tkinter as tk` or simply `import tkinter` instead. ([example](#tk201))\n- **`TK202`**: Using `from tkinter.ttk import *` is generally a bad practice and discouraged. Use `from tkinter import ttk` instead. ([example](#tk202))\n- **`TK211`**: Using `import tkinter.ttk as ttk` is pointless. Use `from tkinter import ttk` instead. ([example](#tk211))\n- **`TK221`**: Using tkinter.TRUE, tkinter.FALSE, etc. is pointless. Use an appropriate Python boolean instead. ([example](#tk221))\n- **`TK251`**: Using `tkinter.Message` widget. It's redundant since `tkinter.Label` provides the same functionality. ([example](#tk251))\n\nCode quality\n- **`TK304`**: Value for `add` in bind methods should be a boolean. ([example](#tk304))\n\nOpinionated warnings\n- **`TK504`**: Using a tkinter constant. Use a string literal instead (disabled by default). ([example](#tk504))\n\n## Examples\n\n### TK102\n```python\n# Bad\ndef foo():\n top = tk.Toplevel()\n ...\n top.mainloop()\n\nroot.mainloop()\n\n# Good\ndef foo():\n top = tk.Toplevel()\n ...\n \nroot.mainloop()\n```\n\n### TK111\n```python\n# Bad\ntk.Button(..., command=foo())\nbutton.config(command=bar())\nbutton.bind(\"<Button-3>\", baz())\n\n# Good\ntk.Button(..., command=foo)\nbutton.config(command=bar)\nbutton.bind(\"<Button-3>\", baz)\n```\n\n### TK112\n```python\n# Bad\ntk.Button(..., command=foo(arg, kwarg=...))\nbutton.config(command=bar(arg, kwarg=...))\nbutton.bind(\"<Button-3>\", baz(arg, kwarg=...))\n\n# Good\ntk.Button(..., command=lambda: foo(arg, kwarg=...))\nbutton.config(command=lambda: bar(arg, kwarg=...))\nbutton.bind(\"<Button-3>\", lambda e: baz(arg, kwarg=...))\n```\n\n### TK131\n```python\n# Bad\nbtn = tk.Button().grid()\n\n# Good\nbtn = tk.Button()\nbtn.grid()\n```\n\n### TK201\n```python\n# Bad\nfrom tkinter import *\n\n# Good\nimport tkinter\n# OR\nimport tkinter as tk\n```\n\n### TK202\n```python\n# Bad\nfrom tkinter.ttk import *\n\n# Good\nfrom tkinter import ttk\n```\n\n### TK211\n```python\n# Bad\nimport tkinter.ttk as ttk\n\n# Good\nfrom tkinter import ttk\n```\n\n### TK221\n```python\n# Bad\nw.pack(expand=tk.TRUE)\nw.pack(expand=tk.FALSE)\nw.pack(expand=tk.YES)\nw.pack(expand=tk.NO)\nw.pack(expand=tk.ON)\nw.pack(expand=tk.OFF)\n\n# Good\nw.pack(expand=True)\nw.pack(expand=False)\n```\n\n### TK141\n```python\n# Bad\nw.bind(\"<Button-1>\", foo)\n\n# Good\nw.bind(\"<Button-1>\", foo, add=True)\n# OR\nw.bind(\"<Button-1>\", foo, add=False)\n```\n\n### TK142\n```python\n# Bad\nfor index, foo in enumerate(foos):\n w.tag_bind(f\"bar_{index}\", \"<Button-1>\", baz)\n \n# Good\nfor index, foo in enumerate(foos):\n tcl_command = w.tag_bind(f\"bar_{index}\", \"<Button-1>\", baz)\n bindings.append(tcl_command) # Clean them up later with `.deletecommand()`\n```\n\n### TK251\n_Yes, there's some minor diffrence in text wrapping, but that can be easily fixed\n```python\n# Bad\nw = tkinter.Message()\n\n# Good\nw = tkinter.Label()\n```\n\n### TK304\n```python\n# Bad\nw.bind(\"<Button-1>\", foo, add=\"+\")\n\n# Good\nw.bind(\"<Button-1>\", foo, add=True)\n```\n\n### TK504\n```python\n# Bad\nw.pack(side=tkinter.BOTTOM, fill=tkinter.BOTH)\n\n# Good\nw.pack(side=\"bottom\", fill=\"both\")\n```\n\n## Planned warnings\n\n- Common mistakes (TK101-TK179)\n - `TK101`: Using multiple `tkinter.Tk` instances. Child windows must be created from `tkinter.Toplevel`.\n - `TK103`: Suggest refactoring code that uses `.update()`, as it's usually pointless, [potentially harmful](https://wiki.tcl-lang.org/page/Update+considered+harmful), and considered a code smell.\n - `TK113`: Callback handler should be a callable\n - `TK121`: Using `time.sleep()` in tkinter code. Use `.after()` in some form instead.\n - `TK122`: Using an infinite loop in callback handler. Propose to use recursive function with `.after()`.\n - `TK???`: Suggest keeping reference of local `PhotoImage` instance to avoid GC.\n - `TK151`: Don't use `w.setup()` directly. Use init args, or `w.configure()`.\n - Extend `TK111` and `Tk112` to check in `w.after()` calls.\n\n- Cross platform (TK181-TK199)\n - `TK181`: Using `<MouseWheel>` binding. It doesn't work on Linux with Tk 8.6 (use button4-5 instead)\n - `TK182`: Using `<Shift-Tab>` binding. It doesn't work on Linux (use `<ISO_Left_Tab>` instead)\n - `TK183`: Using `<Menu>` binding. It doesn't work on Windows (use `<App>` instead)\n - `TK184`: Binding to control or alt with constant values. It probably won't work on macOS.\n - `TK191`: Not calling `wait_visibility` before `wm_attributes(\"-alpha\")`.\n - `TK192`: Using `w.state(\"zoomed\")`. It throws an error on Linux (and on mac too?). Use `wm_attributes(\"-zoomed\", True)`\n\n- Best practices (TK201-TK299)\n - `TK222`: Using `tk.N+tk.S+tk.E+tk.W` and combinations like that. Use `tk.NSEW`, or some other constant instead.\n - `TK241`: Creating a widget without parent specified, and there is a container in the same scope.\n - `TK252`: Using `tkinter.Menu` without `tearoff=False`\n - `TK261`: Using subsequent `wm_attributes` calls. It can take value pairs.\n\n- Code quality (TK301-TK399)\n - `TK301`: Suggest using more clear binding sequences, like `<Button-1>` instead of `<1>` and `<Key-a>` instead of `<a>`.\n - `TK302`: Suggest using more clear `tkinter.Text` indexes, like `end - 1 chars` instead of `end-1c`.\n - `TK303`: Using a float as `tkinter.Text` index. It works because how Tkinter translates Python objects to Tcl, but it shouldn't.\n\n- OO (TK401-TK499)\n - `TK401`: Consider refactoring a huge app with OOP.\n - `TK402`: Consider refactoring widget into separate class.\n \n- Opinionated rules (TK501-TK599)\n - `TK501`: Calling `mainloop()` on something other than the root window.\n - `TK502`: Using things like `root.wm_title()`. Use `root.title()`. (But there should be exceptions, like `wm_attributes`, and instead warn on plain `attributes`)\n - `TK503`: Using subscripting for widget cget and configure. Use `.cget()` and `.configure()` instead.\n\n\n## Development\n1. Clone the repo\n2. Set up a virtual environment, activate, and install `flake8` and `pytest` in it\n3. Run `pip install -e .` to install `flake8-tkinter` in editable format\n4. Run `python3 -m pytest` to test your changes\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A flake8 plugin that helps you write better Tkinter code",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/rdbende/flake8-tkinter",
"Tracker": "https://github.com/rdbende/flake8-tkinter/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56f42b7f4f1b24e7fffcd1fb2bfc544c815b31d051a1e8390c0da72034e28e58",
"md5": "eb87dc319917e2e01021cb4646d4678f",
"sha256": "b9dd2c8ecf3bb003d19fea4d1f5dfc283b4b1dad983f63241eb1d1593b3089ee"
},
"downloads": -1,
"filename": "flake8_tkinter-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "eb87dc319917e2e01021cb4646d4678f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12113,
"upload_time": "2023-05-25T20:48:41",
"upload_time_iso_8601": "2023-05-25T20:48:41.632601Z",
"url": "https://files.pythonhosted.org/packages/56/f4/2b7f4f1b24e7fffcd1fb2bfc544c815b31d051a1e8390c0da72034e28e58/flake8_tkinter-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 20:48:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rdbende",
"github_project": "flake8-tkinter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-tkinter"
}
JSON
