You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 977c3ad
Browse filesBrowse the repository at this point in the historyBrowse files
Python: replace pre-commit with prek, add PEP 723 script deps, clean up dev dependencies (#3748)
* python: replace pre-commit with prek, add PEP 723 script deps, clean up dev dependencies
- Replace pre-commit with prek (Rust-native, faster pre-commit alternative)
- Move supported hooks to repo: builtin for zero-clone speed
- Add new builtin hooks: trailing-whitespace, check-merge-conflict, detect-private-key, check-added-large-files
- Update all hook versions to latest (pre-commit-hooks v6, pyupgrade v3.21.2, bandit 1.9.3, uv-pre-commit 0.10.0)
- Add PEP 723 inline script metadata to 34 samples with external deps
- Remove autogen-agentchat/autogen-ext from dev deps (now declared per-sample)
- Remove unused dev deps: pytest-env, tomli-w
- Add agent-framework-core>=1.0.0b260130 lower bound to all 21 packages
- Update CI workflow to use j178/prek-action
- Update docs: DEV_SETUP.md, AGENTS.md, CODING_STANDARD.md, SAMPLE_GUIDELINES.md
* updated lock
* python: fix prek config paths for local execution and CI workflow
Remove global 'files: ^python/' filter and strip python/ prefix from all path patterns in .pre-commit-config.yaml so prek finds files when run from the python/ directory. Update CI workflow to use --cd python instead of --config path. Include trailing whitespace fixes and dev dependency cleanup.
* python: move helper scripts to scripts/ folder and exclude from checks
* python: exclude AGENTS.md from prek markdown code lint
* python: exclude AGENTS.md and azure_ai_search sample from markdown lint
* fix m365 sample
* python: ignore CPY rule for samples with PEP 723 headers
* fix in dev_setup
* python: replace aiofiles with regular open in samples
* python: suppress reportUnusedImport in markdown code block checker
* python: use samples pyright config for markdown code block checker
Write a temp pyrightconfig.json matching pyrightconfig.samples.json rules (typeCheckingMode=off, only reportMissingImports and reportAttributeAccessIssue). Filter output to only fail on these rules since syntax-level errors (top-level await, undefined vars) are expected in README documentation snippets.
* python: use markdown-code-lint with fixed globs instead of prek file list
The prek-markdown-code-lint task received all changed files including non-README markdown and files with pre-existing broken imports. Replace with the standard markdown-code-lint task which uses the correct glob patterns (README.md, packages/**/README.md, samples/**/*.md).
* python: exclude READMEs with pre-existing broken imports from markdown lint
* python: fix broken README code snippets instead of excluding them
- ag-ui: replace TextContent (removed) with content.type == 'text'
- durabletask: fix import path to durabletask.worker.TaskHubGrpcWorker
- orchestrations: use constructor params instead of .participants() method
- observability: mark deprecated code blocks as plain text, filter
reportMissingImports to agent_framework modules only
- remove README excludes from markdown-code-lint task
* add revision to gaia download
* feat(python): parallelize checks across packages
Run (package × task) cross-product in parallel using ThreadPoolExecutor
and subprocesses. Key changes:
- Add scripts/task_runner.py with shared parallel execution engine
- Update run_tasks_in_packages_if_exists.py to accept multiple tasks
- Update run_tasks_in_changed_packages.py with --files flag and parallel support
- Add check-packages poe task (fmt+lint+pyright+mypy in parallel)
- Add prek-markdown-code-lint and prek-samples-check with change detection
- Split CI code quality workflow into parallel prek and mypy jobs
- Update DEV_SETUP.md to document new parallel behavior
Core package changes still trigger checks on all packages.
* feat(ci): split code quality into 4 parallel jobs
Split the single prek job into parallel jobs:
- pre-commit-hooks: lightweight hooks (SKIP=poe-check)
- package-checks: fmt/lint/pyright/mypy via check-packages
- samples-markdown: samples-lint, samples-syntax, markdown-code-lint
- mypy: change-detected mypy checks
All 4 jobs run concurrently (×2 Python versions = 8 runners).
* feat(ci): use only Python 3.10 for code quality checks
* refactor(python): add future annotations and remove quoted types
Add `from __future__ import annotations` to 93 package files that
used quoted string annotations, then run pyupgrade --py310-plus to
remove the now-unnecessary quotes.
Fixes#3578
When modifying samples, update associated README files in the same or parent folders.
74
-
75
-
### Samples Syntax Checking
76
-
77
-
Run `uv run poe samples-syntax` to check samples for syntax errors and missing imports from `agent_framework`. This uses a relaxed pyright configuration that validates imports without strict type checking.
78
-
79
-
Some samples depend on external packages (e.g., `azure.ai.agentserver.agentframework`, `microsoft_agents`) that are not installed in the dev environment. These are excluded in `pyrightconfig.samples.json`. When adding or modifying these excluded samples, add them to the exclude list and manually verify they have no import errors from `agent_framework` packages by temporarily removing them from the exclude list and running the check.
66
+
See [samples/SAMPLE_GUIDELINES.md](samples/SAMPLE_GUIDELINES.md) for sample structure, external dependency handling (PEP 723), and syntax checking instructions.
Copy file name to clipboardExpand all lines: python/CODING_STANDARD.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -264,6 +264,13 @@ After the package has been released and gained a measure of confidence:
264
264
2. Add the package to the `[all]` extra in `packages/core/pyproject.toml`
265
265
3. Create a provider folder in `agent_framework/` with lazy loading `__init__.py`
266
266
267
+
### Versioning and Core Dependency
268
+
269
+
All non-core packages declare a lower bound on `agent-framework-core` (e.g., `"agent-framework-core>=1.0.0b260130"`). Follow these rules when bumping versions:
270
+
271
+
-**Core version changes**: When `agent-framework-core` is updated with breaking or significant changes and its version is bumped, update the `agent-framework-core>=...` lower bound in every other package's `pyproject.toml` to match the new core version.
272
+
-**Non-core version changes**: Non-core packages (connectors, extensions) can have their own versions incremented independently while keeping the existing core lower bound pinned. Only raise the core lower bound if the non-core package actually depends on new core APIs.
273
+
267
274
### Installation Options
268
275
269
276
Connectors are distributed as separate packages and are not imported by default in the core package. Users install the specific connectors they need:
Alternatively, you can reinstall the venv, pacakges, dependencies and pre-commit hooks with a single command (but this requires poe in the current env), this is especially useful if you want to switch python versions:
71
+
Alternatively, you can reinstall the venv, pacakges, dependencies and prek hooks with a single command (but this requires poe in the current env), this is especially useful if you want to switch python versions:
72
72
73
73
```bash
74
74
uv run poe setup -p 3.13
@@ -144,7 +144,7 @@ To run the same checks that run during a commit and the GitHub Action `Python Co
144
144
uv run poe check
145
145
```
146
146
147
-
Ideally you should run these checks before committing any changes, when you install using the instructions above the pre-commit hooks should be installed already.
147
+
Ideally you should run these checks before committing any changes, when you install using the instructions above the prek hooks should be installed already.
148
148
149
149
## Code Coverage
150
150
@@ -196,10 +196,10 @@ and then you can run the following tasks:
196
196
uv sync --all-extras --dev
197
197
```
198
198
199
-
After this initial setup, you can use the following tasks to manage your development environment. It is advised to use the following setup command since that also installs the pre-commit hooks.
199
+
After this initial setup, you can use the following tasks to manage your development environment. It is advised to use the following setup command since that also installs the prek hooks.
200
200
201
201
#### `setup`
202
-
Set up the development environment with a virtual environment, install dependencies and pre-commit hooks:
202
+
Set up the development environment with a virtual environment, install dependencies and prek hooks:
203
203
```bash
204
204
uv run poe setup
205
205
# or with specific Python version
@@ -220,36 +220,36 @@ uv run poe venv
220
220
uv run poe venv --python 3.12
221
221
```
222
222
223
-
#### `pre-commit-install`
224
-
Install pre-commit hooks:
223
+
#### `prek-install`
224
+
Install prek hooks:
225
225
```bash
226
-
uv run poe pre-commit-install
226
+
uv run poe prek-install
227
227
```
228
228
229
229
### Code Quality and Formatting
230
230
231
-
Each of the following tasks are designed to run against both the main `agent-framework` package and the extension packages, ensuring consistent code quality across the project.
231
+
Each of the following tasks run against both the main `agent-framework` package and the extension packages in parallel, ensuring consistent code quality across the project.
232
232
233
233
#### `fmt` (format)
234
-
Format code using ruff:
234
+
Format code using ruff (runs in parallel across all packages):
235
235
```bash
236
236
uv run poe fmt
237
237
```
238
238
239
239
#### `lint`
240
-
Run linting checks and fix issues:
240
+
Run linting checks and fix issues (runs in parallel across all packages):
241
241
```bash
242
242
uv run poe lint
243
243
```
244
244
245
245
#### `pyright`
246
-
Run Pyright type checking:
246
+
Run Pyright type checking (runs in parallel across all packages):
247
247
```bash
248
248
uv run poe pyright
249
249
```
250
250
251
251
#### `mypy`
252
-
Run MyPy type checking:
252
+
Run MyPy type checking (runs in parallel across all packages):
253
253
```bash
254
254
uv run poe mypy
255
255
```
@@ -270,16 +270,22 @@ uv run poe markdown-code-lint
270
270
271
271
### Comprehensive Checks
272
272
273
+
#### `check-packages`
274
+
Run all package-level quality checks (format, lint, pyright, mypy) in parallel across all packages. This runs the full cross-product of (package × check) concurrently:
275
+
```bash
276
+
uv run poe check-packages
277
+
```
278
+
273
279
#### `check`
274
-
Run all quality checks (format, lint, pyright, mypy, test, markdown lint):
280
+
Run all quality checks including package checks, samples, tests and markdown lint:
275
281
```bash
276
282
uv run poe check
277
283
```
278
284
279
285
### Testing
280
286
281
287
#### `test`
282
-
Run unit tests with coverage by invoking the `test` task in each package sequentially:
288
+
Run unit tests with coverage by invoking the `test` task in each package in parallel:
283
289
```bash
284
290
uv run poe test
285
291
```
@@ -325,10 +331,10 @@ Publish packages to PyPI:
325
331
uv run poe publish
326
332
```
327
333
328
-
## Pre-commit Hooks
334
+
## Prek Hooks
329
335
330
-
Pre-commit hooks run automatically on commit and execute a subset of the checks on changed files only. You can also run all checks using pre-commit directly:
336
+
Prek hooks run automatically on commit and execute a subset of the checks on changed files only. Package-level checks (fmt, lint, pyright) run in parallel but only for packages with changed files. Markdown and sample checks are skipped when no relevant files were changed. If the `core` package is changed, all packages are checked. You can also run all checks using prek directly:
0 commit comments