[next major] Do not shadow Python standard-library module

Offen

#246 erstellt am 20.1.2025 2 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@benoit74 arbeitet bereits daran.

Seit 20.1.2025.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

enhancement

Ruff / Flake8 has a new rule A005: https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/

It is recommended to not shadow Python standard-library modules.

Currently, we have 5 issues:

src/zimscraperlib/html.py:1:1: A005 Module `html` shadows a Python standard-library module
src/zimscraperlib/logging.py:1:1: A005 Module `logging` shadows a Python standard-library module
src/zimscraperlib/rewriting/html.py:1:1: A005 Module `html` shadows a Python standard-library module
src/zimscraperlib/types.py:1:1: A005 Module `types` shadows a Python standard-library module
src/zimscraperlib/typing.py:1:1: A005 Module `typing` shadows a Python standard-library module

For now, I've disabled the rule A005 in https://github.com/openzim/python-scraperlib/pull/245 but we need to make a finer decision.

I think that logging module is shadowing "on-purpose" and might be allowed. Others could be considered for renaming. But I don't have very good suggestions of names, so I'm not 100% convinced, if we end-up with bad names, I'm not sure it really ease maintenance at all.

Vorherrschende Sprache: Python
Sterne: 31
Forks: 27
Ø Merge: 3 T. 7 Std.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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 openzim/python-scraperlib

HTML rewriting: also rewrite `poster` attribute Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

openzim/python-scraperlib#339 · Erstellt am 16.9.2026
[next major] Remove deprecated 'convert' parameter for optimize_image function inside optimization.py Offen

enhancement

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

openzim/python-scraperlib#292 · Erstellt am 11.4.2026
URL normalisation: URL-encoded `#` makes its way into the path, but is lost when obtaining the URI of that entry Offen

bug

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

openzim/python-scraperlib#341 · Erstellt am 17.9.2026
URL normalisation: do not rewrite consecutive slashes `//` as a single slash `/` Offen

bug

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

openzim/python-scraperlib#340 · Erstellt am 17.9.2026
Add fuzzy rule to rewrite URLs of lesbases.anct.gouv.fr Offen

bug

openzim/python-scraperlib#334 · 1 zugewiesene Person · Erstellt am 21.8.2026

Alle Issues in openzim/python-scraperlib