Skip to content

Latest commit

 

History

History
executable file
·
156 lines (119 loc) · 6.12 KB

README.fr.md

File metadata and controls

executable file
·
156 lines (119 loc) · 6.12 KB
Raw

Contributors Stargazers Issues PyPi version Python 3


Logo

AutoTest!Reg

Tester automatiquement vos fonctions pour voir si vous avez modifié leur comportement par erreur.


Voir la démo · Report Bug

Introduction

Avez vous déjà passé des heures à retravailler le code de quelqu'un d'autre en essayant de ne rien casser, pour vous rendre compte au dernier moment que quelque chose ne marche plus, mais sans savoir à quelle étape vous avez introduit le bug ? Tellement frustrant !

AutoTest!Reg vous permets de suivre automatiquement le code que vous travaillez et de n'introduire aucune régression, sans écrire un seul test !

(retour en haut)

Pour commencer

Utiliser AutoTest!Reg ne recquiert quasiment aucun effort.

Installer AutoTest!Reg avec pip :

pip install autotestreg

Importer AutoTest!Reg dans vos tests, en ajoutant cette ligne :

import autotestreg

Pour suivre une fonction my_func, ce code suffit:

from autotestreg import autotest_func

def my_func():
    ...

autotest_func(my_func)

Pour suivre un module entier mypackage, avec toutes les fonctions et méthodes qu'il contient:

from autotestreg import autotest_module
import mypackage

autotest_module(mypackage)

(retour en haut)

Ensuite

Si aucune régression n'a été introduite quand vous modifier le code, vos tests passeront avec succès.

Sinon, AutoTest!Reg vous donnera la fonction dont le comportement a été modifié.

Usage avancé

Vous pouvez utiliser AutoTest!Reg comme un pre-commit hook:

  1. Créez des fichiers de test en utilisant autotestreg (par exemple some_tests.py)
  • Ce fichier doit contenir en haut from autotestreg import set_interactive et set_interactive(False)
  1. Modifiez le script de pre-commit hook: touch .git/hooks/pre-commit
  2. Ajoutez ceci à l'intérieur:
#!/bin/sh
# N'oubliez pas d'activer votre env si nécessaire.
python some_tests.py
  1. Rendez le fichier pre-commit exécutable: chmod +x .git/hooks/pre-commit

Contributing

(Section in english)
I want to add a lot of functionnalities to this project, but I don't have much time to work on it. Contributions are welcome!

(back to top)

How to contribute

Contributing is an awesome way to learn, inspire, and help others. Any contributions you make are greatly appreciated, even if it's just about styling and best practices.

If you have a suggestion that would make this project better, please fork the repo and create a pull request.
Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YourAmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Auteurs

Cette librairie a été crée par Nicolas MICAUX.