FilesExpand file tree

main

/

.ruff.toml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

152 lines (139 loc) · 5.32 KB

main

/

.ruff.toml

Copy path

Top

File metadata and controls

• Code
• Blame

152 lines (139 loc) · 5.32 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

#################################################################################

#

# Ruff linter and code formatter for A2A

#

# This file follows the standards in Google Python Style Guide

# https://google.github.io/styleguide/pyguide.html

#

line-length = 80 # Google Style Guide §3.2: 80 columns

indent-width = 4 # Google Style Guide §3.4: 4 spaces

target-version = "py310" # Minimum Python version

[lint]

ignore = [

"COM812", # Trailing comma missing.

"FBT001", # Boolean positional arg in function definition

"FBT002", # Boolean default value in function definition

"D203", # 1 blank line required before class docstring (Google: 0)

"D213", # Multi-line docstring summary should start at the second line (Google: first line)

"D100", # Ignore Missing docstring in public module (often desired at top level __init__.py)

"D104", # Ignore Missing docstring in public package (often desired at top level __init__.py)

"D107", # Ignore Missing docstring in __init__ (use class docstring)

"TD002", # Ignore Missing author in TODOs (often not required)

"TD003", # Ignore Missing issue link in TODOs (often not required/available)

"T201", # Ignore print presence

"RUF012", # Ignore Mutable class attributes should be annotated with `typing.ClassVar`

"E501", # Ignore line length (handled by Ruff's dynamic line length)

"ANN002",

"ANN003",

"ANN401",

]

select = [

"E", # pycodestyle errors (PEP 8)

"W", # pycodestyle warnings (PEP 8)

"F", # Pyflakes (logical errors, unused imports/variables)

"I", # isort (import sorting - Google Style §3.1.2)

"D", # pydocstyle (docstring conventions - Google Style §3.8)

"N", # pep8-naming (naming conventions - Google Style §3.16)

"UP", # pyupgrade (use modern Python syntax)

"ANN",# flake8-annotations (type hint usage/style - Google Style §2.22)

"A", # flake8-builtins (avoid shadowing builtins)

"B", # flake8-bugbear (potential logic errors & style issues - incl. mutable defaults B006, B008)

"C4", # flake8-comprehensions (unnecessary list/set/dict comprehensions)

"ISC",# flake8-implicit-str-concat (disallow implicit string concatenation across lines)

"T20",# flake8-print (discourage `print` - prefer logging)

"SIM",# flake8-simplify (simplify code, e.g., `if cond: return True else: return False`)

"PTH",# flake8-use-pathlib (use pathlib instead of os.path where possible)

"PL", # Pylint rules ported to Ruff (PLC, PLE, PLR, PLW)

"PIE",# flake8-pie (misc code improvements, e.g., no-unnecessary-pass)

"RUF",# Ruff-specific rules (e.g., RUF001-003 ambiguous unicode, RUF013 implicit optional)

"RET",# flake8-return (consistency in return statements)

"SLF",# flake8-self (check for private member access via `self`)

"TID",# flake8-tidy-imports (relative imports, banned imports - configure if needed)

"YTT",# flake8-boolean-trap (checks for boolean positional arguments, truthiness tests - Google Style §3.10)

"TD", # flake8-todos (check TODO format - Google Style §3.7)

"TCH",# flake8-type-checking (helps manage TYPE_CHECKING blocks and imports)

"PYI",# flake8-pyi (best practices for .pyi stub files, some rules are useful for .py too)

]

exclude = [

".bzr",

".direnv",

".eggs",

".git",

".hg",

".mypy_cache",

".nox",

".pants.d",

".pytype",

".ruff_cache",

".svn",

".tox",

".venv",

"__pypackages__",

"_build",

"buck-out",

"build",

"dist",

"node_modules",

"venv",

"*/migrations/*",

"noxfile.py",

"src/a2a/grpc/**",

"tests/**",

]

[lint.isort]

#force-sort-within-sections = true

#combine-as-imports = true

case-sensitive = true

#force-single-line = false

#known-first-party = []

#known-third-party = []

lines-after-imports = 2

lines-between-types = 1

#no-lines-before = ["LOCALFOLDER"]

#required-imports = []

#section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

[lint.pydocstyle]

convention = "google"

ignore-decorators = ["typing.overload", "abc.abstractmethod"]

[lint.flake8-annotations]

mypy-init-return = true

allow-star-arg-any = true

[lint.pep8-naming]

ignore-names = ["test_*", "setUp", "tearDown", "mock_*"]

classmethod-decorators = ["classmethod", "pydantic.validator", "pydantic.root_validator"]

staticmethod-decorators = ["staticmethod"]

[lint.flake8-tidy-imports]

ban-relative-imports = "all" # Google generally prefers absolute imports (§3.1.2)

[lint.flake8-quotes]

docstring-quotes = "double"

inline-quotes = "single"

[lint.per-file-ignores]

"__init__.py" = ["F401", "D", "ANN"] # Ignore unused imports in __init__.py

"*_test.py" = [

"D", # All pydocstyle rules

"ANN", # Missing type annotation for function argument

"RUF013", # Implicit optional type in test function signatures

"S101", # Use of `assert` detected (expected in tests)

"PLR2004",

"SLF001",

]

"test_*.py" = [

"D",

"ANN",

"RUF013",

"S101",

"PLR2004",

"SLF001",

]

"types.py" = ["D", "E501", "N815"] # Ignore docstring and annotation issues in types.py

"proto_utils.py" = ["D102", "PLR0911"]

"helpers.py" = ["ANN001", "ANN201", "ANN202"]

[format]

exclude = [

"types.py",

"src/a2a/grpc/**",

]

docstring-code-format = true

docstring-code-line-length = "dynamic" # Or set to 80

quote-style = "single"

indent-style = "space"