projen/lib/python/pytest.d.ts

CDK for software projects

import { Component } from "../component";
import type { Project } from "../project";
export interface PytestOptions {
    /**
     * Pytest version
     *
     * @default "8.3.5"
     */
    readonly version?: string;
    /**
     * Stop the testing process after the first N failures
     */
    readonly maxFailures?: number;
    /**
     * List of paths to test files or directories.
     * Useful when all project tests are in a known location to speed up
     * test collection and to avoid picking up undesired tests by accident.
     *
     * Leave empty to discover all test_*.py or *_test.py files, per Pytest default.
     * Glob patterns are supported, including `**` for recursive matching.
     *
     * The entries form pytest's `testpaths` setting, which is parsed like a shell
     * word list, so a path containing spaces has to be quoted: `["'my tests'"]`.
     *
     * @example ["tests/unit", "tests/qa"]
     * @default []
     */
    readonly testMatch?: string[];
}
export declare class Pytest extends Component {
    readonly testMatch: string[];
    constructor(project: Project, options?: PytestOptions);
}