[next major] Do not shadow Python standard-library module
@benoit74 y travaille déjà.
Depuis le 20/1/2025.
Évaluation
Cette issue n'a pas encore été évaluée.
Description
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.
- Langage dominant
- Python
- Étoiles
- 31
- Forks
- 31
- Merge moyen
- 2 j 5 h
- PR mergées (30 j)
- 3
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de openzim/python-scraperlib
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
openzim/python-scraperlib#339 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
openzim/python-scraperlib#292 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
openzim/python-scraperlib#346 ·
-
URL normalisation: do not rewrite consecutive slashes `//` as a single slash `/`Peut-être pris @anshuman83-40 l’a pris il y a 4 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
openzim/python-scraperlib#340 ·
-
Add fuzzy rule to rewrite URLs of lesbases.anct.gouv.frPeut-être à nouveau libre @benoit74 l’a pris il y a 48 jours, et aucune pull request n’est ouverte. Ouverte
openzim/python-scraperlib#334 · 1 personne assignée ·
Toutes les issues de openzim/python-scraperlib
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
SR_SECURITY_DESCRIPTOR.fromString drops the SACL when no DACL is presentPeut-être pris @paul7436 l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 2 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
equinor/fmu-sumo-uploader#302 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
modelscope/evalscope#1821 ·
Les mainteneurs répondent en général sous 1 jour
-
Sanity on ansible-core devel fails: ignore-2.23.txt references the removed import-3.9 testPeut-être pris @yurnov l’a pris aujourd’hui. Ouverteneeds_triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 91/100
ansible-collections/kubernetes.core#1275 ·
Les mainteneurs répondent en général sous 1 jour