test_cicd_doc_example package

Submodules

test_cicd_doc_example.drone module

Module pour l’interfaçage avec un drone.

Ce module fournit une interface pour contrôler un drone et effectuer des opérations basiques comme prendre des photos ou enregistrer des vidéos.

class test_cicd_doc_example.drone.Drone(drone_hardware)

Bases: object

Classe pour contrôler un drone.

Attributes

drone_hardwareobject: Interface de communication avec le drone (API hardware).
is_flyingbool: Indique si le drone est actuellement en vol.

land() → bool

Fait atterrir le drone.

Pre:: self.is_flying == True
Post[self]:: self.is_flying == False

Returns

bool: True si l’atterrissage est réussi, False sinon.

move_forward(distance: float) → bool

Fait avancer le drone.

Pre:: self.is_flying == True
Pre:: distance > 0
Post:: __return__ == True

Parameters

distancefloat: Distance à parcourir en mètres.

Returns

bool: True si le mouvement est réussi, False sinon.

Raises

RuntimeError: Si le drone n’est pas en vol.

record_video(duration: int) → dict

Enregistre une vidéo.

Pre:: self.is_flying == True
Pre:: duration > 0
Post:: __return__[“status”] == “success”
Post:: __return__[“duration”] == duration

Parameters

durationint: Durée de l’enregistrement en secondes.

Returns

dict: Dictionnaire contenant les informations de la vidéo.

Raises

RuntimeError: Si le drone n’est pas en vol.

rotate(angle: float) → bool

Fait tourner le drone.

Pre:: self.is_flying == True
Pre:: -360 <= angle <= 360
Post:: __return__ == True

Parameters

anglefloat: Angle de rotation en degrés.

Returns

bool: True si la rotation est réussie, False sinon.

Raises

RuntimeError: Si le drone n’est pas en vol.

take_off() → bool

Fait décoller le drone.

Pre:: self.is_flying == False
Post[self]:: self.is_flying == True

Returns

bool: True si le décollage est réussi, False sinon.

take_photo() → dict

Prend une photo avec la caméra du drone.

Pre:: self.is_flying == True
Post:: __return__[“status”] == “success”

Returns

dict: Dictionnaire contenant les informations de la photo.

Raises

RuntimeError: Si le drone n’est pas en vol.

test_cicd_doc_example.palindrome module

Module pour vérifier si une chaîne est un palindrome.

test_cicd_doc_example.palindrome.get_palindrome_from_api() → str

Récupère une chaîne depuis une API externe (exemple pour le mocking).

Returns

str: Une chaîne de caractères depuis l’API.

test_cicd_doc_example.palindrome.is_palindrome(text: str) → bool

Vérifie si le texte est un palindrome.

Un palindrome est une chaîne qui se lit de la même façon de gauche à droite et de droite à gauche, en ignorant les espaces et la casse.

Parameters

textstr: La chaîne à vérifier.

Returns

bool: True si c’est un palindrome, False sinon.

Examples

>>> is_palindrome("radar")
True
>>> is_palindrome("kayak")
True
>>> is_palindrome("bonjour")
False
>>> is_palindrome("a b a")
True

Module contents

Module de source principal.

class test_cicd_doc_example.Drone(drone_hardware)

Bases: object

Classe pour contrôler un drone.

Attributes

drone_hardwareobject: Interface de communication avec le drone (API hardware).
is_flyingbool: Indique si le drone est actuellement en vol.

land() → bool

Fait atterrir le drone.

Pre:: self.is_flying == True
Post[self]:: self.is_flying == False

Returns

bool: True si l’atterrissage est réussi, False sinon.

move_forward(distance: float) → bool

Fait avancer le drone.

Pre:: self.is_flying == True
Pre:: distance > 0
Post:: __return__ == True

Parameters

distancefloat: Distance à parcourir en mètres.

Returns

bool: True si le mouvement est réussi, False sinon.

Raises

RuntimeError: Si le drone n’est pas en vol.

record_video(duration: int) → dict

Enregistre une vidéo.

Pre:: self.is_flying == True
Pre:: duration > 0
Post:: __return__[“status”] == “success”
Post:: __return__[“duration”] == duration

Parameters

durationint: Durée de l’enregistrement en secondes.

Returns

dict: Dictionnaire contenant les informations de la vidéo.

Raises

RuntimeError: Si le drone n’est pas en vol.

rotate(angle: float) → bool

Fait tourner le drone.

Pre:: self.is_flying == True
Pre:: -360 <= angle <= 360
Post:: __return__ == True

Parameters

anglefloat: Angle de rotation en degrés.

Returns

bool: True si la rotation est réussie, False sinon.

Raises

RuntimeError: Si le drone n’est pas en vol.

take_off() → bool

Fait décoller le drone.

Pre:: self.is_flying == False
Post[self]:: self.is_flying == True

Returns

bool: True si le décollage est réussi, False sinon.

take_photo() → dict

Prend une photo avec la caméra du drone.

Pre:: self.is_flying == True
Post:: __return__[“status”] == “success”

Returns

dict: Dictionnaire contenant les informations de la photo.

Raises

RuntimeError: Si le drone n’est pas en vol.

test_cicd_doc_example.is_palindrome(text: str) → bool

Vérifie si le texte est un palindrome.

Un palindrome est une chaîne qui se lit de la même façon de gauche à droite et de droite à gauche, en ignorant les espaces et la casse.

Parameters

textstr: La chaîne à vérifier.

Returns

bool: True si c’est un palindrome, False sinon.

Examples

>>> is_palindrome("radar")
True
>>> is_palindrome("kayak")
True
>>> is_palindrome("bonjour")
False
>>> is_palindrome("a b a")
True