Quelle fonctions doivent aller dans quels modules? Comment circule la donnee dans le projet? Quelles fonctionnalites et fonctions peuvent etre groupees ensemble et isolees? En repondant a des questions comme ceci, vous pouvez commencer a planifier, au sens large, ce a quoi votre service fini ressemblera.

Dans votre section, nous allons jeter un ?il De surcroi®t pres sur les systemes de module et d’import de Python tel ils paraissent les points centraux afin d’effectuer respecter une structure dans votre projet. Nous discuterons ensuite des diverses perspectives sur De quelle fai§on construire du code lequel pourra etre etendu et teste de maniere fiable.

Structure du depot

C’est important

Juste comme le style de codage, le design d’API, et l’automatisation sont essentiels a un cycle de developpement sain, la structure d’un depot reste une part cruciale de l’architecture de ce projet.

Quand un utilisateur potentiel ou votre contributeur arrive sur la page d’un depot, ils voient certaines trucs:

Notre nom du projet

La description des travaux

Un tas de fichiers

C’est juste di?s qu’ils font defiler la page que les utilisateurs verront le README de ce projet.

Si votre depot est un amas massif de fichiers ou une pagaille imbriquee de repertoires, ils risquent de regarder ailleurs avant meme de lire votre belle documentation.

Habillez vous concernant le job que vous voulez, gui?re concernant le job que vous avez.

Bien sur, les premieres impressions ne sont nullement bien. Vous et vos collegues allez passer un nombre d’heures incalculable a travailler via ce depot, finalement i?tre intimement familier avec tous les coins et recoins. Le organisation reste importante.

Depot exemple

tl;dr (acronyme de “Too Long, I Didn’t Read it”): C’est votre que Kenneth Reitz recommande.

Entrons dans deux details.

Notre module actuel

./sample/ ou ./sample.py

Le code qui nous interesse

Votre paquet de module est le point central du depot. Cela ne se doit de nullement etre mis a l’ecart:

Si la module consiste en un seul fichier, vous pourrez le placer en direct a la racine de ce repertoire:

Votre bibliotheque n’appartient pas a un sous-repertoire ambigu tel src ou python.

Licence

Se couvrir juridiquement.

Ceci reste en general la part principale de ce depot, en dehors du code source lui-meme. Les revendications de copyright et l’article en licence complet devraient etre dans ce fichier.

Si vous n’etes pas sur en licence que vous souhaitez choisir Afin de la projet, consultez choosealicense.com.

Naturellement, vous etes aussi libre de publier votre code sans une licence, mais cela risque potentiellement d’empecher de nombreuses gens d’utiliser la code.

Setup.py

Gestion d’une distribution et de la realisation de paquets

Si ce paquet de module reste a J’ai racine de votre depot, ceci doit evidemment etre aussi a la racine.

Fichier requirements

Dependances https://datingmentor.org/fr/sudy-review/ de developpement.

Un fichier requirements de pip devrait etre place a J’ai racine du depot. Il pourrait specifier les dependances requises Afin de contribuer au projet: les tests, les builds et la generation une documentation.

Si ce projet n’a aucun dependances de developpement ou vous preferez la configuration de l’environnement de developpement via setup.py , votre fichier peut s’averer non utile.

Documentation

Documentation de reference des paquets.

Depuis tres peu de raison pour cela qu’il existe ailleurs.

Suite de tests

./test_sample.py ou ./tests

Integration de paquets et tests unitaires

En debutant, une petite suite de tests existera souvent dans un seul fichier:

Une fois que la suite de tests grossit, vous pourrez deplacer ces tests dans un repertoire, comme ceci:

Evidemment, ces modules de test doivent importer votre module empaquete pour le tester. Vous pouvez le Realiser de quelques facons:

Attendre que le paquet soit installe au sein d’ site-packages.

Utiliser 1 modification de chemin simple (mais explicite) pour resoudre le paquet correctement.

Je recommande fortement ce soir. Demander a un developpeur de lancer setup.py develop pour tester une base de code qui change activement lui demande aussi d’avoir une configuration d’environnement isole Afin de chaque instance en base de code.

Pour apporter 1 contexte d’importation a toutes les tests individuels, creez un fichier tests/config.py.

Ensuite, en modules de test individuels, importez le module tel ceci:

Ca fonctionnera toujours comme prevu peu importe la technique d’installation.