-
Notifications
You must be signed in to change notification settings - Fork 8
/
pyproject.toml
182 lines (168 loc) · 5.33 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
180
181
182
# License: MIT
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
[build-system]
requires = [
"setuptools == 75.6.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[lib] == 0.11.0",
]
build-backend = "setuptools.build_meta"
[project]
name = "frequenz-channels"
description = "Channel implementations for Python"
readme = "README.md"
license = { text = "MIT" }
keywords = ["frequenz", "python", "lib", "library", "channels", "channel"]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Software Development :: Libraries",
"Typing :: Typed",
]
requires-python = ">= 3.11, < 4"
dependencies = [
"typing-extensions >= 4.5.0, < 5",
"watchfiles >= 0.15.0, < 1.1.0",
]
dynamic = ["version"]
[[project.authors]]
name = "Frequenz Energy-as-a-Service GmbH"
email = "floss@frequenz.com"
[project.optional-dependencies]
dev-flake8 = [
"flake8 == 7.1.1",
"flake8-docstrings == 1.7.0",
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
"pydoclint == 0.5.9",
"pydocstyle == 6.3.0",
]
dev-formatting = ["black == 24.10.0", "isort == 5.13.2"]
dev-mkdocs = [
"Markdown == 3.7",
"black == 24.10.0",
"frequenz-repo-config[lib] == 0.11.0",
"markdown-callouts == 0.4.0",
"markdown-svgbob == 202406.1023",
"mike == 2.1.3",
"mkdocs-gen-files == 0.5.0",
"mkdocs-include-markdown-plugin == 7.1.2",
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.47",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"pymdownx-superfence-filter-lines == 0.1.0",
]
dev-mypy = [
# For checking the noxfile, docs/ script, and tests
"frequenz-channels[dev-mkdocs,dev-noxfile,dev-pytest]",
"mypy == 1.13.0",
"types-Markdown == 3.7.0.20241204",
]
dev-noxfile = ["nox == 2024.10.9", "frequenz-repo-config[lib] == 0.11.0"]
dev-pylint = [
# For checking the noxfile, docs/ script, and tests
"frequenz-channels[dev-mkdocs,dev-noxfile,dev-pytest]",
"pylint == 3.3.2",
]
dev-pytest = [
"async-solipsism == 0.7",
"frequenz-repo-config[extra-lint-examples] == 0.11.0",
"hypothesis == 6.122.1",
"pytest == 8.3.4",
"pytest-asyncio == 0.24.0",
"pytest-mock == 3.14.0",
]
dev = [
"frequenz-channels[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
]
[project.urls]
Documentation = "https://frequenz-floss.github.io/frequenz-channels-python/"
Changelog = "https://github.com/frequenz-floss/frequenz-channels-python/releases"
Issues = "https://github.com/frequenz-floss/frequenz-channels-python/issues"
Repository = "https://github.com/frequenz-floss/frequenz-channels-python"
Support = "https://github.com/frequenz-floss/frequenz-channels-python/discussions/categories/support"
[tool.black]
line-length = 88
target-version = ['py311']
include = '\.pyi?$'
[tool.isort]
profile = "black"
line_length = 88
src_paths = ["benchmarks", "examples", "src", "tests"]
[tool.flake8]
# We give some flexibility to go over 88, there are cases like long URLs or
# code in documenation that have extra indentation. Black will still take care
# of making everything that can be 88 wide, 88 wide.
max-line-length = 100
extend-ignore = [
"E203", # Whitespace before ':' (conflicts with black)
"W503", # Line break before binary operator (conflicts with black)
]
# pydoclint options
style = "google"
check-return-types = false
check-yield-types = false
arg-type-hints-in-docstring = false
arg-type-hints-in-signature = true
allow-init-docstring = true
[tool.pylint.similarities]
ignore-comments = ['yes']
ignore-docstrings = ['yes']
ignore-imports = ['no']
min-similarity-lines = 40
[tool.pylint.messages_control]
disable = [
"too-few-public-methods",
# disabled because it conflicts with isort
"wrong-import-order",
"ungrouped-imports",
# pylint's unsubscriptable check is buggy and is not needed because
# it is a type-check, for which we already have mypy.
"unsubscriptable-object",
# Checked by mypy
"no-member",
"possibly-used-before-assignment",
"no-name-in-module",
# Checked by flake8
"f-string-without-interpolation",
"redefined-outer-name",
"unused-import",
"line-too-long",
"missing-function-docstring",
"unused-variable",
"unnecessary-lambda-assignment",
]
[tool.pytest.ini_options]
testpaths = ["tests", "src"]
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
required_plugins = ["pytest-asyncio", "pytest-mock"]
markers = [
"integration: integration tests (deselect with '-m \"not integration\"')",
]
[tool.mypy]
explicit_package_bases = true
namespace_packages = true
# This option disables mypy cache, and it is sometimes useful to enable it if
# you are getting weird intermittent error, or error in the CI but not locally
# (or vice versa). In particular errors saying that type: ignore is not
# used but getting the original ignored error when removing the type: ignore.
# See for example: https://github.com/python/mypy/issues/2960
#no_incremental = true
packages = ["frequenz.channels"]
strict = true
[[tool.mypy.overrides]]
module = [
"async_solipsism",
"async_solipsism.*",
"mkdocs_macros.*",
"sybil",
"sybil.*",
]
ignore_missing_imports = true
[tool.setuptools_scm]
version_scheme = "post-release"