-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpyproject.toml
179 lines (168 loc) · 5.96 KB
/
pyproject.toml
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
[build-system]
requires = [
"cmake>=3.25",
"ninja>=1.11",
"numpy>=1.23",
"scikit-build>=0.16",
"setuptools>=65",
"wheel>=0.38",
]
build-backend = "setuptools.build_meta"
[project]
name = "atmcirclib"
version = "0.9.2"
description = "Python library of the Atmospheric Circulation Group"
readme = "README.md"
keywords = [
"atmospheric circulation",
]
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"Intended Audience :: Developers",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
]
requires-python = ">=3.9"
authors = [
{name="Stefan Ruedisuehli", email="stefan.ruedisuehli@env.ethz.ch"},
]
[project.urls]
source = "https://git.iac.ethz.ch/atmcirc/tools/atmcirclib"
documentation = "https://git.iac.ethz.ch/atmcirc/tools/atmcirclib"
[project.scripts]
# Format: <command> = "<package>.<module>:<function>"
# atmcirclib = "atmcirclib.cli:main"
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = [
"-s",
"-ra",
"--pdbcls=IPython.terminal.debugger:TerminalPdb",
"--tb=short",
# "--cov=atmcirclib",
# "--mypy",
]
[tool.black]
[tool.isort]
default_section = "THIRDPARTY"
force_grid_wrap = false
force_single_line = true
line_length = 88
order_by_type = false
# Headings
import_heading_stdlib = "Standard library"
import_heading_thirdparty = "Third-party"
import_heading_firstparty = "First-party"
import_heading_localfolder = "Local"
# Known modules to avoid misclassification
known_standard_library = [
# Add standard library modules that are misclassified by isort
]
known_third_party = [
# Add third-party modules that are misclassified by isort
]
known_first_party = [
# Add first-party modules that are misclassified by isort
"atmcirclib",
]
[tool.mypy]
# --strict options (v0.941)
check_untyped_defs = true
disallow_any_generics = true
disallow_incomplete_defs = true
disallow_subclassing_any = true
# disallow_untyped_calls = true
# disallow_untyped_decorators = true
disallow_untyped_defs = true
no_implicit_optional = true
no_implicit_reexport = true
strict_equality = true
warn_redundant_casts = true
warn_return_any = true
warn_unused_configs = true
warn_unused_ignores = true
[[tool.mypy.overrides]]
# Note: Only globally ignore missing imports as a matter of last resort!
# See https://blog.wolt.com/engineering/2021/09/30/professional-grade-mypy-configuration/
module = [
# Add external modules w/o type hints here
]
ignore_missing_imports = true
[tool.flake8]
max-line-length = 88
# max-complexity = 10
ignore = [
"E203", # Allow whitespace before ':' (https://github.com/PyCQA/pycodestyle/issues/373)
"F811", # Allow redefinition of unused name (necessary for typing.overload)
"I002", # Don't check for isort configuration
"W503", # Allow line break before binary operator (PEP 8-compatible)
]
per-file-ignores = [
"__init__.py: F401", # Allow unused imports
]
[tool.pylint]
recursive = true
ignore-imports = true
max-line-length = 88
# Tweak valid name formats
# Defaults (http://pylint-messages.wikidot.com/messages:c0103):
# argument-rgx = "^[a-z_][a-z0-9_]{2,30}$"
# attr-rgx = "^[a-z_][a-z0-9_]{2,30}$"
# function-rgx = "^[a-z_][a-z0-9_]{2,30}$"
# method-rgx = "^[a-z_][a-z0-9_]{2,30}$"
# variable-rgx = "^[a-z_][a-z0-9_]{2,30}$"
# class-rgx = "^[A-Z_][a-zA-Z0-9]+$"
# const-rgx = "^(([A-Z_][A-Z0-9_]*)|(__.*__))$"
# module-rgx = "^(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$"
argument-rgx = "^[a-z_][a-z0-9_]{,40}$"
attr-rgx = "^[a-z_][a-z0-9_]{,40}$"
function-rgx = "^[a-z_][a-z0-9_]{,40}$"
method-rgx = "^[a-z_][a-z0-9_]{,40}$"
variable-rgx = "^[a-z_][a-z0-9_]{,40}$"
class-rgx = "^[A-Z_][a-zA-Z0-9]+$"
const-rgx = "^(([a-z_][a-z0-9_]*)|([A-Z_][A-Z0-9_]*)|(__[a-zA-Z0-9]+__))$"
module-rgx = "^(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$"
inlinevar-rgx = "^[A-Za-z_][A-Za-z0-9_]*$"
# Disable selected warnings, errors etc. that conflict with style guide etc.
# Note: To locally ignore certain errors, use "pylint: disable=XXXX" comments instead!
disable = [
"C0115", # Missing class docstring
"C0116", # Missing function or method docstring
"R0903", # Too few public methods (*/2) (too-few-public-methods)
# "R0801", # Similar lines in 2 files (duplicate-code)
# -> see https://github.com/PyCQA/pylint/issues/214
"R1705", # Unnecessary "elif" after "return" (no-else-return)
"R1720", # Unnecessary "elif" after "raise" (no-else-raise)
"R1724", # Unnecessary "elif" after "continue" (no-else-continue)
"W1116", # Second argument of isinstance is not a type (isinstance-second-argument-not-valid-type)
# TODO Remove or reactivate if necessary (leftovers after blueprint merge)
# "C0103", # invalid-name
# "C0330", # Wrong hanging indentation before block (add 4 spaces)
# "R0903", # too-few-public-methods (<2)
# "W0511", # fixme: Flag TODO
# "W0602", # global-variable-not-assigned
]
# Ignore (sub-)modules that trigger errors like E1101 (no-member) or E0611 (no-name-in-module)
ignored-modules = [
# TODO Remove or reactivate if necessary (leftovers after blueprint merge)
# "cartopy", # E1101 (no-member) (PlateCarree)
# "netCDF4", # E1101 (no-member)
]
[tool.pydocstyle]
# All codes: http://www.pydocstyle.org/en/stable/error_codes.html
ignore = [
# "D100", # Missing docstring in public module
# "D101", # Missing docstring in public class
# "D102", # Missing docstring in public method
# "D103", # Missing docstring in public function
# "D104", # Missing docstring in public package
"D105", # Missing docstring in magic method
# "D105", # Missing docstring in public nested class
# "D107", # Missing docstring in __init__
"D203", # Blank line required before class docstring
"D213", # Multi-line docstring summary should start at the second line
# "D405", # Section name should be properly capitalized
# "D406", # Section name should end with a newline
"D407", # Missing dashed underline after section
]