Announcing typed-linter

Slide 1

Slide 1 text

Никита Соболев github.com/sobolevn 1

Slide 2

Slide 2 text

>_ X Новые и старые проблемы статического анализа в Python 2

Slide 3

Slide 3 text

Мы живем в уникальное время 3

Slide 4

Slide 4 text

Проблемы накопились! 4

Slide 5

Slide 5 text

Важно! Пользоваться текущими инструментами все равно полезно 5

Slide 6

Slide 6 text

>_ X Карта текущих решений 6

Slide 7

Slide 7 text

Flake8 Плагины 7

Slide 8

Slide 8 text

Flake8 Плагины pylint Плагины 8

Slide 9

Slide 9 text

Flake8 Плагины pylint Плагины mypy Плагины 9

Slide 10

Slide 10 text

Flake8 Плагины pylint Плагины mypy Плагины pylance 10

Slide 11

Slide 11 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype 11

Slide 12

Slide 12 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check 12

Slide 13

Slide 13 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black 13

Slide 14

Slide 14 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 14

Slide 15

Slide 15 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit 15

Slide 16

Slide 16 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit yapf 16

Slide 17

Slide 17 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit yapf pyupgrade 17

Slide 18

Slide 18 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit yapf pyupgrade Линтеры 18

Slide 19

Slide 19 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit yapf pyupgrade Тайпчекеры Линтеры 19

Slide 20

Slide 20 text

Flake8 Плагины pylint Плагины mypy Плагины pylance pytype pyre-check black autopep8 fixit yapf pyupgrade Тайпчекеры Линтеры Авто-форматеры 20

Slide 21

Slide 21 text

>_ X Что лежит в основе? 21

Slide 22

Slide 22 text

ast = abstract syntax tree 22

Slide 23

Slide 23 text

print(name_with_meaning, second_name_with_meaning, third) 23

Slide 24

Slide 24 text

<_ast.Module> ┗━ body ┣━ [0] <_ast.Expr> ┃ ┗━ value: <_ast.Call> ┃ ┣━ args ┃ ┃ ┣━ [0] <_ast.Name> ┃ ┃ ┃ ┗━ id: first_long_name_with_meaning ┃ ┃ ┣━ [1] <_ast.Name> ┃ ┃ ┃ ┗━ id: second_very_long_name_with_meaning ┃ ┃ ┗━ [2] <_ast.Name> ┃ ┃ ┗━ id: third ┃ ┗━ func: <_ast.Name> ┃ ┗━ id: print 24

Slide 25

Slide 25 text

Используется > Почти во всех линтерах для анализа кода 25

Slide 26

Slide 26 text

Проблемы 26

Slide 27

Slide 27 text

Проблемы > Неконсистентность между версиями Python 26

Slide 28

Slide 28 text

Проблемы > Неконсистентность между версиями Python > Нет информации о типах 26

Slide 29

Slide 29 text

Проблемы > Неконсистентность между версиями Python > Нет информации о типах > Нет нюансов синтаксиса 26

Slide 30

Slide 30 text

Проблемы > Неконсистентность между версиями Python > Нет информации о типах > Нет нюансов синтаксиса > Нет комментариев 26

Slide 31

Slide 31 text

tokenize 27

Slide 32

Slide 32 text

28 print("test", a, b)

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Используется 30

Slide 35

Slide 35 text

Используется > Для проверки нюансов синтаксиса 30

Slide 36

Slide 36 text

Используется > Для проверки нюансов синтаксиса > Для авто-форматирования в некоторых инструментах 30

Slide 37

Slide 37 text

Проблемы 31

Slide 38

Slide 38 text

Проблемы > Представляет собой не "структуру", а простой список 31

Slide 39

Slide 39 text

Проблемы > Представляет собой не "структуру", а простой список > Вообще ничего не знает / не умеет 31

Slide 40

Slide 40 text

Проблемы > Представляет собой не "структуру", а простой список > Вообще ничего не знает / не умеет > Очень сложен в работе для правил с хоть какой-то логикой 31

Slide 41

Slide 41 text

libcst = Concrete Syntax Tree 32

Slide 42

Slide 42 text

Используется 33

Slide 43

Slide 43 text

Используется > В инфраструктуре Инстаграма 33

Slide 44

Slide 44 text

Используется > В инфраструктуре Инстаграма > Во многих новых библиотеках для авто-форматирования 33

Slide 45

Slide 45 text

Используется > В инфраструктуре Инстаграма > Во многих новых библиотеках для авто-форматирования > Для проверки нюансов синтаксиса 33

Slide 46

Slide 46 text

Используется > В инфраструктуре Инстаграма > Во многих новых библиотеках для авто-форматирования > Для проверки нюансов синтаксиса > Для анализа кода 33

Slide 47

Slide 47 text

Проблемы 34

Slide 48

Slide 48 text

Проблемы > Сбоит на некоторых синтаксических конструкциях Python3.9 https:// github.com/Instagram/LibCST/ issues/490 34

Slide 49

Slide 49 text

Проблемы > Сбоит на некоторых синтаксических конструкциях Python3.9 https:// github.com/Instagram/LibCST/ issues/490 > Не работает с Python3.10+ https:// github.com/Instagram/LibCST/ issues/285 34

Slide 50

Slide 50 text

typed-tree* *(такого нет) 35

Slide 51

Slide 51 text

Используется 36

Slide 52

Slide 52 text

Используется > В любом тайпчекере для представления нашего кода с типами 36

Slide 53

Slide 53 text

Используется > В любом тайпчекере для представления нашего кода с типами > Для каждого тайпчекера - оно свое 36

Slide 54

Slide 54 text

Проблемы 37

Slide 55

Slide 55 text

Проблемы > У каждой реализации они свои! 37

Slide 56

Slide 56 text

Проблемы > У каждой реализации они свои! > Нет единого стандарта 37

Slide 57

Slide 57 text

Проблемы > У каждой реализации они свои! > Нет единого стандарта > В каждом тайпчекере поддерживается далеко не все возможности 37

Slide 58

Slide 58 text

Проблемы > У каждой реализации они свои! > Нет единого стандарта > В каждом тайпчекере поддерживается далеко не все возможности > Нигде (кроме mypy) нет возможности подключать плагины 37

Slide 59

Slide 59 text

>_ X Пару слов про устаревшие инструменты 38

Slide 60

Slide 60 text

Flake8 39

Slide 61

Slide 61 text

Flake8 > Примитивная конфигурация 39

Slide 62

Slide 62 text

Flake8 > Примитивная конфигурация > Нет типов 39

Slide 63

Slide 63 text

Flake8 > Примитивная конфигурация > Нет типов > Невозможно нормально внедрить 39

Slide 64

Slide 64 text

Pylint 40

Slide 65

Slide 65 text

Pylint > Примитивная конфигурация 40

Slide 66

Slide 66 text

Pylint > Примитивная конфигурация > Нет типов 40

Slide 67

Slide 67 text

Pylint > Примитивная конфигурация > Нет типов > Но лучше бы их совсем не было 40

Slide 68

Slide 68 text

Pylint > Примитивная конфигурация > Нет типов > Но лучше бы их совсем не было > Невозможно нормально внедрить 40

Slide 69

Slide 69 text

Black 41

Slide 70

Slide 70 text

Black > Супер примитивный 41

Slide 71

Slide 71 text

Black > Супер примитивный > Использует lib2to3 41

Slide 72

Slide 72 text

>_ X Новые проблемы 42

Slide 73

Slide 73 text

Новый парсер / новая грамматика 43

Slide 74

Slide 74 text

Slide 75

Slide 75 text

Аннотации github.com/samuelcolvin/pydantic/issues/2678 45

Slide 76

Slide 76 text

PEP 563 mail.python.org/archives/list/[email protected]/thread/ CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ 46

Slide 77

Slide 77 text

Pattern Matching 47

Slide 78

Slide 78 text

>_ X Так что делать? 48

Slide 79

Slide 79 text

typed-linter 49

Slide 80

Slide 80 text

typed-linter > Нормальная конфигурация в духе eslint 49

Slide 81

Slide 81 text

typed-linter > Нормальная конфигурация в духе eslint > Провайдеры типов 49

Slide 82

Slide 82 text

typed-linter > Нормальная конфигурация в духе eslint > Провайдеры типов > Гибкая система плагинов 49

Slide 83

Slide 83 text

typed-linter > Нормальная конфигурация в духе eslint > Провайдеры типов > Гибкая система плагинов > Авто-форматирование 49

Slide 84

Slide 84 text

typed-linter > Нормальная конфигурация в духе eslint > Провайдеры типов > Гибкая система плагинов > Авто-форматирование > Нормальное внедрение 49

Slide 85

Slide 85 text

Конфигурация 50

Slide 86

Slide 86 text

Как сейчас? 51

Slide 87

Slide 87 text

[flake8] format = wemake show-source = True statistics = False doctests = True # darglint configuration: # https://github.com/terrencepreilly/darglint strictness = long docstring-style = numpy # Plugins: max-complexity = 6 max-line-length = 80 # wemake-python-styleguide settings: i-control-code = False 52

Slide 88

Slide 88 text

[tool.nitpick] style = "https://raw.githubusercontent.com/wemake-services/ wemake-python-styleguide/master/styles/nitpick-style- wemake.toml" [tool.poetry.dev-dependencies] nitpick = "^0.23" 53

Slide 89

Slide 89 text

Slide 90

Slide 90 text

Как надо? 55

Slide 91

Slide 91 text

extends: - typed-linter/recommended - 'url:https://path-to-my-config/file.yml' - 'file:local/path/file.yml' checks: - name: typed-linter/new-style-generics level: error extras: allow-old-style: [typing.List] settings: type-engine: name: typed-linter/mypy reporter: name: typed-linter/rich 56

Slide 92

Slide 92 text

Slide 93

Slide 93 text

Slide 94

Slide 94 text

Игнорирование ошибок 59

Slide 95

Slide 95 text

checks: - name: typed-linter/eqeq-is-mixup level: none overrides: - glob: some/**/*.py checks: - name: typed-linter/new-style-generics level: none type-overrides: - astpath: | \\ClassDef[type=django.url.URLConf]\method[name=locate] checks: - name: typed-linter/hidden-any level: none 60

Slide 96

Slide 96 text

Slide 97

Slide 97 text

Не все библиотеки одинаково полезны! github.com/wemake-services/wemake-python-styleguide/issues/1737 62

Slide 98

Slide 98 text

my_num = 5 my_num >> 2 # useless! 63

Slide 99

Slide 99 text

unload_task = _unload_to_file(export_config) if not export_config.is_incremental: _latest_only(export_config.athena_table_name) >> unload_task unload_task \ >> _upload_to_s3(export_config.athena_table_name) \ >> [ _clear_export_dir_and_logs(export_config.athena_table_name), *_repair_tables(export_config), ] 64

Slide 100

Slide 100 text

Slide 101

Slide 101 text

Система плагинов 66

Slide 102

Slide 102 text

API 67

Slide 103

Slide 103 text

class BasePlugin(object): def __init__(self, name: str, checks: CheckTypeSpec): ... @classmethod def load_checks( cls, configuration: Configuration, loader: ConventionalLoader, ) -> Sequence[CheckTypeSpec]: ... def run_project_checks( self, type_engine: BaseTypeEngine, project_modules: ProjectModules, configuration: Configuration, ) -> Iterable[BaseViolation]: ... def run_module_checks( self, type_checker: BaseTypeChecker, configuration: Configuration, module_spec: ModuleSpec, ) -> Iterable[BaseViolation]: ...

Slide 104

Slide 104 text

Система конвенций 69

Slide 105

Slide 105 text

Slide 106

Slide 106 text

Slide 107

Slide 107 text

extends: - typed-linter/recommended - flake8/recommended overrides: - glob: some/**/*.py checks: - name: flake8/F001 level: none settings: type-engine: name: your-project/pytype reporter: name: circle-ci/json 72

Slide 108

Slide 108 text

Поменять провайдер типов? 73

Slide 109

Slide 109 text

Slide 110

Slide 110 text

Slide 111

Slide 111 text

Включить flake8? 76

Slide 112

Slide 112 text

Slide 113

Slide 113 text

Внедрение 78

Slide 114

Slide 114 text

--baseline > FlakeHell: https:// flakehell.readthedocs.io/commands/ baseline.html > wemake-python-styleguide: https:// github.com/wemake-services/wemake- python-styleguide/pull/1276 79

Slide 115

Slide 115 text

Как оно будет? 80

Slide 116

Slide 116 text

Как оно будет? > typed-linter --baseline myproject 80

Slide 117

Slide 117 text

Как оно будет? > typed-linter --baseline myproject > Все ошибки запомнились 80

Slide 118

Slide 118 text

Как оно будет? > typed-linter --baseline myproject > Все ошибки запомнились > typed-linter --baseline myproject 80

Slide 119

Slide 119 text

Как оно будет? > typed-linter --baseline myproject > Все ошибки запомнились > typed-linter --baseline myproject > Старых ошибок нет 80

Slide 120

Slide 120 text

Как оно будет? > typed-linter --baseline myproject > Все ошибки запомнились > typed-linter --baseline myproject > Старых ошибок нет > Новые делать нельзяы 80

Slide 121

Slide 121 text

Проблемы 81

Slide 122

Slide 122 text

Проблемы > В текущей реализации очень сложно идентифицировать ошибку и привязать её к определенному месту 81

Slide 123

Slide 123 text

Проблемы > В текущей реализации очень сложно идентифицировать ошибку и привязать её к определенному месту > Раньше мы оперировали только: строками, позицией, кодом ошибки 81

Slide 124

Slide 124 text

Авто-форматирование 82

Slide 125

Slide 125 text

😭 😭 😭 83

Slide 126

Slide 126 text

Есть одно "но" github.com/wemake-services/typed-linter 84

Slide 127

Slide 127 text

Slide 128

Slide 128 text

>_ X 💰 86

Slide 129

Slide 129 text

Планы релиза > SponsorsWare > Dual License > Contributor-based 87

Slide 130

Slide 130 text

А пока 88

Slide 131

Slide 131 text

Самый строгий линтер в мире github.com/wemake-services/wemake-python-styleguide 89