[Feature] Add an extensible file-format provider contract to PyPaimon

Ouverte
#9,656 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
Active
Stack technique
python

Piste de recherche

Commencez par lire paimon-python/pypaimon/read/split_read.py et paimon-python/pypaimon/write/writer/data_writer.py afin de comprendre les branches actuelles du dispatch. Examinez ensuite les issues #6739 et #8049 ainsi que la PR #8292 pour prendre connaissance des contraintes pertinentes de format et de packaging. L’issue ne sera prête à être implémentée qu’après que les maintainers auront décidé de la délimitation de l’extension, du modèle d’enregistrement et de la nécessité ou non d’un PIP.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Search before asking
  • I searched in the issues and found nothing similar.
Motivation

PyPaimon currently selects readers and writers with built-in if/elif branches. New formats such
as Lance and Mosaic have therefore been integrated directly into the PyPaimon package. This works
well for formats that the project wants to support and release as built-ins, but there is no stable
extension boundary for a deployment-specific format or for an embedding runtime that supplies its
own implementation.

Java Paimon already discovers FileFormatFactory implementations. I also noticed that Java PR
#8292 proposed another runtime-side FileFormatProvider and was closed because an execution engine
could provide that SPI in its own integration. PyPaimon is itself the SDK/runtime that performs the
format dispatch, so an embedding application cannot add a format without patching that dispatch.

Would the community consider a small PyPaimon extension contract, or is built-in-only format
support the intended boundary?

Solution

A possible contract would have these properties:

  1. Table metadata stores only an immutable, language-neutral format identifier, never a Python
    module or class name.
  2. A provider declares read and write capabilities independently and receives public context
    objects rather than PyPaimon writer implementation details.
  3. Registration is explicit and deterministic. Python package entry points may be an optional
    discovery mechanism, but duplicate identifiers fail rather than depend on import order.
  4. A missing provider fails during planning with a clear diagnostic. It never falls back to a
    different physical format.
  5. Packaging and distribution to remote workers remain the responsibility of the embedding engine;
    the table does not persist package locations.
  6. The extension API has a small version/capability handshake so a provider developed against one
    PyPaimon release does not silently run with incompatible context objects.

The minimum API could be an explicit registry such as
register_file_format(identifier, provider). Entry-point discovery can be considered separately
after the packaging work in #8049 is settled.

Questions:

  • Is third-party format discovery in scope for PyPaimon?
  • If so, would maintainers prefer an explicit registry, Python entry points, or an embedding-runtime
    hook?
  • Should the first version expose read-only providers before defining writer and abort semantics?
  • Would this public extension contract require a PIP before a prototype PR?
Anything else?

Relevant code and discussions:

Are you willing to submit a PR?
  • I'm willing to submit a PR!

I can contribute a minimal read-only prototype with an out-of-tree example provider and tests for
duplicate registration, missing providers, capability checks, and distributed-worker loading after
the preferred boundary is clear.

Langage dominant
Java
Étoiles
3.4k
Forks
1.4k
Merge moyen
1 j 14 h
PR mergées (30 j)
468

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de apache/paimon

Toutes les issues de apache/paimon

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.