FEATHER-CHARGER-MODULE-IMPORT

Importer un fichier de code

Comme pour une version standard de Python, vous pouvez importer et exécuter du code provenant de fichiers python dans votre script MicroPython. Cette approche est idéal pour décomposer un long script ou script complexe en des morceaux de codes plus petits. Cela permet de réutiliser ou partager du code entre plusieurs project. Cela facilite également le processus de maintenance.

Si vous n'avez pas l'habitude des modules Python alors vous devriez prendre connaissance de la documentation officielle (Python.org, Anglais). Python vous permet de placer du codans dans un fichier .py puis de l'importer depuis un autre script se trouvant dans le même répertoire. Vous pouvez même opter pour une approche plus avancée en créant un paquet (package en anglais) contenant plusieurs fichiers .py que vous pourrez exposer de différentes façons. La plupart des bibliothèques Python tierces sont disponibles sous forme de paquet que vous pouvez installer et importer dans vos propres scripts.

Nous allons commencer par voir comment importer du code depuis un simple fichier .py dans votre script MicroPython. Assurez-vous d'avoir une carte fonctionnant sous MicroPython et de vous être familiarisé avec les manipulations de fichier sur votre carte.

Ensuite, nous allons commencer par créer un petit fichier Python sur notre ordinateur, il contiendra quelques fonctions. Créez le fichier test.py avec un éditeur de texte et copiez y le code suivant:

def add(a, b):
    return a + b

def subtract(a, b):
    return a - b

La fonction add() permet de faire l'addition de deux valeurs tandis que la fonction substract() effectue une soustraction.

Testez d'abord ce code depuis votre ordinateur avec la version PC de Python avant de l'essayer sur MicroPython. Dans un termminal, naviguez dans le répertoire contenant le fichier test.py (ceci est très important, vous devez vous trouver dans le même répertoire que test.py!) puis exécutez la commande python3 (ou python si vous utilisez Python 2.x).

Saisissez les commandes suivantes sur l'invite de commande Python (ou invite REPL... lorsque vous testerez sous MicroPython):

import test
test.add(1, 1)

Vous devriez voir l'appel a la fonction add() (ajouter) et le resultat 1 + 1 retourné. Si vous voyez un ImportError indiquant le module test ne peut pas être chargé alors assurez vous que vous exécutez Python depuis le même répertoire que votre fichier test.py.

Essayez ensuite d'appeler la fonction subtract() (soustraction) comme nous l'avons fait pour l'addition. Rappelez vous bien d'ajouter le nom du module devant le nom de la fonction que vous voulez appeler!

Crédit: AdaFruit Industries www.adafruit.com

Maintenant que vous savez comment importer un simple fichier .py sur votre ordinateur, nous allons faire la même chise avec notre carte MicroPython. Copiez le fichier test.py dans le répertoire racine (dit root en anglais) de votre système de fichier. Par exemple, si vous utilisez un outil tel que ampy pour copier les fichiers que vous désirez exécuter alors vous devriez utiliser une syntaxe similaire à celle-ci:

ampy --port /board/serial/port put test.py

Connectez vous ensuite en REPL sur la carte et exécutez les mêmes instructions Python (que celles ci-dessus) pour importer et utiliser le module:

import test
test.add(1, 1)
test.subtract(1, 1)

Crédit: AdaFruit Industries www.adafruit.com

Vous devriez voir les fonctions fonctionner exactement comme elles le font dans le programme Python de votre ordinateur! Si vous voyez un message d'erreur ImportError alors vérifiez l'opération de copie du fichier test.py sur la racine du système de fichier de votre carte puis essayez encore.

Importer et utiliser du code depuis un fichier .py avec MicroPython est aussi facile que l'opération que nous venons d'apprendre. Il faut copier le fichier sur la carte puis l'importer avec l'instruction import comme vu ci-dessus.

Souvenez vous que le fichier .py a importer doit se trouver dans le répertoire que le script qui l'importe et l'utilise. Dans la plupart des cas vos scripts se trouverons dans la racine du système de fichier, ce sera donc l'emplacement où vous placerez naturellement les fichier .py que vous voudrez importer.

Grâce à l'importation, vous pouvez faire bien plus qu'importer et appeler des fonctions dans vos scripts. Tout ce qui se trouve dans le fichier test.py comme les classes, les fonctions, les variables globales, etc seront disponibles votre script dès la commande d'importation import exécutée.

Trucs & astuces: il est possible de voir exactement ce qui se trouve dans un module en utilisant l'instruction dir(), voyez l'exemple suivant qui peut être exécuté dans REPL:

import test
dir(test)

Crédit: AdaFruit Industries www.adafruit.com

Vous devriez voir une liste de tout ce qui à été importé dans le module, y compris les fonctions add() et subtract() (la variable __name__ est ajoutée par Python pour que le module puisse connaître son propre nom).

Les paquets (Packages)

Il arrive parfois que votre code devienne tellement complexe que le placer dans un unique fichier à importer n'a pas, non plus, beaucoup de sens!

Dans ce cas, vous pouvez scinder votre code en plusieurs fichiers et créer ce que l'on appelle un "Package" Python ("package" est un terme anglais que l'on traduit généralement par "paquet"). Les Package/Paquet rassemble tout le code ensemble en quelque-chose qui à un simple module que vos scripts peuvent importer. MicroPython supporte le concept de Package/Paquet Python comme le language Python standardiser. L'utilisation des Paquets/Packages permet d'offrir une meilleure structure à vos scripts et projets vraiment complexes.

Avant tout, assurez-vous d'avoir pris connaissance de la documentation officielle des packages/paquets Python (python.ord, anglais). les Paquets/Packages en MicroPython fonctionne, pour la plupart des cas, de la même façon qu'en Python.

Nous allons maintenant créer un paquet/package Python sur notre ordinateur. Créez un répertoire appelé test et ajoutez le fichier add.py à l'intérieur de celui-ci.

Dans le fichier add.py, ajoutez la fonction add tel que déclarée ci-dessous:

def add(a, b):
    return a + b

Créez aussi un fichier subtract.py dans le même emplacement et ajouter la fonction substract tel que déclarée ci-dessous:

def subtract(a, b):
    return a - b

Pour finir, créez un fichiez appelé __init__.py dans le même emplacement. Saisissez y le code suivant pour importer et exposer les fonctions des deux fichiers add.py et substract.py précédemment crées:

from test.add import add
from test.subtract import subtract

Soyez attentif, le fichier doit exactement s'appeler __init__.py! Python recherche ce nom de fichier pour savoir s'il s'agit d'un paquet/package. Si vous n'avez pas ce fichier ou s'il nest pas nommé correctement alors Python n'importera pas le paquet!

Le code à l'intérieur du fichier __init__.py est exécuté lorsque le paquet/package est importé par un script. Vous pouvez voir dans le code de __init__.py qu'il importe la fonction add depuis le fichier add.py (contenu dans le paquet/package) ainsi que la fonction substract contenu dans le fichier subtract.py.

Notez que l'instruction d'importation référence le fichier add.py en utilisant un "nom d'importation absolu". Par exemple, le fonction add est importée depuis test.add. Le 'test.' est le nom du paquet/package, par exemple: le nom du répertoire du paquet/package. Le 'add' derrière le 'test.add' est le nom du fichier python (add.py) où l'interpréteur Python trouvera la fonction à importer.

Suivant l'instruction from test.add import add, nous importons donc une fonction add depuis le fichier add.py se trouvant dans le répertoire "test" (comme stipulé par test.add).

Dans le script __init__.py, vous ne pourrez pas exécuter une commande tel que "from add import add" étant donné que cette instruction est totalement confuse pour Python. En effet, il essayera de charger la fonction add depuis le module add.py (le fichier add.py) se trouvant dans le même répertoire où est exécuté le script principal (comme expliqué en début de cette section). En utilisant le nom complet test.add nous indiquons à Python d'utiliser le fichier/module add.py à l'intérieur du répertoire paquet/package test .

Vérifiez que le paquet/package test soit confirme avec la structure suivant:

• Répertoire test
  • Le fichier __init__.py qui importe les fonctions add() et substract()
  • Le fichier add.py qui expose la fonction add()
  • Le fichier subtract.py qui expose la fonction subtract()

Essayez maintenant d'importer et d'utiliser le paquet/package avec la version PC de Python. Utilisez un terminal et naviguez jusqu'au répertoire parent du répertoire "test" contenant notre paquet/package (ex. le répertoire juste avant le répertoire "test"). Importer et utiliser un paquet/package se fait de façon identique à l'importation d'un fichier .py, cependant Python traitera le répertoire test entier comme le paquet/package lui-même. Cela signifie surtout que vous aurez besoin d'exécuter Python depuis le répertoire parent du répertoire "test" (et Python sera capable de trouver le paquet).

Assurez-vous de ne pas avoir un fichier test.py et un paquet/package (répertoire) test dans le même répertoire! Sinon Python ne s’emmêlera les pinceaux et importera le fichier/module test.py à la place du paquet/package "test". Effacez le fichier "test.py" s'il existe un paquet/package test dans le même répertoire!

Exécutez le code suivant dans une invite REPL de votre carte MicroPython pour importer et utiliser les fonctions add() et substract() disponibles dans le paquet/package:

import test
test.add(1, 1)
test.subtract(1, 1)

Crédit: AdaFruit Industries www.adafruit.com

Vous devriez pouvoir importer le paquet/package et les fonctions fonctionner exactement comme vu ci-dessus! Si vous constatez un message ImportError indiquant que le module n'existe pas alors vérifiez que vous exécutez bien Python depuis le répertoire parent de votre répertoire du paquet/package "test"!

Essayez maintenant de copier le paquet/package sur votre carte MicroPython et utilisez le exactement comme vous l'avez fait dans votre environnement PC. Encore une fois, assurez-vous qu'il n'y a pas de fichier test.py sur la carte sinon MicroPython ne saura pas lequel, du fichier "test.py" ou répertoire "test", il faudra importer le code! Si vous avez déjà un fichier test.py sur votre carte, vous pouvez l'effacer une utilisant une commande ampy comme celle-ci:

ampy --port /board/serial/port rm test.py

Créons maintenant la paquet/package test en créant le répertoire "test" à la racine du système de fichier:

ampy --port /board/serial/port mkdir test

Copions ensuite les 3 fichiers .py qui définissent le paquet/package (voir ci-dessus) à l'intérieur du répertoire "test" (donc à l'intérieur de notre paquet/package):

ampy --port /board/serial/port put __init__.py test/__init__.py
ampy --port /board/serial/port put add.py test/add.py
ampy --port /board/serial/port put subtract.py test/subtract.py

Ces commande copierons les fichiers .py dans le répertoire "test" du système de fichier de la carte MicroPython. Utilisez la commande ls pour vérifier la présence du répertoire test et qu'il contient les trois fichiers nécessaires:

ampy --port /board/serial/port ls test

Crédit: AdaFruit Industries www.adafruit.com

Connectez vous ensuite en REPL sur la carte et essayez d'importer le paquet/package test pour utiliser ses différentes fonctions (comme nous l'avons déjà fait):

import test
test.add(1, 1)
test.subtract(1, 1)

Crédit: AdaFruit Industries www.adafruit.com

Vous devriez voir le paquet/package s'importer et les fonctions fonctionner exactement comme c'était le cas avec le fichier test.py !

Subdiviser un module complexe en plusieurs fichiers contenu dans un packet/package est une bonne façon de simplifier la structure du code (et parfois le code lui-même). Dans cet exemple un peu simplicte nous avons déployé beaucoup de zèle (et de travail inutile). Dans le cas présent, le paquet/package est, au final, est "plus complexe" que le simple fichier "test.py". Le but est avant tout de comprendre le fonctionnement d'un paquet/package, chose que vous trouverez utile lorsque vous voudrez réutiliser du code, le partager, ou en réduire la complexité.

---

Source: MicroPython Basics: Loading Modules
Créé par Tony DiCola pour AdaFruit Industries.

Traduit par Meurisse D. pour MCHobby

Toute référence, mention ou extrait de cette traduction doit être explicitement accompagné du texte suivant : «  Traduction par MCHobby (www.MCHobby.be) - Vente de kit et composants » avec un lien vers la source (donc cette page) et ce quelque soit le média utilisé.

L'utilisation commercial de la traduction (texte) et/ou réalisation, même partielle, pourrait être soumis à redevance. Dans tous les cas de figures, vous devez également obtenir l'accord du(des) détenteur initial des droits. Celui de MC Hobby s'arrêtant au travail de traduction proprement dit.

Traduit avec l'autorisation d'AdaFruit Industries - Translated with the permission from Adafruit Industries - www.adafruit.com