Skip to main content

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ées
  • pipeline_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 requeue
  • NonRetryableError ou 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 :

  1. Parse le PipelineMessage entrant
  2. Lit les données OCR depuis le datalake
  3. Appelle l'extracteur spécialisé
  4. Écrit le résultat sur le datalake
  5. Publie un FusionMessage vers 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cezam_lib-0.1.19.tar.gz (105.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cezam_lib-0.1.19-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

Details for the file cezam_lib-0.1.19.tar.gz.

File metadata

  • Download URL: cezam_lib-0.1.19.tar.gz
  • Upload date:
  • Size: 105.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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

Hashes for cezam_lib-0.1.19.tar.gz
Algorithm Hash digest
SHA256 8c9b1dbfaa400fc7c9a65fd364fb2be93998469a18b9c271786cb02c61f34fd2
MD5 ff6777c0ea11afa4ce88b5678bb5ad2e
BLAKE2b-256 fb90a6df789872987a59628ac52a03b0739dbef6cad5cc4a40cef9df86b6c4e3

See more details on using hashes here.

File details

Details for the file cezam_lib-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: cezam_lib-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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

Hashes for cezam_lib-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 4f3baa19a5adcd4c9d51239689ff5551009a9280a3c787db5f6dc74b2f82f12c
MD5 1e69956641c4f10adab44f71649870a9
BLAKE2b-256 7484685d0a96c57ec350f6fcc3b8ee6bc10714c3de96840a824e70b0b0a4ad3b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page