Bibliothèque partagée pour les microservices CEZAM
Project description
cezam-lib
Bibliothèque partagée pour les microservices CEZAM. Ce package regroupe deux sous-packages sous un namespace unique cezam_lib :
cezam_shared— Clients d'infrastructure (MinIO, S3, RabbitMQ), configuration OpenTelemetry, et exceptions partagéespipeline_template— Classes de base pour construire des pipelines d'extraction spécialisés
Python >= 3.11 requis
Installation
# Avec uv (recommandé)
uv add cezam-lib
# Avec pip
pip install cezam-lib
Structure du package
cezam_lib/
├── __init__.py # __version__, __all__
├── cezam_shared/
│ ├── __init__.py # Exports publics
│ ├── minio_client.py # MinIOClient
│ ├── datalake_client.py # DatalakeClient
│ ├── source_client.py # SourceClient
│ ├── datalake_paths.py # Fonctions de chemins normalisés
│ ├── rabbitmq.py # RabbitMQPublisher, RabbitMQConsumer
│ ├── otel.py # setup_otel, inject/extract_trace_context
│ └── exceptions.py # MinIOError, RabbitMQError, etc.
└── pipeline_template/
├── __init__.py # Exports publics
├── base_pipeline.py # BasePipeline
├── extractor.py # DataExtractor (ABC)
└── messages.py # PipelineMessage, FusionMessage
Imports :
from cezam_lib.cezam_shared import MinIOClient, DatalakeClient, SourceClient
from cezam_lib.cezam_shared import RabbitMQPublisher, RabbitMQConsumer
from cezam_lib.cezam_shared import datalake_paths
from cezam_lib.cezam_shared import setup_otel
from cezam_lib.pipeline_template import BasePipeline, DataExtractor
from cezam_lib.pipeline_template import PipelineMessage, FusionMessage
Composants cezam_shared
MinIOClient
Client legacy pour les opérations JSON sur MinIO.
from cezam_lib.cezam_shared import MinIOClient
client = MinIOClient(
endpoint="localhost:9000",
access_key="minioadmin",
secret_key="minioadmin",
bucket="my-bucket",
)
client.put_json("path/to/doc.json", {"key": "value"})
data = client.get_json("path/to/doc.json")
exists = client.exists("path/to/doc.json")
files = client.list_prefix("path/to/")
DatalakeClient
Client S3 pour le bucket datalake avec préfixage automatique par environnement (lecture/écriture).
from cezam_lib.cezam_shared import DatalakeClient
client = DatalakeClient(
endpoint="s3.sbg.io.cloud.ovh.net",
access_key="key",
secret_key="secret",
bucket="datalake",
env_prefix="prod",
secure=True,
)
client.put_json("sim123/ocr/doc.json", {"text": "..."})
data = client.get_json("sim123/ocr/doc.json")
client.put_bytes("sim123/pages/page1.png", png_bytes)
raw = client.get_bytes("sim123/pages/page1.png")
SourceClient
Client S3 en lecture seule pour le bucket source de production.
from cezam_lib.cezam_shared import SourceClient
client = SourceClient(
endpoint="s3.eu-west-par.io.cloud.ovh.net",
access_key="key",
secret_key="secret",
bucket="source",
secure=True,
)
data = client.get_json("path/to/doc.json")
raw = client.get_bytes("path/to/file.pdf")
client.download_file("path/to/file.pdf", local_path)
datalake_paths
Fonctions pures de construction de chemins normalisés pour le datalake. Le préfixage par environnement est géré par DatalakeClient.
from cezam_lib.cezam_shared import datalake_paths
path = datalake_paths.original_path("sim123", "doc.pdf")
# → "sim123/original/doc.pdf"
path = datalake_paths.ocr_path("sim123", "doc.json")
# → "sim123/ocr/doc.json"
path = datalake_paths.pipeline_result_path("sim123", "ddp", "result.json")
# → "sim123/ddp/result.json"
RabbitMQPublisher
Publisher RabbitMQ avec propagation automatique du contexte OpenTelemetry.
from cezam_lib.cezam_shared import RabbitMQPublisher
with RabbitMQPublisher(
host="localhost", port=5672, user="guest", password="guest"
) as publisher:
publisher.publish(
exchange="",
routing_key="my_queue",
message={"simulation_id": "sim123", "status": "ready"},
)
RabbitMQConsumer
Consumer RabbitMQ avec gestion automatique des ack/nack et propagation OTel.
- Callback réussit → ack automatique
RetryableError→ nack avec requeueNonRetryableErrorou autre exception → nack sans requeue
from cezam_lib.cezam_shared import RabbitMQConsumer
def handle_message(message: dict) -> None:
print(f"Reçu: {message}")
with RabbitMQConsumer(
host="localhost", port=5672, user="guest", password="guest"
) as consumer:
consumer.consume(queue="my_queue", callback=handle_message)
Composants pipeline_template
BasePipeline
Classe de base abstraite pour les pipelines d'extraction spécialisés. Gère le flux complet :
- Parse le
PipelineMessageentrant - Lit les données OCR depuis le datalake
- Appelle l'extracteur spécialisé
- Écrit le résultat sur le datalake
- Publie un
FusionMessagevers la queue fusion
from cezam_lib.pipeline_template import BasePipeline, DataExtractor
from pydantic import BaseModel
class MyResult(BaseModel):
status: str
confidence: float
field_count: int
class MyExtractor(DataExtractor[MyResult]):
def extract(self, ocr_data: dict) -> MyResult:
return MyResult(status="SUCCESS", confidence=0.95, field_count=10)
pipeline = BasePipeline(
datalake_client=datalake_client,
publisher=publisher,
consumer=consumer,
extractor=MyExtractor(),
queue_name="my_pipeline",
pipeline_name="my_pipeline",
)
pipeline.run()
DataExtractor
Interface abstraite générique pour l'extraction de données depuis l'OCR. Les extracteurs concrets héritent de DataExtractor[T] et implémentent extract().
PipelineMessage / FusionMessage
Modèles Pydantic pour la communication inter-pipelines :
PipelineMessage— Message reçu du Doc Classifier (simulation_id, doc_name, document_type, ocr_json_path, etc.)FusionMessage— Message envoyé vers la queue Fusion avec les métriques d'extraction (status, quality, action, confidence_avg, etc.)
Exceptions
from cezam_lib.cezam_shared import (
MinIOError,
RabbitMQError,
RetryableError,
NonRetryableError,
)
| Exception | Usage |
|---|---|
MinIOError |
Erreur lors d'une opération S3/MinIO |
RabbitMQError |
Erreur lors d'une opération RabbitMQ |
RetryableError |
Erreur temporaire, le message sera requeue |
NonRetryableError |
Erreur définitive, le message est rejeté |
Configuration OpenTelemetry
from cezam_lib.cezam_shared import (
setup_otel,
inject_trace_context,
extract_trace_context,
)
# Initialiser OTel pour un service
tracer, meter = setup_otel(
service_name="doc_classifier",
otel_endpoint="localhost:4317",
)
# Propager le contexte de trace dans des headers
headers = {}
inject_trace_context(headers)
# Extraire et activer le contexte depuis des headers entrants
extract_trace_context(incoming_headers)
Développement local
# Installer les dépendances (dev inclus)
uv sync
# Lancer les tests
uv run pytest
# Tests avec couverture
uv run pytest --cov=cezam_lib tests/
# Linting
uv run ruff check src/ tests/
Licence
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cezam_lib-0.1.12.tar.gz.
File metadata
- Download URL: cezam_lib-0.1.12.tar.gz
- Upload date:
- Size: 99.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c78eb4bae4206c0a3614bddbd1e0b4a2d5b97e786ac33df92a4d1aa833fcaf08
|
|
| MD5 |
fb09b1598671fdb4cbf0c693cac2de2c
|
|
| BLAKE2b-256 |
15a79079d2374f9dd0911c93f91d0f82a41aa982c4722f6cdac675f4f6f773a4
|
File details
Details for the file cezam_lib-0.1.12-py3-none-any.whl.
File metadata
- Download URL: cezam_lib-0.1.12-py3-none-any.whl
- Upload date:
- Size: 22.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7a86f939d3999c5e88129fddaf28b4046283639c105c09c21ec94b9f679c903
|
|
| MD5 |
1a2443b4e3f23f0bd0d3f4fb66511533
|
|
| BLAKE2b-256 |
7e2d1c05923612b0d4bbf2276005c35ad024c164a3735e1c9e3f6c880e1aeab5
|