Bonjour les développeurs,

Je démarres ce fil de discutions afin d'essayer de regrouper ici un maximum d'exemple de code plus communément appelé code Snippet dans le monde des développeurs.

Ce message de têtes servira de sommaire avec un lien sur des Code Snippets, soit dans ce fil, soit dans un fil séparé.

Merci de soumettre tous les Code Snippets que vous jugerez utiles en précisant a quoi le Snippet s'applique:

- généralités
- spécifique aux scripts
- spécifique aux plugins




Généralités:

• Changements concernant Python dans Xbmc survenus depuis les version Beta


• Récupérer le chemin courant d'un script ou plugin


• Gérer les chemins dans XBMC


• Télécharger des images (ou un fichier) via HTTP


• Commenter un script pour en obtenir une documentation


• Utiliser la BDD de xbmc dans un script


• Comment gérer des noms de fichiers unicode


• Switch case en Python: voici quelques méthodes pour recréer un 'switch case' en Python alors que cela ne fait pas parti du langage


• Obtenir un screenshot (jpg) d'un site web: un petit exercice par Alexsolex


• Utiliser la lib shutil pour copier un dossier


• Les dictionnaires: Un petit cours sur les dictionnaires par Alexsolex


• Utiliser le clavier virtuel dans un script (ou plugin)


• Utilisation des threads pour partager le téléchargement de plusieurs fichiers


• Ajouter un élément au menu contextuel dans les listes (listitem)


• Réimporter un module


• Comment importer un un module (fichier .py) dans un sous-répertoire : par Alexsolex


• Comment importer un module via une variable: par Alexsolex


• Comment mettre de la vie dans un texte (couleur, gras, italique): par Frost


• Lancer une application externe dans XBMC: par Frost
• 
  Forcer le loglevel depuis un script ou un plugin: par Alexsolex


• Déterminer la plate-forme sur laquelle XBMC tourne: par Frost


• Utiliser 'special://'  dans un chemin: par Frost


• Minimiser XBMC: par Frost


• Minimiser XBMC (Méthode simple): par Frost


• Détruire tous les sous répertoires .svn d'un répertoire donné: par Seb


• Remplacer un mot en masse dans un fichier: par Frost


• Découper une liste en plusieurs partie égal: par Frost


• Parser un XML: par Temhil

Scripts:


Plugins:

• Ajout de la fonction setPluginCategory(), visible en haut à droite: par Frost


• Support du fanart dans un plugin: par Frost


• Plugins pour lancer un script: par Alexsolex


• Utiliser SetResolveUrl dans un plugin: par Temhil

Autres sources de code-snippet indispensables:

• sebsauvage.net - Python snippets


• PLEAC-Python


• ActiveState Python recipes


• Life is short - you need Python!


• zone.effbot.org

On commence avec les plugins par un exemple donne par FrostBox (merci a lui) dans ce FIL
Il nous montre comment grandement améliorer la presentation d'un plugin dans XBMC en ultisant l'affichage d'information sur le plugin mais aussi le fanart en image de fond (cf. image ci-dessous)




Ajout de la fonction setPluginCategory(), visible en haut à droite (image ci-dessous):

Code: (python) [Sélectionner]

import sys
import xbmcplugin
xbmcplugin.setPluginCategory( handle=int( sys.argv[ 1 ] ), category="LA CATÉGORIE DU PLUGIN" )

Support du fanart dans un plugin(cf. image ci-dessous):

Code: (python) [Sélectionner]

import sys
import xbmcplugin
#la couleur doit etre en (AARRGGBB), mais peut etre vide
path_img = "mon image"
fanart_color1 = ""
fanart_color2 = ""
fanart_color3 = ""
xbmcplugin.setPluginFanart( handle=int( sys.argv[ 1 ] ), image=path_img, color1=fanart_color1, color2=fanart_color2, color3=fanart_color3 )

Pour plus regardez le module xbmcplugin :grin:

Note: Le skin utilisé doit avoir ce support, aussi ajoutez un try: except: au cas ou


Et voici le résultat:



[edit]

• Ajout import sys manquant


• Correction de fautes

  Récupérer le chemin courant d'un script ou plugin


Maintenant voyons comment Récupérer le chemin courant d'un script ou plugin:

Code: (python) [Sélectionner]

import os

############################################################################
# Get current working directory and update internal vars with it  
############################################################################

# Set paths
ROOTDIR = os.getcwd().replace( ";", "" ) # Create a path with valid format

IMAGEDIR    = os.path.join(ROOTDIR, "images")
CACHEDIR    = os.path.join(ROOTDIR, "cache")
DOWNLOADDIR = os.path.join(ROOTDIR, "download")
LIBDIR      = os.path.join(ROOTDIR, "lib")

Note: Notez le replace( ";", "" ) dans la 1ere ligne, celui permet d'avoir un script compatible avec XBMC pre et post Beta1 car os.getcwd() a été modifié pour la Beta1


Gérer les chemins dans XBMC
Afin de vous assurer d'écrire un script qui sera compatible sur toutes les platformes (Windows, XBOX, Linux, Mac), il est preferable d'utliser fonction os.path.join afin de creer une chemins:

Code: (python) [Sélectionner]

os.remove(os.path.join(DOWNLOADDIR, filename))

Eviter les notations avec une combinaison de '+' et des separateurs '/' ou '\\' selon l'OS.
Toutefois si vous n'avez pas le choix, utilisez os.sep comme séparateur.

  Télécharger des images (ou un fichier) via HTTP

Voici une fonction vous permettant de recuperer des images (ou un fichier quelconque)

Code: (python) [Sélectionner]

import urllib
import os.path

def downloadJPG(source, destination):
    """
    Source MyCine (thanks!)
    Download IF NECESSARY a URL 'source' (string) to a URL 'target' (string)
    Source is downloaded only if target doesn't already exist
    """
    if os.path.exists(destination):
        pass
    else:
        try:
            #print("downloadJPG destination doesn't exist, try to retrieve")
            loc = urllib.URLopener()
            loc.retrieve(source, destination)
        except Exception, e:
            print("Exception while source retrieving")
            print(e)
            print (str(sys.exc_info()[0]))
            traceback.print_exc()
            pass

Note:

• Vous noterez dans cette implémentation que si le fichier est déjà present localement, il n'est pas téléchargé


• Bien que cette fonction vous permette de recuperer un fichier de taille quelconque, pour un fichier de taille plus grande il est preferable d'utiliser une implémentation avec une barre de progression.

Salut bonne idée ça  :smiley:

Mais faudrais pas reproduire mes fautes ou en mettre de plus 

- regardex == regardez

- et j'ai rajouter un import sys dans mon exemple pour alex désoler avait oublié  :embarrassed:

Code: (python) [Sélectionner]

#Code générale pour imprimer

print "ok ok je sors"

joke inside
frost

En effet j'avais copie/coller  , je viens de corriger cela dans le post. merci

  Utiliser la BDD de xbmc dans un script

Voici un exemple d'acces a la BD de XBMC et d'une requete SQL sur cette BD.
Pour ce faire on utilise le module sqlite3

Merci a Seb pour cet exemple, vous trouverez plus d'informations dans le topic d'origine: Utiliser la BDD de xbmc dans un script

Code: (python) [Sélectionner]

import os
home = os.getcwd().replace(';','')
lib = os.path.join(home, 'sqlite3')
sys.path.append(lib)
import sqlite3
 
conn = sqlite3.connect('/home/seb/.xbmc/userdata/Database/MyVideos34.db')
c = conn.cursor()
 
c.execute('select * from movie')
for champ in c:
    print champ

  Switch case en Python
Voici deux différentes méthodes permettant de recréer un 'switch case' en Python qui n'est pas supporté nativement par celui-ci


1ere méthode: lambdas

Source: Simon Willison's Weblog 

Cette solution est proposée par Simon Willison. Son idée est d'utiliser les lambdas pour recréer les mécanismes du 'switch case' sous la forme:

Code: (python) [Sélectionner]

{'option1': function1,
 'option2': function2,
 'option3': function3,
 'option4': function4}[value]()

Ainsi le code PHP suivant:

Code: (php) [Sélectionner]

switch ($value) {
    case 'a':
        $result = $x * 5;
        break;
    case 'b':
        $result = $x + 7;
        break;
    case 'c':
        $result = $x - 2;
        break;
}

Serait traduit en python avec sa méthode comme cela:

Code: (python) [Sélectionner]

result = {
  'a': lambda x: x * 5,
  'b': lambda x: x + 7,
  'c': lambda x: x - 2
}[value](x)

2eme méthode: Orienté Objet et dictionnaires

Source: Well House

Ici on exploite les mecanisme Objets de Python associés aux dictionnaires:

Code: (python) [Sélectionner]

""" There is no switch or case in Python ... because you can
do better by using its OO capabilities and a dictionary. """

def doblue (): print "The sea is blue"
def dogreen (): print "Grass is green"
def doyellow (): print "Sand is yellow"

def redflag ():
   print "Red is the colour of fire"
   print "do NOT play with fire"

def errhandler ():
   print "Your input has not been recognised"

# set up a dictionary of actions

takeaction = {
    "blue": doblue,
    "green": dogreen,
    "yellow": doyellow,
    "red": redflag}

colour = raw_input("Please enter red blue green or yellow ")
takeaction.get(colour,errhandler)()

# Uses the get method to allow us to specify a default

  Plugins pour lancer un script

Merci a Alexsolex pour ce snippet. Vous retrouverez le message original ICI

Résumé:
Pour lancer un script il faut vous rendre en section script. Mais pour lancer un plugin, il faut vous rendre dans la section multimédia concernée par le plugin en question (par exemple fichier/videos/images/musique)
C'est là que ca devient intéressant car un des atouts majeurs pour le plugin est de pouvoir le lancer depuis la section de votre choix. Mais ensuite.... Rien ne vous interdit de lancer un script par la méthode des plugins !!
Ainsi, et en guise d'exemple, si vous avez un script qui est en rapport avec les videos... disons installeur-passion, il vous suffit de faire un plugin comme suit :

Code: (python) [Sélectionner]

import xbmc
 
xbmc.executescript('q:\\scripts\\Installeur-Passion\\default.py')

Le résultat ? après des comportements bizarres du genre "impossible de se connecter au serveur" proposés par le système xbmc de plugin je pense, le script démarre et fonctionne, sans aucune autre modification de votre part !

  Utiliser la lib shutil pour copier un dossier

Merci a Alexsolex pour ce snippet. Vous retrouverez le message original ICI

Code: (python) [Sélectionner]

import shutil
source="q:\skins\monskin\"
destination = "q:\skins\monskin_bak\
try:
    shutil.copytree(source, destination)
except:
    print "oups ! problème !!"

Lien vers la documentation shutil: http://pydoc.org/2.4.1/shutil.html

  Les dictionnaires

Un petit cours sur les dictionnaires par Alexsolex. Vous retrouverez le message original ICI



Petite précision, les dictionnaires ne sont utiles que si on besoin de les référencer par un 'pointeur'.
Ils sont très pratiques dès lors qu'on a plusieurs infos à mémoriser pour une entrée
Imaginons un carnet d'adresse qui référence pour un utilisateur son téléphone et sa ville :

Code: (python) [Sélectionner]

coordonnees= {
                 "alexsolex" : ("0123456","paris") ,
                 "toto" : ("0234198548","Babeloued") ,
                 "bernard" : ("8765321","moscou")
                   }

Ca veut dire que l'élément "alexsolex" de mon carnet est égal à un tuple ("0123456","paris").

Code: (python) [Sélectionner]

print coordonnees["alexsolex"]
>>> ("0123456","paris")
tel,ville = coordonnees["alexsolex"]
print tel
>>> 0123456
print ville
>>> paris

mais le tuple peut être lu par un pointeur de liste numérique :

Code: (python) [Sélectionner]

user = coordonnees["alexsolex"]
print user[0]
>>> 0123456
print user[1]
>>> paris

ou encore

Code: (python) [Sélectionner]

print coordonnees["alexsolex"][0]
>>> 0123456
print coordonnees["alexsolex"][1]
>>> paris

Si on veut ordonner les entrées de la liste pour un affichage par exemple :

Code: (python) [Sélectionner]

listenoms = coordonnees.keys() #on prend les clés du dictionnaire (les noms)
listenoms.sort() #on trie sur place la liste (elle se réaffecte d'elle même avec les entrées triées)
for nom in listenoms:
    print "%s\n\ttél: %s\n\tville: %s" % (nom, coordonnees[nom][0], coordonnees[nom][1])

ca donne :

Code: [Sélectionner]

alexsolex
    tél: 0123456
    ville: paris
bernard
    tél: 8765321
    ville: moscou
toto
    tél: 0234198548
    ville: Babeloued

ATTENTION, un dictionnaire ne respecte pas l'ordre dans lequel tu le remplis.
Par exemple si tu rentres A, B puis C dans le dictionnaire dans t ordre, il se peut que tu obtiennes les clés dans un ordre tout différent (B, C et A par exemple) C'est pour cela qu'il faut souvent passer par les clés lorsqu'on veut les afficher ou les utiliser

Les listes (comme les tuples) préservent l'ordre dans lequel elles ont été alimentées. Ainsi si tu mets C, B puis A dans ta liste, tu auras toujours les éléments dans le même ordre : C, B et A

Les listes sont pointables par un entier :

Code: (python) [Sélectionner]

maliste = [ "bonjour" , 123, 45.0045, mafonction]
print maliste[1]
>>> 123

Vous remarquerez au passage une intéressante propriété des listes (et des tuples et des dictionnaires aussi d'ailleurs), vous y mettez ce que vous voulez dedans !!! Vous pouvez ainsi ainsi mettre des listes dans des dictionnaires, des tuples dans des listes, des dictionnaires dans des tuples etc etc ...

  Utiliser le clavier virtuel dans un script (ou plugin)

- Saisie de texte

Code: (python) [Sélectionner]

from string import *
import xbmcgui

# Recuperation d'un texte via la clavier virtuel
keyboard = xbmc.Keyboard("", heading = "Saisir votre Texte")
keyboard.setHeading('Texte a saisir') # En tete
keyboard.setDefault("Mon texte par defaut") # Texte par defaut qui sera deja affiche a la saisie
keyboard.doModal()
if (keyboard.isConfirmed()):
    inputText = keyboard.getText()
    print"Login: %s"%inputText
    
    # on fait ce que l'on veut avec le texte saisi
    # ...
    
    dialogInfo = xbmcgui.Dialog()
    dialogInfo.ok("Texte saisi", "Votre texte est:", "%s"%inputText)
del keyboard

- Saisie d'un mot de passe (caché a l'écran)

Code: (python) [Sélectionner]

from string import *
import xbmcgui

# Recuperation d'un mot de passe via la clavier virtuel
keyboard = xbmc.Keyboard("", heading = "Saisir votre Mot de passe", hidden = True)
keyboard.setHeading('Mot de passe') # En tete
keyboard.setHiddenInput(True) # On cache le texte a l'ecran
keyboard.doModal()
if (keyboard.isConfirmed()):
    inputText = keyboard.getText()
                            
    # on fait ce que l'on veut avec le mot de passe saisi
    # ...
                            
    dialogInfo = xbmcgui.Dialog()
    dialogInfo.ok("Mot de passe", "Votre mot de passe a bien été défini")
keyboard.setHiddenInput(False) # optional
del keyboard

Bonjour

J'ai trouvé et utilisé avec grand succès la technique qui va suivre pour accélérer notablement les temps de téléchargement d'une liste de fichiers.

Utilisation des threads pour partager le téléchargement de plusieurs fichiers :
Astuce trouvée sur le forum développez.net

Code: (python) [Sélectionner]

from urllib import urlopen
import threading
from Queue import Queue, Empty
from time import time
 
NUM_THREADS = 40
start = time()
q_in = Queue(0)
q_out = Queue(0)
 
# on remplit q_in avec les url (ici c'est juste un exemple pour tester)
for i in xrange(400):
    q_in.put("http://www.pythonchallenge.com/pc/def/linkedlist.php?nothing=%d" % i)
 
def getfiles():
    # fonction exécutée par les threads
    # ici je me contente de sauver le contenu avec l'url dans q_out
    try:
        while True:
            url = q_in.get_nowait()
            f = urlopen(url)
            q_out.put((url,f.read()))
            f.close()
    except Empty:
        # q_in est vide; on a terminé
        pass
 
# on crée et on démarre les threads
for i in xrange(NUM_THREADS):
    t = threading.Thread(target = getfiles)
    t.start()
 
count = 0
# tant qu'il y a des threads actifs ou des résultats disponibles
while threading.activeCount() > 1 or not q_out.empty():
    try:
        # on retire les résultats de la queue
        # on attend au plus 500 ms si la queue est vide
        # le timeout est nécessaire pour éviter une race condition
        url, contents = q_out.get(True, 0.5)
        count += 1
        print url, ':', contents
    except Empty:
        pass
 
print "%d fichiers récupérés en %f secondes" % (count, time() - start)
 

  Ajouter un élément au menu contextuel dans les listes (listitem)

Merci a Alexsolex pour ce snippet. Vous retrouverez le message original ICI


Si vous avez consulté la doc de la librairie xbmcgui, vous aurez peut être constaté qu'une méthode permet d'ajouter des éléments au menu contextuel d'un objet 'ListItem'.
J'ai déjà dit moi même dans ce forum que cela ne fonctionnait pas, mais j'en ai trouvé la cause. La doc a une erreur de syntaxe il manque un s au nom de la méthode (addContextMenuItems)
Voici l'élément de la doc qui est erroné et corrigé par votre serviteur : ( http://xbmc.sourceforge.net/python-docs/xbmcgui.html#ListItem-addContextMenuItem )

Code: [Sélectionner]

addContextMenuItems(...)
    addContextMenuItems([(label, action,)*]) -- Adds item(s) to the context menu for media lists.
     
    [(label, action,)*] : list - A list of tuples consisting of label and action pairs.
      - label           : string or unicode - item's label.
      - action          : string - any built-in function to perform.
     
    List of functions - http://xbmc.org/wiki/?title=List_of_Built_In_Functions 
     
    example:
      - listitem.addContextMenuItems([('Theater Showtimes', 'XBMC.RunScript(q:\\scripts\\showtimes\\default.py,Iron Man)',)])

Cette petite correction faite, je pense que bon nombre de développeurs seront intéressé !!! Et moi le premier !
J'ai effectué un test dans un plugin où j'ai rajouté ceci :

Code: (python) [Sélectionner]

listitem.addContextMenuItems([("test","XBMC.ReloadSkin()",)])

et ca fonctionne tiptop

Note: Ce snippet est aussi bien pour les scripts que les plugins, mais n'a été testé pour le moment que sur les plugins.

  Réimporter un module

Voici deux exemples si on veut réimporter un module (utilise si on a change le fichier en cours de route) (il y a certainement d'autre moyens):

Code: (python) [Sélectionner]

if sys.modules.has_key("Module"):
    reload(Module)
else:
    import Module

Ou encore mieux (merci a Alexsolex):

Code: (python) [Sélectionner]

if sys.modules.has_key("monmodule"):
    del sys.modules["monmodule"]
import monmodule

[edit]
Remplacement de la 2eme solution (qui ne marche apparemment pas) et remplacement par une bien meilleur solution proposée par Alexsolex

hum
Il me semble que la 2ieme solution ne fonctionne pas.

Si on a modifié le module importé le script ne prendra pas en compte les modifications même malgré un simple del module.

Pour ma part le résultat le meilleur constaté est comme suit :

Code: (python) [Sélectionner]

if sys.modules.has_key("monmodule"):
    del sys.modules["monmodule"]
import monmodule

Merci, je supprime donc la 2eme solution du post  :smiley:

Merci a Alexsolex pour ces snippets. Vous retrouverez le message original ICI

Comment importer un un module (fichier .py) dans un sous-répertoire

Il s'agit en fait d'ajouter un chemin pour recherche pour les librairies avec le module sys

Par exemple si vous voulez importer le fichier :
\passion-XBMC\divers\lib\passion.py

Faites :

Code: (python) [Sélectionner]

CHEMIN_LIB = "q:\scripts\passion-XBMC\divers\lib\"
import sys
sys.path.append(CHEMIN_LIB)

#maitenant python cherchera aussi dans ce chemin pour y trouver les libs que tu demandes et donc :
import passion #fonctionne normalement

Comment importer un module via une variable

Code: (python) [Sélectionner]

mon_module_import = "passion"
exec("import %s"%mon_module_import)

_{a noter que je ne sais plus si exec est une commande python ou si ca dépend d'un module mais je pense que c'est intégré}

Voila suite à une demande...

Mettre de la vie dans un texte d'XBMC

Code: (python) [Sélectionner]

#Comment mettre de la couleur dans un texte.
#note: les couleurs du themes en fonction peut etre utiliser. \skin\PM3.HD\colors\defaults.xml 
#<color name="green">ffe2ff43</color>  qui nous donnent print "[COLOR=green"]MOT QUI VA ETRE EN VERT[/COLOR]"
#remarque qu'au changement de themes on risque de perdre notre couleur qui est déffinie
#Le mieux est de faire print "[COLOR=ffe2ff43]MOT QUI VA ETRE EN VERT[/COLOR]"

red_color = "FFFF0000"
text_color = "Rouge"

label_formatting = "[COLOR=%s]%s[/COLOR]" % ( red_color, text_color, )
print label_formatting

text = "le feu de circulation est rouge, il faut attendre le feu vert."
text = text.replace( "rouge", label_formatting )

#pourquoi pas en faire un autre 
text = text.replace( "vert", "[COLOR=ffe2ff43]vert[/COLOR]" )
print text


# Encore plus mettre un mot en gras ou en italic 
print "[B]bold[/B] - bold text."
print "[I]italics[/I] - italic text."

# Plus sur le label formatting visite le manuel xbmc: http://xbmc.org/wiki/?title=Label_Formatting

Plus sur le label formatting visite le manuel xbmc: http://xbmc.org/wiki/?title=Label_Formatting

[edit]
- ajouter: lien sur les infos du Label_Formatting en dehors du code python

Super snippet je n'avais aucune idée que XBMC supportait cela, ou vas tu chercher tout cela???