pySCG: investigate and recommend a list of static code analysis tools
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Calme
- Stack technique
- python
- Domaine
- documentation, security, testing
Piste de recherche
Read the contribution guide and its existing mention of Ruff with Bandit, then check the related type hints topic for overlap. Draft a page recommending static and dynamic analysis tools and a minimum tool set for Python coding environments. Done means the guidance covers the listed tool examples and avoids duplicating the type hints topic.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
automated detection of well known code flaws and a common way of formatting can be very helpfull to avoid issues.
This issue is as a placeholder to create a page explaining static code analysis tools as mentioned in our contribution guide (Ruff with configured Bandit) and dynamic analysis tools such as pyre.
It might be required to merge it with the topic on type hints to avoid duplication. We should however provide some sort of solid idea of bare minimum that should be included in every coding ide similar to Compiler Options Hardening Guide for C and C++
Example Static tools:
- Ruff
- Pylint
- Mypy
- Bandit
- PyDocstyle
- Mccabe
- Vulture
- SonarQube
- pep8
- flake8
Example dynamic tools:
- PyTest
- Pytest-cov
- coverage.py
Test automation:
- Tox
- Langage dominant
- Python
- Étoiles
- 2
- Forks
- 2
- Merge moyen
- 11 min
- PR mergées (30 j)
- 2
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
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 ossf/python-secure-coding-guide
-
pyscg-0051 should use a context managerPeut-être pris @s19110 l’a pris il y a 8 jours. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
ossf/python-secure-coding-guide#1 · 4 commentaires · 1 personne assignée ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 65/100
ossf/python-secure-coding-guide#29 · 1 commentaire ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
Toutes les issues de ossf/python-secure-coding-guide
Issues similaires
-
README Quick Start query command fails, and doctor points to a missing Prerequisites sectionOuvertedocumentation type/bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
add entry to blockOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
StevenBlack/hosts#3299 ·
-
`garak --report` overwrites the input report when its name has no ".report"Peut-être pris @0z5a l’a pris aujourd’hui. Ouverteneeds-triage
Difficulté 2/5 Une demi-journée Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 2 jours
-
trace: Pi's 1-hour cache writes are priced at 1.25x, but billed at 2xPeut-être pris @Shizoqua l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
microsoft/TokenEconomizer#221 ·
Les mainteneurs répondent en général sous 1 jour
-
plot_graph crashes when a mesh node has no m2m edgePeut-être pris @tygvi l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
mllam/neural-lam#883 · 1 commentaire ·
Les mainteneurs répondent en général sous 2 jours