python-code-style-validation
Summary
Automated validation of Python source code conformance to project style standards (black formatting and PEP8 linting) to maintain code quality and consistency in collaborative development. This skill combines automated formatting checks and lint analysis to detect style violations before code review.
When to use
Apply this skill when preparing Python code for contribution to a project that documents style requirements (black and/or flake8), during pre-commit validation in a CI/CD pipeline, or when reviewing pull requests to enforce uniform code standards across the repository.
When NOT to use
- The project does not document use of black or flake8 in its contribution guidelines.
- Input code is not Python source files (e.g., Jupyter notebooks, YAML, JSON configuration).
- Style validation has already been applied and code is confirmed to conform; re-running is redundant unless code has been modified.
Inputs
- Python source tree (directory of .py files)
- Project contribution guidelines or style configuration files (pyproject.toml, setup.cfg, .flake8)
- medema-group/BiG-SCAPE repository or equivalent GitHub source
Outputs
- Black formatting conformance report (list of non-conforming files)
- Flake8 lint report (structured list of PEP8 violations with file paths and line numbers)
- Binary pass/fail status for code style validation
- Consolidated style compliance report
How to apply
Clone or obtain the target Python repository. Run black in check mode on all Python source files to detect formatting violations without applying changes, then parse the output to identify non-conforming files. Subsequently run flake8 across the entire source tree to detect PEP8 compliance violations, including logical errors and style issues beyond formatting. Generate and preserve a structured conformance report documenting file locations, line numbers, and violation types. Pass/fail judgment is based on zero violations from both tools; any violation indicates the code does not meet the project's documented style standards.
Related tools
- black (Detect Python source code formatting violations against the black auto-formatting standard in check mode; identifies files that do not conform without modifying them) — https://github.com/psf/black
- flake8 (Enforce PEP8 compliance across the Python source tree; detects style violations, logical errors, and code quality issues; generates structured violation reports with file locations and line numbers) — https://github.com/PyCQA/flake8
Examples
black --check . && flake8 . --format=json > flake8_report.json
Evaluation signals
- Black check mode reports zero formatting violations (exit code 0; all files listed as 'would reformat' or similar have been corrected).
- Flake8 reports zero PEP8 violations (exit code 0; output contains no violation lines).
- All identified violations in the conformance report can be traced to specific files, line numbers, and rule codes (e.g., E501, W503).
- Conformance report is machine-parseable and can be compared against prior runs to track remediation.
- Violations reported by both tools match the project's documented style configuration (black version, flake8 rules, exclusion patterns).
Limitations
- Black and flake8 enforce syntactic and stylistic rules only; they do not validate logical correctness, algorithmic efficiency, or semantic intent.
- Configuration drift: different versions of black or flake8, or undocumented local configuration files, may produce inconsistent results across environments.
- Some violations may be false positives or project-specific exceptions (e.g., deliberately long lines in generated code); manual review is required to distinguish legitimate exceptions from true violations.
- The skill does not guarantee that passing code is ready for production; it only confirms adherence to documented style standards.
Evidence
- [other] The BiG-SCAPE project documents that it uses black for auto-formatting of Python source code.: "The BiG-SCAPE project documents that it uses black for auto-formatting of Python source code."
- [other] Run black in check mode on all Python files in the repository to detect formatting violations without applying changes.: "Run black in check mode on all Python files in the repository to detect formatting violations without applying changes."
- [other] The BiG-SCAPE project uses flake8 for linting to enforce PEP8 standards across the source tree.: "The BiG-SCAPE project uses flake8 for linting to enforce PEP8 standards across the source tree."
- [other] Run flake8 linter across all Python source files in the repository to detect PEP8 violations.: "Run flake8 linter across all Python source files in the repository to detect PEP8 violations."
- [other] Generate and save a structured lint report documenting all identified violations, their file locations, and line numbers.: "Generate and save a structured lint report documenting all identified violations, their file locations, and line numbers."
1---2name: python-code-style-validation3description: Use when preparing Python code for contribution to a project that documents style requirements (black and/or flake8), during pre-commit validation in a CI/CD pipeline, or when reviewing pull requests to enforce uniform code standards across the repository.4license: CC-BY-4.05---67# python-code-style-validation89## Summary1011Automated validation of Python source code conformance to project style standards (black formatting and PEP8 linting) to maintain code quality and consistency in collaborative development. This skill combines automated formatting checks and lint analysis to detect style violations before code review.1213## When to use1415Apply this skill when preparing Python code for contribution to a project that documents style requirements (black and/or flake8), during pre-commit validation in a CI/CD pipeline, or when reviewing pull requests to enforce uniform code standards across the repository.1617## When NOT to use1819- The project does not document use of black or flake8 in its contribution guidelines.20- Input code is not Python source files (e.g., Jupyter notebooks, YAML, JSON configuration).21- Style validation has already been applied and code is confirmed to conform; re-running is redundant unless code has been modified.2223## Inputs2425- Python source tree (directory of .py files)26- Project contribution guidelines or style configuration files (pyproject.toml, setup.cfg, .flake8)27- medema-group/BiG-SCAPE repository or equivalent GitHub source2829## Outputs3031- Black formatting conformance report (list of non-conforming files)32- Flake8 lint report (structured list of PEP8 violations with file paths and line numbers)33- Binary pass/fail status for code style validation34- Consolidated style compliance report3536## How to apply3738Clone or obtain the target Python repository. Run black in check mode on all Python source files to detect formatting violations without applying changes, then parse the output to identify non-conforming files. Subsequently run flake8 across the entire source tree to detect PEP8 compliance violations, including logical errors and style issues beyond formatting. Generate and preserve a structured conformance report documenting file locations, line numbers, and violation types. Pass/fail judgment is based on zero violations from both tools; any violation indicates the code does not meet the project's documented style standards.3940## Related tools4142- **black** (Detect Python source code formatting violations against the black auto-formatting standard in check mode; identifies files that do not conform without modifying them) — https://github.com/psf/black43- **flake8** (Enforce PEP8 compliance across the Python source tree; detects style violations, logical errors, and code quality issues; generates structured violation reports with file locations and line numbers) — https://github.com/PyCQA/flake84445## Examples4647```48black --check . && flake8 . --format=json > flake8_report.json49```5051## Evaluation signals5253- Black check mode reports zero formatting violations (exit code 0; all files listed as 'would reformat' or similar have been corrected).54- Flake8 reports zero PEP8 violations (exit code 0; output contains no violation lines).55- All identified violations in the conformance report can be traced to specific files, line numbers, and rule codes (e.g., E501, W503).56- Conformance report is machine-parseable and can be compared against prior runs to track remediation.57- Violations reported by both tools match the project's documented style configuration (black version, flake8 rules, exclusion patterns).5859## Limitations6061- Black and flake8 enforce syntactic and stylistic rules only; they do not validate logical correctness, algorithmic efficiency, or semantic intent.62- Configuration drift: different versions of black or flake8, or undocumented local configuration files, may produce inconsistent results across environments.63- Some violations may be false positives or project-specific exceptions (e.g., deliberately long lines in generated code); manual review is required to distinguish legitimate exceptions from true violations.64- The skill does not guarantee that passing code is ready for production; it only confirms adherence to documented style standards.6566## Evidence6768- [other] The BiG-SCAPE project documents that it uses black for auto-formatting of Python source code.: "The BiG-SCAPE project documents that it uses black for auto-formatting of Python source code."69- [other] Run black in check mode on all Python files in the repository to detect formatting violations without applying changes.: "Run black in check mode on all Python files in the repository to detect formatting violations without applying changes."70- [other] The BiG-SCAPE project uses flake8 for linting to enforce PEP8 standards across the source tree.: "The BiG-SCAPE project uses flake8 for linting to enforce PEP8 standards across the source tree."71- [other] Run flake8 linter across all Python source files in the repository to detect PEP8 violations.: "Run flake8 linter across all Python source files in the repository to detect PEP8 violations."72- [other] Generate and save a structured lint report documenting all identified violations, their file locations, and line numbers.: "Generate and save a structured lint report documenting all identified violations, their file locations, and line numbers."
HolobiomicsLab