Enable flake8-bugbear (B) and review further ruff rule sets
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Bug
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- data, developer-experience, testing
Rechercherichtung
Start by checking linked PR #74, since it may already cover this work. The rule set is in pyproject.toml; add B and ignore B008. The five delete-value setters in mikecore/DfsBuilder.py (around lines 124-160) need self.__CheckBuildStage1() with the parentheses added, and tests/examples_dfsu.py (line 297) and tests/test_dfsu_file.py (line 1264) hold the two stray expressions. Done when ruff reports no B findings, the pre-commit hooks pass, and a new test shows that setting a delete value after CreateFile raises an error.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Why
Five DfsBuilder delete-value setters never run their build-stage check, because the call is missing its parentheses:
def SetDeleteValueDouble(self, value):
self.__CheckBuildStage1 # looks the method up, never calls it
self.FileInfo.DeleteValueDouble = value
The same line is in SetDeleteValueFloat, SetDeleteValueByte, SetDeleteValueInt and SetDeleteValueUnsignedInt (L124, L133, L142, L151, L160). Every other setter calls self.__CheckBuildStage1(). So a delete value can be changed after CreateFile without an error, after the header has already been written.
The same rule finds two more bugs in the tests:
tests/examples_dfsu.py#L297: a baretopLayerOffset, left over from a C# declaration, reads a local before it is assigned. SoExtractDfsu2DLayerFrom3DraisedNameErroron every call. It is fixed in #66.tests/test_dfsu_file.py#L1264: a bareAssert.IsTruethat is never called, so that line asserts nothing.
None of our checks reports these. Ruff runs only E4, E7, E9, F and UP (pyproject.toml), and none of those rules looks at expressions whose value is discarded. A type checker (pyrefly, #66) accepts an uncalled bound method as a valid expression. flake8-bugbear's B018 (useless expression) finds exactly these 7 lines and nothing else.
Proposal
Add the bugbear rules (B) to ruff's select, ignoring B008, and fix what they report. On master that is 29 findings:
| Rule | Hits | Finding |
|---|---|---|
B018 useless expression |
7 | The 5 setters and the 2 test lines above. Real bugs. |
B017 pytest.raises(Exception) |
4 | tests/test_dfsbuilder.py. These pass on any error, including one caused by a bug. Add match=. |
B904 raise in except without from |
11 | SetNodes in both builders and MeshFile. Adding from err keeps the cause in the traceback. |
B007 unused loop variable |
3 | Rename to _j / _i. |
B008 call in a default argument |
4 | Not bugs (DfsParameters() is never mutated, np.float32 is immutable), so ignore the rule. B006 (mutable defaults) still applies. |
The rules with no findings today are still worth having in a codebase ported from C#: B015 (a comparison used as a statement, where an assert was meant), B011 (assert False), B023 (a closure over a loop variable), B006 (a mutable default argument) and B905 (zip() without strict=, which #66's new tests would trip).
Once B is in, other rule sets could be reviewed the same way, each with its findings on master. Candidates are PT (pytest style), SIM, and PL errors (PLE).
Done when
selectincludesB,B008is ignored with a reason, anduvx pre-commit run --all-filespasses.- The 5 setters call
self.__CheckBuildStage1(), with a test that setting a delete value afterCreateFileraises an error.
- Vorherrschende Sprache
- Python
- Sterne
- 5
- Forks
- 1
- Ø Merge
- 1 T. 15 Std.
- Gemergte PRs (30 T.)
- 16
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus DHI/mikecore-python
-
Four test assertions carried over from the C# suite are still commented outEvtl. vergeben @ryan-kipawa hat das vor 26 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
DHI/mikecore-python#49 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Bugs found while adding type checking (#66), not yet fixedEvtl. vergeben @ryan-kipawa hat das vor 13 Tagen übernommen. Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
DHI/mikecore-python#72 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
DHI/mikecore-python#59 ·
Maintainer antworten meist innerhalb von 1 Tag
-
New submesh feature (2027) makes all dfsu fail!Evtl. vergeben @ryan-kipawa hat das vor 26 Tagen übernommen. Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100
DHI/mikecore-python#54 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Remaining TODOs in production code: platform notes, licensing questions, and one likely-stale markerOffen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
DHI/mikecore-python#51 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in DHI/mikecore-python
Ähnliche Issues
-
The changelog workflow excludes otelbot but not dependabot, so every Dependabot pull request fails the changelog checkEvtl. vergeben @ocelotl hat das heute übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
open-telemetry/opentelemetry-python#5825 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
cuga-project/cuga-agent#1020 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 70/100
microsoft/playwright#43640 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
stac-utils/stac-fastapi-elasticsearch-opensearch#965 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag