src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Annotations/translations.py

Fri, 19 May 2023 18:08:45 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 19 May 2023 18:08:45 +0200
branch
eric7
changeset 10043
f1427d95cfde
parent 9653
e67609152c5e
child 10046
35b27af462ef
permissions
-rw-r--r--

Code Style Checker
- Updated the annotations checker to support more cases.

7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
9653
e67609152c5e Updated copyright for 2023.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9276
diff changeset
3 # Copyright (c) 2020 - 2023 Detlev Offenbach <detlev@die-offenbachs.de>
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 #
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 """
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 Module implementing message translations for the code style plugin messages
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 (code annotations part).
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 """
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
8318
962bce857696 Replaced all imports of PyQt5 to PyQt6 and started to replace code using obsoleted methods and adapt to the PyQt6 enum usage.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8312
diff changeset
12 from PyQt6.QtCore import QCoreApplication
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 _annotationsMessages = {
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 "A001": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
16 "AnnotationsChecker", "missing type annotation for function argument '{0}'"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
17 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 "A002": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
19 "AnnotationsChecker", "missing type annotation for '*{0}'"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
20 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 "A003": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
22 "AnnotationsChecker", "missing type annotation for '**{0}'"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
23 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 "A101": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
25 "AnnotationsChecker", "missing type annotation for 'self' in method"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
26 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 "A102": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
28 "AnnotationsChecker", "missing type annotation for 'cls' in classmethod"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
29 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 "A201": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
31 "AnnotationsChecker", "missing return type annotation for public function"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
32 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 "A202": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
34 "AnnotationsChecker", "missing return type annotation for protected function"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
35 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 "A203": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
37 "AnnotationsChecker", "missing return type annotation for private function"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
38 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 "A204": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
40 "AnnotationsChecker", "missing return type annotation for special method"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
41 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 "A205": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
43 "AnnotationsChecker", "missing return type annotation for staticmethod"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
44 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 "A206": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
46 "AnnotationsChecker", "missing return type annotation for classmethod"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
47 ),
8244
ed8cb108b27b Code Style Checker: reworked the type annotations checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8198
diff changeset
48 "A301": QCoreApplication.translate(
ed8cb108b27b Code Style Checker: reworked the type annotations checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8198
diff changeset
49 "AnnotationsChecker",
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
50 "PEP 484 disallows both type annotations and type comments",
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
51 ),
9276
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
52 "A401": QCoreApplication.translate(
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
53 "AnnotationsChecker",
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
54 "Dynamically typed expressions (typing.Any) are disallowed",
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
55 ),
8773
3dd81b827455 Extended the annotations checker to check for missing 'from __future__ import annotations'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8318
diff changeset
56 "A871": QCoreApplication.translate(
3dd81b827455 Extended the annotations checker to check for missing 'from __future__ import annotations'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8318
diff changeset
57 "AnnotationsChecker",
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
58 "missing 'from __future__ import annotations' but imports: {0}",
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
59 ),
9276
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
60 "A872": QCoreApplication.translate(
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
61 "AnnotationsChecker", "missing 'from __future__ import annotations'"
e6748a5e24b9 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9221
diff changeset
62 ),
10043
f1427d95cfde Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9653
diff changeset
63 "A873": QCoreApplication.translate(
f1427d95cfde Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9653
diff changeset
64 "AnnotationsChecker", "missing 'from __future__ import annotations' but uses"
f1427d95cfde Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9653
diff changeset
65 " simplified type annotations: {0}"
f1427d95cfde Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9653
diff changeset
66 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 "A881": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
68 "AnnotationsChecker", "type annotation coverage of {0}% is too low"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
69 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 "A891": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
71 "AnnotationsChecker", "type annotation is too complex ({0} > {1})"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
72 ),
8244
ed8cb108b27b Code Style Checker: reworked the type annotations checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8198
diff changeset
73 "A892": QCoreApplication.translate(
9221
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
74 "AnnotationsChecker", "type annotation is too long ({0} > {1})"
bf71ee032bb4 Reformatted the source code using the 'Black' utility.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
75 ),
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 }
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 _annotationsMessagesSampleArgs = {
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 "A001": ["arg1"],
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 "A002": ["args"],
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 "A003": ["kwargs"],
8773
3dd81b827455 Extended the annotations checker to check for missing 'from __future__ import annotations'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8318
diff changeset
82 "A871": ["Dict, List"],
10043
f1427d95cfde Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9653
diff changeset
83 "A873": ["dict, list"],
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 "A881": [60],
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 "A891": [5, 3],
8244
ed8cb108b27b Code Style Checker: reworked the type annotations checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8198
diff changeset
86 "A892": [10, 7],
7782
976d3b19ba7f Started refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 }

eric ide

mercurial