Registre
QiliSDK informa del que està fent mitjançant Loguru. El registre es configura automàticament en importar el paquet i es pot ajustar en qualsevol moment mitjançant configure_logging().
Per defecte només es mostren els missatges de nivell WARNING o superior, i s’escriuen a la consola (stderr).
Canviar el nivell de detall
Crida configure_logging() amb un level per sobreescriure el nivell de detall:
from qilisdk import configure_logging
configure_logging(level="DEBUG")
La resta d’opcions dels sinks configurats (format, filtre, colors, …) es conserven, de manera que només canvia el llindar. Tornar-la a cridar reemplaça la configuració anterior, així que preval l’última crida.
Registre en un fitxer
Passa un filename per copiar la sortida de la consola en un fitxer de text:
from qilisdk import configure_logging
# Console and file
configure_logging(level="TRACE", filename="run.log")
# File only, no console output
configure_logging(level="TRACE", filename="run.log", stderr=False)
Nivells de registre
QiliSDK utilitza els nivells estàndard de Loguru, cadascun amb la seva pròpia icona:
Nivell |
Icona |
Significat |
|---|---|---|
|
🔬 |
Informació molt detallada, normalment útil només quan s’escriu en un fitxer. |
|
🐞 |
Informació destinada a desenvolupadors, dissenyada per no inundar el terminal durant un flux de treball normal. |
|
💡 |
Informació destinada a usuaris, dissenyada per no inundar el terminal durant un flux de treball normal. |
|
✅ |
Missatges que indiquen que una operació s’ha completat correctament. |
|
🚧 |
Aspectes a tenir en compte, com ara que s’ignori un paràmetre. Aquest és el llindar per defecte. |
|
❌ |
Errors. S’usen poques vegades, ja que QiliSDK llança excepcions en el seu lloc. |
|
💀 |
Errors crítics. S’usen poques vegades, pel mateix motiu. |
Personalitzar la configuració
Els sinks es descriuen en un fitxer YAML. El que ve amb el paquet es troba al costat del codi font del mòdul logging i té aquest aspecte:
sinks:
- sink: stderr
level: WARNING
format: "QiliSDK | <green>{time:YYYY-MM-DD at HH:mm:ss}</green> | <lvl>{level: <8}</> | <lvl>{level.icon} {message}</>"
filter: qilisdk
colorize: true
intercept_libraries:
- name: httpx
level: ERROR
Per usar el teu propi fitxer, apunta l’opció QILISDK_LOGGING_CONFIG_PATH cap a ell abans d’importar QiliSDK.