Repository navigation
Expand file tree
/
Copy pathpyproject.toml
More file actions
343 lines (310 loc) · 14.1 KB
/
Copy pathpyproject.toml
File metadata and controls
343 lines (310 loc) · 14.1 KB
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
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
[build-system]
requires = ["uv_build"]
build-backend = "uv_build"
[project]
name = "apify_client"
version = "3.4.1"
description = "Apify API client for Python"
authors = [{ name = "Apify Technologies s.r.o.", email = "support@apify.com" }]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
requires-python = ">=3.11"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"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",
"Topic :: Software Development :: Libraries",
]
keywords = ["apify", "api", "client", "automation", "crawling", "scraping"]
dependencies = [
"colorama>=0.4.0",
"impit>=0.15.1",
"more_itertools>=10.0.0",
"pydantic[email]>=2.11.0",
# 4.6.0 is the first release whose runtime protocol checks look attributes up statically.
"typing-extensions>=4.6.0",
]
[project.optional-dependencies]
brotli = ["brotli>=1.0.9"]
httpx2 = ["httpx2>=2.0.0"]
[project.urls]
"Apify Homepage" = "https://apify.com"
"Homepage" = "https://docs.apify.com/api/client/python/"
"Changelog" = "https://docs.apify.com/api/client/python/docs/changelog"
"Discord" = "https://discord.com/invite/jyEM2PRvMU"
"Documentation" = "https://docs.apify.com/api/client/python/docs/overview/introduction"
"Issue Tracker" = "https://github.com/apify/apify-client-python/issues"
"Source Code" = "https://github.com/apify/apify-client-python"
[dependency-groups]
dev = [
# TODO: Remove this constraint once pydoc-markdown updates its dependencies.
# Package pydoc-markdown is unmaintained and pins old docspec-python with vulnerable black.
# See https://github.com/apify/apify-client-python/pull/582/ for more details.
# We explicitly constrain black>=24.3.0 to override the transitive dependency.
"black>=24.3.0",
"datamodel-code-generator[http,ruff]>=0.64.1,<1.0.0",
"griffe<3.0.0",
"poethepoet<1.0.0",
"pre-commit<5.0.0",
"pydoc-markdown<5.0.0",
"pytest-asyncio<2.0.0",
"pytest-cov<8.0.0",
"pytest-httpserver<2.0.0",
"pytest-timeout<3.0.0",
"pytest-xdist<4.0.0",
"pytest<10.0.0",
"ruff~=0.17.0",
"setuptools", # setuptools are used by pytest but not explicitly required
"types-colorama<0.5.0",
"ty~=0.0.0",
"werkzeug<4.0.0", # Werkzeug is used by pytest-httpserver
]
[tool.uv.build-backend]
# The module, pyproject.toml, README, and LICENSE are included in the sdist by default.
source-include = ["CHANGELOG.md", "CONTRIBUTING.md"]
[tool.ruff]
line-length = 120
include = [
"**/*.py",
# Ruff formats Python code blocks embedded in Markdown files.
"**/*.md",
"**/*.mdx",
]
exclude = [
"website/versioned_docs/**",
]
# MDX is Markdown; without this mapping Ruff would try to parse `.mdx` files as Python.
extension = { mdx = "markdown" }
[tool.ruff.lint]
select = ["ALL"]
ignore = [
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed in {filename}
"ASYNC109", # Async function definition with a `timeout` parameter
"BLE001", # Do not catch blind exception
"C901", # `{name}` is too complex
"COM812", # This rule may cause conflicts when used with the formatter
"CPY001", # Missing copyright notice at top of file
"D100", # Missing docstring in public module
"D104", # Missing docstring in public package
"D107", # Missing docstring in `__init__`
"D203", # One blank line required before class docstring
"D213", # Multi-line docstring summary should start at the second line
"D413", # Missing blank line after last section
"EM", # flake8-errmsg
"G004", # Logging statement uses f-string
"ISC001", # This rule may cause conflicts when used with the formatter
"FIX", # flake8-fixme
"PLR0911", # Too many return statements
"PLR0913", # Too many arguments in function definition
"PLR0915", # Too many statements
"PTH", # flake8-use-pathlib
"PYI034", # `__aenter__` methods in classes like `{name}` usually return `self` at runtime
"PYI036", # The second argument in `__aexit__` should be annotated with `object` or `BaseException | None`
"S102", # Use of `exec` detected
"S105", # Possible hardcoded password assigned to
"S106", # Possible hardcoded password assigned to argument: "{name}"
"S301", # `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue
"S303", # Use of insecure MD2, MD4, MD5, or SHA1 hash function
"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
"TD002", # Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...
"TRY003", # Avoid specifying long messages outside the exception class
]
[tool.ruff.format]
quote-style = "single"
indent-style = "space"
[tool.ruff.lint.per-file-ignores]
"**/__init__.py" = [
"F401", # Unused imports
]
"**/_models.py" = [
"TC001", # Pydantic needs the literal aliases importable at runtime to resolve forward references
]
"**/{scripts}/*" = [
"D", # Everything from the pydocstyle
"INP001", # File {filename} is part of an implicit namespace package, add an __init__.py
"PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
"T20", # flake8-print
]
"**/{tests}/*" = [
"D", # Everything from the pydocstyle
"INP001", # File {filename} is part of an implicit namespace package, add an __init__.py
"PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
"S101", # Use of assert detected
"SLF001", # Private member accessed: `{name}`
"T20", # flake8-print
"TRY301", # Abstract `raise` to an inner function
"TID252", # Prefer absolute imports over relative imports from parent modules
]
"**/{docs,website}/**" = [
"D", # Everything from the pydocstyle
"INP001", # File {filename} is part of an implicit namespace package, add an __init__.py
"F841", # Local variable {variable} is assigned to but never used
"N999", # Invalid module name
"T201", # print found
]
"**/docs/02_concepts/code/10_architecture_imports.py" = [
"F401", # Imported but unused
]
"src/apify_client/_{models,typeddicts}.py" = [
"D", # Everything from the pydocstyle
"E501", # Line too long
"ERA001", # Commented-out code
"TC003", # Move standard library import into a type-checking block
]
"src/apify_client/_literals.py" = [
"PYI051", # `Literal[...]` is redundant in a union with `str`; the open `Literal[...] | str` is deliberate — it keeps known members as hints while tolerating unknown API values (see scripts/postprocess_generated_models.py)
]
[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "single"
[tool.ruff.lint.flake8-builtins]
builtins-ignorelist = ["id"]
[tool.ruff.lint.isort]
known-local-folder = ["apify_client"]
[tool.ruff.lint.pylint]
max-branches = 18
[tool.pytest.ini_options]
addopts = "-r a --verbose --dist worksteal"
asyncio_default_fixture_loop_scope = "function"
asyncio_mode = "auto"
filterwarnings = [
# The tests stream request bodies throughout, and the warning has a unit test of its own.
"ignore:Streaming a request body is experimental:UserWarning",
]
pythonpath = ["."]
timeout = 1800
[tool.ty.environment]
python-version = "3.11"
[tool.ty.src]
include = ["src", "tests", "scripts", "docs", "website"]
exclude = ["website/versioned_docs"]
[tool.ty.rules]
unused-ignore-comment = "error"
[[tool.ty.overrides]]
include = ["docs/**/*.py", "website/**/*.py"]
[tool.ty.overrides.rules]
unresolved-import = "ignore"
[tool.coverage.report]
exclude_lines = ["pragma: no cover", "if TYPE_CHECKING:", "assert_never()"]
[tool.ipdb]
context = 7
# https://koxudaxi.github.io/datamodel-code-generator/
[tool.datamodel-codegen]
input_file_type = "openapi"
output = "src/apify_client/_models.py"
target_python_version = "3.11"
output_model_type = "pydantic_v2.BaseModel"
use_schema_description = true
use_field_description = true
use_union_operator = true
capitalise_enum_members = true
collapse_root_models = true
collapse_root_models_name_strategy = "child"
set_default_enum_member = true
use_annotated = true
wrap_string_literal = true
snake_case_field = true
use_subclass_enum = true
reuse_model = true
extra_fields = "allow"
allow_population_by_field_name = true
aliases = "datamodel_codegen_aliases.json"
formatters = ["ruff-check", "ruff-format"]
custom_file_header = "# generated by datamodel-codegen"
disable_timestamp = true
keep_model_order = true
# Which published OpenAPI specification the committed `_models.py`, `_typeddicts.py`, and `_literals.py` were
# generated from. A coarse marker, not a content identity: the specification is served latest-only, so the version
# can't fetch that document back, and apify-docs bumps `components/version.yaml` in a follow-up `[skip ci]` commit,
# so a deploy can publish new content under the old stamp.
#
# `poe generate-models` records whatever it downloaded, unconditionally; what keeps the value honest is the nightly
# workflow committing nothing unless the models changed. A local regeneration that only moves this line is that
# same case - drop it rather than committing it alone.
[tool.apify.openapi-spec]
version = "v2-2026-10-29T100357Z"
[tool.uv]
# Minimal defense against supply-chain atatcks.
exclude-newer = "24 hours"
[tool.uv.exclude-newer-package]
# Allow internal Apify packages to install immediately.
apify-client = false
apify-shared = false
apify_fingerprint_datapoints = false
crawlee = false
impit = false
# Run tasks with: uv run poe <task>
[tool.poe.tasks]
clean = { cmd = "rm -rf .coverage .pytest_cache .ruff_cache .ty_cache build dist htmlcov", help = "Remove build artifacts and clean caches" }
install-sync = { cmd = "uv sync --all-extras", help = "Sync dependencies with all extras" }
build = { cmd = "uv build", help = "Build the package" }
publish-to-pypi = { cmd = "uv publish --token ${APIFY_PYPI_TOKEN_CRAWLEE}", help = "Publish the package to PyPI" }
type-check = { cmd = "uv run ty check", help = "Run the type checker" }
unit-tests = { cmd = "uv run pytest --numprocesses=${TESTS_CONCURRENCY:-auto} tests/unit", help = "Run unit tests" }
unit-tests-cov = { cmd = "uv run pytest --numprocesses=${TESTS_CONCURRENCY:-auto} --cov=src/apify_client --cov-report=xml:coverage-unit.xml tests/unit", help = "Run unit tests with an XML coverage report" }
integration-tests = { cmd = "uv run pytest --numprocesses=${TESTS_CONCURRENCY:-auto} tests/integration", help = "Run integration tests" }
integration-tests-cov = { cmd = "uv run pytest --numprocesses=${TESTS_CONCURRENCY:-auto} --cov=src/apify_client --cov-report=xml:coverage-integration.xml tests/integration", help = "Run integration tests with an XML coverage report" }
check-docstrings = { cmd = "uv run python -m scripts.check_docstrings", help = "Check that async client docstrings match their sync counterparts" }
fix-docstrings = { cmd = "uv run python -m scripts.fix_docstrings", help = "Copy sync client docstrings to their async counterparts" }
check-code = { sequence = ["lint", "type-check", "check-docstrings", "unit-tests"], help = "Run lint, type check, docstring check, and unit tests" }
[tool.poe.tasks.install-dev]
shell = "uv sync --all-extras && uv run pre-commit install"
help = "Install development dependencies and pre-commit hooks"
[tool.poe.tasks.lint]
shell = "uv run ruff format --check && uv run ruff check"
help = "Run the linter and check formatting"
[tool.poe.tasks.format]
shell = "uv run ruff check --fix && uv run ruff format"
help = "Fix lint issues and format code"
[tool.poe.tasks.update-docs-theme]
shell = "pnpm update @apify/docs-theme"
cwd = "website"
help = "Update the documentation website theme"
[tool.poe.tasks.build-docs]
shell = "./build_api_reference.sh && pnpm install && uv run pnpm build"
cwd = "website"
help = "Build the documentation website"
[tool.poe.tasks.run-docs]
shell = "./build_api_reference.sh && pnpm install && uv run pnpm start"
cwd = "website"
help = "Run the documentation website locally"
# Both passes read one downloaded copy, so a specification redeployed mid-run can't leave the generated files
# describing two different inputs. The version is recorded last, once generation succeeded.
#
# The `--alias-generator to_camel` flag lives on the `_models.py` command (not in `[tool.datamodel-codegen]`)
# because datamodel-codegen only allows it for `pydantic_v2.BaseModel` output and would reject the TypedDict run.
[tool.poe.tasks.generate-models]
shell = """
uv run python -m scripts.openapi_spec fetch \
&& uv run datamodel-codegen --input tmp/openapi.json \
--alias-generator to_camel \
&& uv run datamodel-codegen --input tmp/openapi.json \
--output src/apify_client/_typeddicts.py \
--output-model-type typing.TypedDict \
--no-use-closed-typed-dict \
&& python scripts/postprocess_generated_models.py \
&& uv run python -m scripts.openapi_spec record-version
"""
help = "Regenerate models from the published OpenAPI specification"
# For a candidate specification that isn't published yet. The recorded version deliberately stays put - it names
# the published specification - so models generated this way must not be committed, hence the warning.
[tool.poe.tasks.generate-models-from-file]
shell = """
uv run datamodel-codegen --input $input_file \
--alias-generator to_camel \
&& uv run datamodel-codegen --input $input_file \
--output src/apify_client/_typeddicts.py \
--output-model-type typing.TypedDict \
--no-use-closed-typed-dict \
&& python scripts/postprocess_generated_models.py \
&& echo "Generated from $input_file - the version in [tool.apify.openapi-spec] still names the published specification, so do not commit these models."
"""
args = [{ name = "input-file", positional = true, required = true }]
help = "Generate models from a local OpenAPI specification file (don't commit the result)"