GeezerVison is showing github.com — python-telegram-bot/pyproject.toml at dataclasses · python-telegram-bot/python-telegram-bot

Expand file tree

pyproject.toml

Copy path

More file actions

Latest commit

History

305 lines (282 loc) · 10 KB

pyproject.toml

Copy path

File metadata and controls

305 lines (282 loc) · 10 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

# PACKAGING

[build-system]

requires = ["hatchling"]

build-backend = "hatchling.build"

[project]

dynamic = ["version"]

name = "python-telegram-bot"

description = "We have made you a wrapper you can't refuse"

readme = "README.rst"

requires-python = ">=3.11"

license = "LGPL-3.0-only"

license-files = ["LICENSE", "LICENSE.dual", "LICENSE.lesser"]

authors = [

{ name = "Leandro Toledo", email = "[email protected]" }

]

keywords = [

"python",

"telegram",

"bot",

"api",

"wrapper",

]

classifiers = [

"Development Status :: 5 - Production/Stable",

"Intended Audience :: Developers",

"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",

"Operating System :: OS Independent",

"Topic :: Software Development :: Libraries :: Python Modules",

"Topic :: Communications :: Chat",

"Topic :: Internet",

"Programming Language :: Python",

"Programming Language :: Python :: 3",

"Programming Language :: Python :: 3.11",

"Programming Language :: Python :: 3.12",

"Programming Language :: Python :: 3.13",

"Programming Language :: Python :: 3.14",

"Programming Language :: Python :: 3.15",

]

dependencies = [

"httpx >=0.27,<0.29",

"httpcore >=1.0.9; python_version >= '3.14'", # httpx doesn't pin this as of 0.28.1

"typing-extensions~=4.16",

]

[project.urls]

"Homepage" = "https://python-telegram-bot.org"

"Documentation" = "https://docs.python-telegram-bot.org"

"Bug Tracker" = "https://github.com/python-telegram-bot/python-telegram-bot/issues"

"Source Code" = "https://github.com/python-telegram-bot/python-telegram-bot"

"News" = "https://t.me/pythontelegrambotchannel"

"Changelog" = "https://docs.python-telegram-bot.org/en/stable/changelog.html"

"Support" = "https://t.me/pythontelegrambotgroup"

[project.optional-dependencies]

# Make sure to install those as additional_dependencies in the pre-commit hooks

# When dependencies release new versions and tests succeed, we should try to expand the allowed

# versions and only increase the lower bound if necessary

# When adding new extras, make sure to update `ext` and `all` accordingly

# Optional dependencies for production

all = [

"python-telegram-bot[ext,http2,passport,socks]",

]

callback-data = [

# Cachetools doesn't have a strict stability policy. Let's be cautious for now.

"cachetools>=7.0.0,<8.0.0",

]

ext = [

"python-telegram-bot[callback-data,job-queue,rate-limiter,webhooks]",

]

http2 = [

"httpx[http2]",

]

job-queue = [

# APS doesn't have a strict stability policy. Let's be cautious for now.

"APScheduler>=3.10.4,<3.12.0",

]

passport = [

"cryptography!=3.4,!=3.4.1,!=3.4.2,!=3.4.3,>=39.0.1",

# cffi is a dependency of cryptography and added support for python 3.13 in 1.17.0rc1

"cffi >= 1.17.0rc1; python_version > '3.12'"

]

rate-limiter = [

"aiolimiter>=1.3,<1.4",

]

socks = [

"httpx[socks]",

]

webhooks = [

# tornado is rather stable, but let's not allow the next major release without prior testing

"tornado~=6.5",

]

[dependency-groups]

tests = [

# required for building the wheels for releases

"build",

# For the test suite

"pytest==9.1.1",

# needed because pytest doesn't come with native support for coroutines as tests

"pytest-asyncio==1.4.0",

# xdist runs tests in parallel

"pytest-xdist==3.8.0",

# no_req tests must be fully offline, including during higher-scoped fixture setup

"pytest-socket==0.8.1",

# Used for flaky tests (flaky decorator)

"flaky>=3.8.1",

# used in test_official for parsing tg docs

"beautifulsoup4",

# For testing with timezones. Might not be needed on all systems, but to ensure that unit tests

# run correctly on all systems, we include it here.

"tzdata",

# We've deprecated support pytz, but we still need it for testing that it works with the library.

"pytz",

# Install coverage:

"pytest-cov"

]

docs = [

"chango~=0.6.0; python_version >= '3.12'",

"sphinx==9.2.0; python_version >= '3.12'",

"furo==2025.12.19",

"sphinx-paramlinks==0.6.0",

"sphinxcontrib-mermaid==2.1.1",

"sphinx-copybutton==0.5.2",

"sphinx-inline-tabs==2025.12.21.14",

# Temporary. See #4387

"sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility.git@58aabc5f207c6c2421f23d3578adc0b14af57047",

# For python 3.14 support, we need a version of pydantic-core >= 2.35.0, since it upgrades the

# rust toolchain, required for building the project.

# This should ideally be done in `chango`'s dependencies. We can remove this once a new

# stable pydantic version is released.

"pydantic >= 2.12.0a1 ; python_version >= '3.14'"

]

linting = [

"prek",

"ruff==0.16.8",

"mypy==1.20.2",

"pylint==4.1.3"

]

all = [{ include-group = "tests" }, { include-group = "docs" }, { include-group = "linting"}]

# HATCH

[tool.hatch.version]

# dynamically evaluates the `__version__` variable in that file

source = "code"

path = "src/telegram/_version.py"

# See also https://github.com/pypa/hatch/issues/1230 for discussion

# the source distribution will include most of the files in the root directory

[tool.hatch.build.targets.sdist]

exclude = [".venv*", "venv*", ".github", "uv.lock"]

# the wheel will only include the src/telegram package

[tool.hatch.build.targets.wheel]

packages = ["src/telegram"]

# uv

[tool.uv]

exclude-newer = "7 days"

# CHANGO

[tool.chango]

sys_path = "changes"

chango_instance = { name= "chango_instance", module = "config" }

# RUFF:

[tool.ruff]

line-length = 99

show-fixes = true

[tool.ruff.lint]

typing-extensions = false

ignore = ["PLR2004", "PLR0911", "PLR0912", "PLR0913", "PLR0915", "PERF203", "ASYNC240", "PLR0917"]

select = ["E", "F", "I", "PL", "UP", "RUF", "PTH", "C4", "B", "PIE", "SIM", "RET", "RSE",

"G", "ISC", "PT", "ASYNC", "TCH", "SLOT", "PERF", "PYI", "FLY", "AIR", "RUF022",

"RUF023", "Q", "INP", "W", "YTT", "DTZ", "ARG", "T20", "FURB", "DOC", "TRY",

"D100", "D101", "D102", "D103", "D300", "D418", "D419", "S"]

# Add "A (flake8-builtins)" after we drop pylint

[tool.ruff.lint.per-file-ignores]

"tests/*.py" = ["B018"]

"tests/**.py" = ["RUF012", "ASYNC230", "DTZ", "ARG", "T201", "ASYNC109", "D", "S", "TRY"]

"src/telegram/**.py" = ["TRY003"]

# These timeouts are Telegram long-polling parameters, not limits on coroutine execution.

"src/telegram/_bot.py" = ["ASYNC109"]

"src/telegram/ext/_extbot.py" = ["ASYNC109"]

"src/telegram/ext/_updater.py" = ["ASYNC109"]

"src/telegram/ext/_applicationbuilder.py" = ["TRY004"]

"src/telegram/ext/filters.py" = ["D102"]

"docs/**.py" = ["INP001", "ARG", "D", "TRY003", "S"]

"examples/**.py" = ["ARG", "D", "S105", "TRY003"]

[tool.ruff.lint.pydocstyle]

convention = "google"

# PYLINT:

[tool.pylint."messages control"]

enable = ["useless-suppression"]

disable = ["duplicate-code", "too-many-arguments", "too-many-public-methods",

"too-few-public-methods", "broad-exception-caught", "too-many-instance-attributes",

"fixme", "missing-function-docstring", "missing-class-docstring", "too-many-locals",

"too-many-lines", "too-many-branches", "too-many-statements", "cyclic-import",

"too-many-positional-arguments",

# These rules dont play well with custom dataclass decorators, e.g

# tg_dataclass (and mypy will catch their violations)

# https://github.com/pylint-dev/pylint/issues/7437, https://github.com/pylint-dev/pylint/issues/4899

"no-member", "not-an-iterable", "unsubscriptable-object",

]

[tool.pylint.main]

# run pylint across multiple cpu cores to speed it up-

# https://pylint.pycqa.org/en/latest/user_guide/run.html?#parallel-execution to know more

jobs = 0

py-version = "3.11"

[tool.pylint.classes]

exclude-protected = ["_set"]

# PYTEST:

[tool.pytest.ini_options]

testpaths = ["tests"]

pythonpath = ["src"]

addopts = "--no-flaky-report -rX --allow-unix-socket"

filterwarnings = [

"error",

"ignore::DeprecationWarning",

'ignore:Tasks created via `Application\.create_task` while the application is not running',

"ignore::ResourceWarning",

# TODO: Write so good code that we don't need to ignore ResourceWarnings anymore

# Unfortunately due to https://github.com/pytest-dev/pytest/issues/8343 we can't have this here

# and instead do a trick directly in tests/conftest.py

# ignore::telegram.utils.deprecate.TelegramDeprecationWarning

]

markers = [

"dev", # If you want to test a specific test, use this

"no_req",

"req",

]

asyncio_mode = "auto"

asyncio_default_fixture_loop_scope = "session"

asyncio_default_test_loop_scope = "session"

log_cli_format = "%(funcName)s - Line %(lineno)d - %(message)s"

# log_cli_level = "DEBUG" # uncomment to see DEBUG logs

# MYPY:

[tool.mypy]

mypy_path = "src"

warn_unused_ignores = true

warn_unused_configs = true

disallow_untyped_defs = true

disallow_incomplete_defs = true

disallow_untyped_decorators = true

show_error_codes = true

python_version = "3.11"

# For some files, it's easier to just disable strict-optional all together instead of

# cluttering the code with `# type: ignore`s or stuff like

# `if self.text is None: raise RuntimeError()`

[[tool.mypy.overrides]]

module = [

"telegram._callbackquery",

"telegram._file",

"telegram._message",

"telegram._files.file"

]

strict_optional = false

# type hinting for asyncio in webhookhandler is a bit tricky because it depends on the OS

[[tool.mypy.overrides]]

module = "telegram.ext._utils.webhookhandler"

warn_unused_ignores = false

# The libs listed below are only used for the `customwebhookbot_*.py` examples

# let's just ignore type checking for them for now

[[tool.mypy.overrides]]

module = [

"flask.*",

"quart.*",

"starlette.*",

"uvicorn.*",

"asgiref.*",

"django.*",

"apscheduler.*", # not part of `customwebhookbot_*.py` examples

]

ignore_missing_imports = true

# COVERAGE:

[tool.coverage.run]

branch = true

source = ["src/telegram"]

parallel = true

concurrency = ["thread", "multiprocessing"]

omit = [

"tests/",

"src/telegram/__main__.py"

]

[tool.coverage.report]

exclude_also = [

"@overload",

"@abstractmethod",

"if TYPE_CHECKING:"

]