forgejo_admin/minio-sdk

Fork 0

feat: standardize ruff config (line-length=88, select=E,F,I,W) #6

Merged

forgejo_admin merged 1 commit from 5-standardize-ruff-config into main

2026-03-28 19:05:03 +00:00

forgejo_admin commented

2026-03-28 18:56:28 +00:00

Owner

Summary

Align minio-sdk ruff configuration to the platform-wide standard: line-length=88, select=["E", "F", "I", "W"]. Reformat all source and test files to the new line length. Add ruff pre-commit hook.

Changes

pyproject.toml -- line-length 120 -> 88, select reordered to ["E", "F", "I", "W"]
.pre-commit-config.yaml -- new file with ruff and ruff-format hooks (pinned to v0.15.2)
src/minio_sdk/client.py -- reformatted long lines (function signatures, URL encoding calls)
src/minio_sdk/exceptions.py -- reformatted __init__ signature
src/minio_sdk/signer.py -- reformatted long lines (function signatures, f-strings, docstring)
src/minio_sdk/xml_parser.py -- reformatted XML builder string concatenations
tests/test_client.py -- reformatted long method signatures and calls
tests/test_client_unit.py -- reformatted XML string literals and mock patch calls
tests/test_signer.py -- reformatted long assertion strings
tests/test_xml_parser.py -- reformatted LifecycleRule constructor calls

Test Plan

ruff check src/ tests/ -- zero violations
ruff format --check src/ tests/ -- all files formatted
pytest tests/test_signer.py tests/test_xml_parser.py tests/test_client_unit.py -v -- 56/56 passed
Integration tests (test_client.py) skipped (require live MinIO credentials)

Review Checklist

ruff format --check . passes clean
ruff check . passes clean
Unit tests pass (56/56)
No N (naming) lint rules added
Pre-commit config pinned to same ruff version as pyproject.toml

No pal-e-docs notes affected.

Closes #5
Parent: pal-e-platform#29

## Summary Align minio-sdk ruff configuration to the platform-wide standard: `line-length=88`, `select=["E", "F", "I", "W"]`. Reformat all source and test files to the new line length. Add ruff pre-commit hook. ## Changes - `pyproject.toml` -- `line-length` 120 -> 88, `select` reordered to `["E", "F", "I", "W"]` - `.pre-commit-config.yaml` -- new file with ruff and ruff-format hooks (pinned to v0.15.2) - `src/minio_sdk/client.py` -- reformatted long lines (function signatures, URL encoding calls) - `src/minio_sdk/exceptions.py` -- reformatted `__init__` signature - `src/minio_sdk/signer.py` -- reformatted long lines (function signatures, f-strings, docstring) - `src/minio_sdk/xml_parser.py` -- reformatted XML builder string concatenations - `tests/test_client.py` -- reformatted long method signatures and calls - `tests/test_client_unit.py` -- reformatted XML string literals and mock patch calls - `tests/test_signer.py` -- reformatted long assertion strings - `tests/test_xml_parser.py` -- reformatted LifecycleRule constructor calls ## Test Plan - [x] `ruff check src/ tests/` -- zero violations - [x] `ruff format --check src/ tests/` -- all files formatted - [x] `pytest tests/test_signer.py tests/test_xml_parser.py tests/test_client_unit.py -v` -- 56/56 passed - Integration tests (`test_client.py`) skipped (require live MinIO credentials) ## Review Checklist - [x] `ruff format --check .` passes clean - [x] `ruff check .` passes clean - [x] Unit tests pass (56/56) - [x] No N (naming) lint rules added - [x] Pre-commit config pinned to same ruff version as pyproject.toml ## Related Notes No pal-e-docs notes affected. ## Related - Closes #5 - Parent: pal-e-platform#29

forgejo_admin added 1 commit

2026-03-28 18:56:28 +00:00

feat: standardize ruff config to platform standard (line-length=88) a096af9511

Align ruff configuration to the platform-wide standard: line-length=88,
select=E,F,I,W. Reformat all source and test files. Add ruff
pre-commit hook.

Closes #5

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

forgejo_admin commented

2026-03-28 18:57:02 +00:00

Author

Owner

QA Review -- PR #6

Scope Alignment (Issue #5)

pyproject.toml has line-length = 88 -- matches acceptance criteria
pyproject.toml has select = ["E", "F", "I", "W"] -- matches acceptance criteria
.pre-commit-config.yaml added with ruff hook -- matches acceptance criteria
ruff check . passes clean -- confirmed in test plan
ruff format --check . passes clean -- confirmed in test plan
No N (naming) lint rules added -- constraint respected

Config Review

line-length correctly changed from 120 to 88
select reordered from ["E", "F", "W", "I"] to ["E", "F", "I", "W"] (alphabetical)
Pre-commit hook pinned to v0.15.2, matching the ruff version in pyproject.toml dev deps -- good consistency

Code Changes Review

All changes are mechanical line-wrapping from the line-length reduction. Verified:

No logic changes in any source file
No behavioral changes in any test file
String literal splits in tests preserve exact XML content (e.g., test_client_unit.py XML error messages)
Auth header f-string split in signer.py correctly preserves the space after comma in the Authorization header format
Docstring in get_signing_key reformatted to fit within 88 chars -- content preserved

Nit (non-blocking)

signer.py docstring wrapping of the HMAC chain is slightly awkward with mismatched parentheses across lines. Consider a simpler representation, but this is cosmetic and non-blocking.

Test Verification

56/56 unit tests passed
Integration tests appropriately skipped (require live MinIO)

VERDICT: APPROVED

## QA Review -- PR #6 ### Scope Alignment (Issue #5) - [x] `pyproject.toml` has `line-length = 88` -- matches acceptance criteria - [x] `pyproject.toml` has `select = ["E", "F", "I", "W"]` -- matches acceptance criteria - [x] `.pre-commit-config.yaml` added with ruff hook -- matches acceptance criteria - [x] `ruff check .` passes clean -- confirmed in test plan - [x] `ruff format --check .` passes clean -- confirmed in test plan - [x] No N (naming) lint rules added -- constraint respected ### Config Review - `line-length` correctly changed from 120 to 88 - `select` reordered from `["E", "F", "W", "I"]` to `["E", "F", "I", "W"]` (alphabetical) - Pre-commit hook pinned to `v0.15.2`, matching the ruff version in pyproject.toml `dev` deps -- good consistency ### Code Changes Review All changes are mechanical line-wrapping from the line-length reduction. Verified: - No logic changes in any source file - No behavioral changes in any test file - String literal splits in tests preserve exact XML content (e.g., `test_client_unit.py` XML error messages) - Auth header f-string split in `signer.py` correctly preserves the space after comma in the Authorization header format - Docstring in `get_signing_key` reformatted to fit within 88 chars -- content preserved ### Nit (non-blocking) - `signer.py` docstring wrapping of the HMAC chain is slightly awkward with mismatched parentheses across lines. Consider a simpler representation, but this is cosmetic and non-blocking. ### Test Verification - 56/56 unit tests passed - Integration tests appropriately skipped (require live MinIO) --- **VERDICT: APPROVED**

forgejo_admin commented

2026-03-28 18:59:33 +00:00

Author

Owner

PR #6 Review

DOMAIN REVIEW

Tech stack: Python 3.12 / pure stdlib + requests / ruff / pytest / pre-commit

This PR is a formatting-only change: ruff config standardization from line-length=120 to line-length=88, select reordering to alphabetical ["E", "F", "I", "W"], and addition of .pre-commit-config.yaml. All 10 changed files are reformats of long lines to comply with the new width.

Ruff config (pyproject.toml):

line-length correctly changed 120 -> 88.
select reordered to alphabetical ["E", "F", "I", "W"] per platform convention.
target-version = "py312" retained -- correct.
Dev dependency ruff==0.15.2 matches .pre-commit-config.yaml rev: v0.15.2 -- good version pinning.

Pre-commit config (.pre-commit-config.yaml):

Pinned to v0.15.2 -- matches pyproject.toml.
Two hooks: ruff (with --fix) and ruff-format -- correct pattern.
No extraneous hooks.

Reformatting correctness: Reviewed all 8 reformatted Python files against the originals. Every change is a mechanical line-wrap -- no logic changes, no behavioral modifications. The reformats follow standard ruff format output: break after opening parenthesis, align parameters, close parenthesis on its own line.

Residual long lines: I identified several string literals that still exceed 88 characters after the diff is applied (e.g., xml_parser.py lines 309, 335, 345; client.py lines 241, 370). This is correct behavior -- ruff format intentionally does not break string literals that cannot be split without changing semantics, and E501 is auto-disabled when the formatter is active. These would pass both ruff format --check and ruff check cleanly.

Docstring reformat note (signer.py get_signing_key): The original docstring signing_key = HMAC(HMAC(HMAC(HMAC("AWS4" + secret, date), region), service), "aws4_request") is reformatted across 3 lines. The new version is less readable as a mathematical expression, but this is the formatter's output and manually overriding it would create a maintenance burden. Acceptable.

BLOCKERS

None.

No new functionality introduced -- no test coverage requirement.
No user input changes -- no validation concerns.
No secrets or credentials in code.
No auth/security path changes.

NITS

Docstring readability (src/minio_sdk/signer.py, get_signing_key): The reformatted HMAC chain docstring lost clarity compared to the original one-liner. Consider wrapping it in a code block (triple backticks or indented block) so the formatter leaves it alone. Non-blocking since this is formatter output.

SOP COMPLIANCE

Branch named after issue: 5-standardize-ruff-config matches issue #5
PR body follows template: Summary, Changes, Test Plan, Review Checklist, Related sections all present
Related references parent: pal-e-platform#29 referenced
No secrets committed: verified -- no .env files, no hardcoded credentials
No scope creep: all changes are formatting-only, within the stated scope
Test plan executed: 56/56 unit tests passed per PR body; integration tests appropriately skipped

PROCESS OBSERVATIONS

Clean formatting-only PR with zero risk of behavior change. Good candidate for fast merge.
Pre-commit hook addition is a positive infrastructure improvement -- will prevent future line-length drift.
The select alphabetical ordering is a small but useful standardization for cross-repo consistency.
No DORA risk: no deployment artifact changes, no config changes that affect runtime.

VERDICT: APPROVED

## PR #6 Review ### DOMAIN REVIEW **Tech stack**: Python 3.12 / pure stdlib + requests / ruff / pytest / pre-commit This PR is a formatting-only change: ruff config standardization from `line-length=120` to `line-length=88`, `select` reordering to alphabetical `["E", "F", "I", "W"]`, and addition of `.pre-commit-config.yaml`. All 10 changed files are reformats of long lines to comply with the new width. **Ruff config** (`pyproject.toml`): - `line-length` correctly changed 120 -> 88. - `select` reordered to alphabetical `["E", "F", "I", "W"]` per platform convention. - `target-version = "py312"` retained -- correct. - Dev dependency `ruff==0.15.2` matches `.pre-commit-config.yaml` `rev: v0.15.2` -- good version pinning. **Pre-commit config** (`.pre-commit-config.yaml`): - Pinned to `v0.15.2` -- matches pyproject.toml. - Two hooks: `ruff` (with `--fix`) and `ruff-format` -- correct pattern. - No extraneous hooks. **Reformatting correctness**: Reviewed all 8 reformatted Python files against the originals. Every change is a mechanical line-wrap -- no logic changes, no behavioral modifications. The reformats follow standard ruff format output: break after opening parenthesis, align parameters, close parenthesis on its own line. **Residual long lines**: I identified several string literals that still exceed 88 characters after the diff is applied (e.g., `xml_parser.py` lines 309, 335, 345; `client.py` lines 241, 370). This is correct behavior -- `ruff format` intentionally does not break string literals that cannot be split without changing semantics, and E501 is auto-disabled when the formatter is active. These would pass both `ruff format --check` and `ruff check` cleanly. **Docstring reformat note** (`signer.py` `get_signing_key`): The original docstring `signing_key = HMAC(HMAC(HMAC(HMAC("AWS4" + secret, date), region), service), "aws4_request")` is reformatted across 3 lines. The new version is less readable as a mathematical expression, but this is the formatter's output and manually overriding it would create a maintenance burden. Acceptable. ### BLOCKERS None. - No new functionality introduced -- no test coverage requirement. - No user input changes -- no validation concerns. - No secrets or credentials in code. - No auth/security path changes. ### NITS 1. **Docstring readability** (`src/minio_sdk/signer.py`, `get_signing_key`): The reformatted HMAC chain docstring lost clarity compared to the original one-liner. Consider wrapping it in a code block (triple backticks or indented block) so the formatter leaves it alone. Non-blocking since this is formatter output. ### SOP COMPLIANCE - [x] Branch named after issue: `5-standardize-ruff-config` matches issue #5 - [x] PR body follows template: Summary, Changes, Test Plan, Review Checklist, Related sections all present - [x] Related references parent: `pal-e-platform#29` referenced - [x] No secrets committed: verified -- no `.env` files, no hardcoded credentials - [x] No scope creep: all changes are formatting-only, within the stated scope - [x] Test plan executed: 56/56 unit tests passed per PR body; integration tests appropriately skipped ### PROCESS OBSERVATIONS - Clean formatting-only PR with zero risk of behavior change. Good candidate for fast merge. - Pre-commit hook addition is a positive infrastructure improvement -- will prevent future line-length drift. - The `select` alphabetical ordering is a small but useful standardization for cross-repo consistency. - No DORA risk: no deployment artifact changes, no config changes that affect runtime. ### VERDICT: APPROVED