pyprocessors-coreference 1.6.3__tar.gz → 1.6.8__tar.gz

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/.gitignore

@@ -29,3 +29,6 @@ uv.lock
 # audit-report.md non suivi qui traine apres chaque 'task'. Meme correctif a y
 # porter -- c'est du ressort de check-plugin-drift.
 **/audit*.md
+
+# Exemples des pages d aide Sherpa, enregistres par les tests
+build/

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyprocessors-coreference
-Version: 1.6.3
+Version: 1.6.8
 Summary: Processor grouping the mentions of the same entity
 Project-URL: Homepage, https://bitbucket.org/kairntech/pyprocessors_coreference
 Author-email: Olivier Terrier <olivier.terrier@kairntech.com>

pyprocessors_coreference-1.6.8/docs/sherpa/coreference.en.md

@@ -0,0 +1,55 @@
+# coreference Processor (`coreference`)
+
+<!-- To write: what the plugin does, in one sentence, with a concrete example in quotes. -->
+
+## When to use it
+
+<!-- To write: two or three situations, in the words of a Sherpa user (project, corpus, search), not in the words of the code. -->
+
+## When not to use it
+
+<!-- To write: what the plugin does not do although one might expect it to, and which other plugin does. -->
+
+## Prerequisites
+
+<!-- To write: what the plugin expects as input (document language, sentence segmentation, annotations from another plugin…), required or recommended, and why. -->
+
+<!-- generated:languages -->
+
+**Supported languages:** the plugin declares no language restriction.
+
+<!-- /generated:languages -->
+
+## What it produces
+
+<!-- To write: what the plugin adds to or changes in the document (annotations and their labels, terms, categories, metadata, text…). Also say what it removes or replaces. -->
+
+## Parameters
+
+<!-- The table is generated by 'task py:help': displayed name and default come from the code.
+     The "Effect" column is yours: it starts from the code's description and is kept from one
+     generation to the next. A computed default (None in the code) is written by hand. -->
+
+<!-- generated:parameters -->
+
+| Parameter | Default | Effect |
+|---|---|---|
+| **Labels** (`labels`) | — | Labels of the mentions to group. If empty, the mentions of every label are grouped.<br/> Mentions are only grouped with mentions of the same label, except person labels, which all form one family. |
+| **Person Labels** (`person_labels`) | — | Labels of person names. They form one family (person and afpperson mentions are grouped together), and a partial name ("Macron") joins the full name it ends ("Emmanuel Macron").<br/> If empty, every label whose name contains "person" (person, afpperson...). |
+| **Honorifics** (`honorifics`) *(advanced)* | `["M.", "MM.", "Mme", "Mmes", "Mlle", "Mlles", "Me", "Dr", "Dr.", "Pr", "Pr.", "Mr", "Mr.", "Mrs", "Mrs.", "Ms", "Ms.", "Miss", "Sir", "Dame", "Lord", "Lady"]` | Honorifics ignored in front of a person name when comparing names (M., Mme, Dr...) |
+
+<!-- /generated:parameters -->
+
+## How it works
+
+<!-- Optional: what one needs to understand about the processing to tune the parameters. Remove the section if it adds nothing. -->
+
+## Examples
+
+<!-- To write: before/after cases, each recorded by a test with the help_example("<name>", ...) fixture,
+     then cited by an empty generated:example:<name> block, which 'task py:help' fills (exact form in the plugin-help skill).
+     One example per parameter that changes the result. The caption around the block is yours. -->
+
+## Known limitations
+
+<!-- To write: the cases where the result is surprising, each with a short example. -->

pyprocessors_coreference-1.6.8/docs/sherpa/coreference.fr.md

@@ -0,0 +1,55 @@
+# Processeur coreference (`coreference`)
+
+<!-- À écrire : ce que fait le plugin, en une phrase, avec un exemple concret entre guillemets. -->
+
+## Quand l'utiliser
+
+<!-- À écrire : deux ou trois situations, dans les mots de l'utilisateur de Sherpa (projet, corpus, recherche), pas dans ceux du code. -->
+
+## Quand ne pas l'utiliser
+
+<!-- À écrire : ce que le plugin ne fait pas et qu'on pourrait attendre de lui, et quel autre plugin le fait. -->
+
+## Prérequis
+
+<!-- À écrire : ce que le plugin attend en entrée (langue du document, découpage en phrases, annotations d'un autre plugin…), obligatoire ou recommandé, et pourquoi. -->
+
+<!-- generated:languages -->
+
+**Langues prises en charge :** le plugin ne déclare aucune restriction de langue.
+
+<!-- /generated:languages -->
+
+## Ce qu'il produit
+
+<!-- À écrire : ce que le plugin ajoute ou change dans le document (annotations et leurs labels, termes, catégories, métadonnées, texte…). Dire aussi ce qu'il retire ou remplace. -->
+
+## Paramètres
+
+<!-- Le tableau est généré par 'task py:help' : nom affiché et valeur par défaut viennent du code.
+     La colonne « Effet » est à vous : elle part de la description du code et se conserve d'une
+     génération à l'autre. Une valeur par défaut calculée (None dans le code) s'écrit à la main. -->
+
+<!-- generated:parameters -->
+
+| Paramètre | Valeur par défaut | Effet |
+|---|---|---|
+| **Labels** (`labels`) | — | Labels of the mentions to group. If empty, the mentions of every label are grouped.<br/> Mentions are only grouped with mentions of the same label, except person labels, which all form one family. |
+| **Person Labels** (`person_labels`) | — | Labels of person names. They form one family (person and afpperson mentions are grouped together), and a partial name ("Macron") joins the full name it ends ("Emmanuel Macron").<br/> If empty, every label whose name contains "person" (person, afpperson...). |
+| **Honorifics** (`honorifics`) *(avancé)* | `["M.", "MM.", "Mme", "Mmes", "Mlle", "Mlles", "Me", "Dr", "Dr.", "Pr", "Pr.", "Mr", "Mr.", "Mrs", "Mrs.", "Ms", "Ms.", "Miss", "Sir", "Dame", "Lord", "Lady"]` | Honorifics ignored in front of a person name when comparing names (M., Mme, Dr...) |
+
+<!-- /generated:parameters -->
+
+## Fonctionnement
+
+<!-- Facultatif : ce qu'il faut comprendre du traitement pour bien régler les paramètres. Supprimer la section si elle n'apporte rien. -->
+
+## Exemples
+
+<!-- À écrire : des cas avant/après, chacun enregistré par un test avec la fixture help_example("<nom>", ...),
+     puis cité par un bloc generated:example:<nom> vide, que 'task py:help' remplit (la forme exacte est dans le skill plugin-help).
+     Un exemple par paramètre qui change le résultat. La légende autour du bloc est à vous. -->
+
+## Limites à connaître
+
+<!-- À écrire : les cas où le résultat surprend, chacun avec un exemple court. -->

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/src/pyprocessors_coreference/__init__.py

@@ -1,3 +1,3 @@
 """Processor grouping the mentions of the same entity"""
 
-__version__ = "1.6.3"
+__version__ = "1.6.8"

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/submodules/python-archetype/.claude-plugin/plugin.json

@@ -2,8 +2,8 @@
   "$schema": "https://json.schemastore.org/claude-code-plugin-manifest.json",
   "name": "python-archetype",
   "displayName": "Kairntech python-archetype",
-  "version": "1.1.0",
-  "description": "Cree et entretient les depots Python de Kairntech qui consomment python-archetype : creation d'un plugin a partir de sa graine, et mesure de la derive d'un depot par rapport a elle.",
+  "version": "1.3.2",
+  "description": "Cree et entretient les depots Python de Kairntech qui consomment python-archetype : creation d'un plugin a partir de sa graine, page d'aide Sherpa d'un plugin, et mesure de la derive d'un depot par rapport a elle.",
   "author": {
     "name": "Kairntech",
     "email": "olivier.terrier@kairntech.com"

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/submodules/python-archetype/HOWTO.md

@@ -12,7 +12,7 @@ pas dériver de lui.
 |---------|------|
 | `.claude-plugin/marketplace.json` | Le catalogue : nom `kairntech-python`, la liste des plugins offerts. |
 | `.claude-plugin/plugin.json` | Le plugin `python-archetype` : identité, version, et `"skills": "./skills/"`. |
-| `skills/<nom>/SKILL.md` | Un skill. Aujourd'hui `new-plugin`. |
+| `skills/<nom>/SKILL.md` | Un skill. Aujourd'hui `new-plugin` et `plugin-help`. |
 
 L'entrée du catalogue porte `"source": "."` — **le plugin est la racine du dépôt**,
 pas un sous-répertoire. Il n'y a donc qu'une chose à cloner, et le skill voit

{pyprocessors_coreference-1.6.3 → pyprocessors_coreference-1.6.8}/submodules/python-archetype/README.md

@@ -10,7 +10,8 @@ Rien ici ne connaît un projet en particulier.
 
 | Fichier | Rôle |
 |---------|------|
-| `resources/Taskfile.yml` | Les tasks : `sync`, `lock-check`, `lint`, `format`, `test`, `test-marker`, `sbom`, `check-vulnerabilities`, `check-updates`, `build`, `publish`. |
+| `resources/Taskfile.yml` | Les tasks : `sync`, `lock-check`, `lint`, `format`, `test`, `test-marker`, `sbom`, `check-vulnerabilities`, `check-updates`, `build`, `publish`, `help`, `help-check`. |
+| `resources/help/` | Les pages d'aide Sherpa d'un plugin : `plugin-help.py`, que lancent `help` et `help-check`, les modèles `template.fr.md` / `template.en.md`, et la fixture pytest `help_examples.py`, qui enregistre les exemples pendant les tests. |
 | `resources/Stages.yml` | Le lanceur de pipeline : `default`, `up-to`, `jenkins`, `stages`. Générique — il ne connaît que la liste `STAGES`. |
 
 Ils sont séparés parce qu'ils s'incluent différemment : les tasks sous un
@@ -67,6 +68,8 @@ dont Jenkins a besoin puisqu'il injecte ses propres étapes entre les stages.
 | `PYTEST_ARGS` | — | |
 | `LOCK_VERSIONED` | `true` | Sur `false`, `sync` résout à neuf (`--upgrade`) : un `uv.lock` non versionné qui traîne sur un poste est périmé, et `uv sync` s'en servirait en silence — on testerait et auditerait des versions que la CI ne voit jamais. |
 | `AUDIT_ARGS` | — | Options pip-audit. **Pas `--strict`** : il rend fatal « dépendance absente de PyPI », ce qu'un workspace produit toujours. |
+| `HELP_DIR` | `docs/sherpa` | Où `help` écrit les pages d'aide Sherpa, une par entry-point et par langue (`<entry-point>.<langue>.md`). |
+| `HELP_LANGS` | `fr en` | Langues des pages d'aide ; il faut un `resources/help/template.<langue>.md` par langue. |
 | `STAGES` | `sync lock-check lint test build publish` | |
 | `TEST_STAGE` | `test` | Le stage que `task -- --skip-tests` saute. |
 | `NON_BLOCKING_STAGES` | — | Stages dont l'échec est signalé sans interrompre ; le run sort quand même en non-zéro. À garder vide. |

pyprocessors_coreference-1.6.8/submodules/python-archetype/resources/help/help_examples.py

@@ -0,0 +1,126 @@
+"""Fixture pytest 'help_example' : enregistre un exemple de page d'aide pendant un test.
+
+Un exemple de page d'aide montre une sortie du plugin. Écrite à la main, elle est
+déduite ou recopiée, et devient fausse sans que rien ne le signale au premier
+changement de comportement. Enregistrée par un test, elle a forcément été produite
+par le plugin, et 'task py:help-check' échoue dès que la page ne la montre plus.
+
+Le test appelle la fixture explicitement, après avoir lancé le plugin, et garde ses
+assertions — l'exemple ne remplace pas la vérification :
+
+    def test_propagate_false(help_example):
+        ...
+        docs = annotator.annotate([doc], parameters)
+        help_example("propagate-false", inputs=[doc], parameters=parameters, outputs=docs)
+        assert ...
+
+L'exemple est écrit dans 'build/help-examples/<nom>.json', à la racine du dépôt :
+recalculé à chaque 'py:test', il n'est pas versionné. La page le cite par un bloc
+'<!-- generated:example:<nom> -->', que 'task py:help' remplit.
+
+Le dépôt du plugin rend la fixture visible depuis 'tests/conftest.py' :
+
+    sys.path.insert(0, str(Path(__file__).parents[1] / "submodules/python-archetype/resources/help"))
+    from help_examples import help_example  # noqa: E402, F401
+"""
+
+import json
+from pathlib import Path
+
+import pytest
+
+EXAMPLES_DIR = Path("build") / "help-examples"
+
+
+# Au-delà, un contenu n'est pas recopié : une page n'en montre de toute façon qu'un extrait.
+MAX_CONTENT = 100_000
+
+
+def _content(data: bytes) -> dict:
+    """Le contenu d'un fichier ou d'une réponse : son texte s'il en est un, sa taille sinon."""
+    content = {"size": len(data)}
+    try:
+        text = data.decode("utf-8")
+    except UnicodeDecodeError:
+        return content
+    content["text"] = text[:MAX_CONTENT]
+    if len(text) > MAX_CONTENT:
+        content["truncated"] = True
+    return content
+
+
+def _upload(upload) -> dict:
+    # Le fichier a déjà été lu par le plugin : on le relit depuis le début, puis on rend
+    # la position. Un fichier déjà fermé (le 'with open' du test est sorti) ne se relit
+    # plus : appeler help_example DANS le bloc 'with'.
+    plain = {"kind": "file", "filename": upload.filename, "content_type": upload.content_type}
+    try:
+        position = upload.file.tell()
+        upload.file.seek(0)
+        plain.update(_content(upload.file.read()))
+        upload.file.seek(position)
+    except (ValueError, OSError):
+        pass
+    return plain
+
+
+def _response(response) -> dict:
+    plain = {"kind": "response", "status_code": response.status_code, "media_type": response.media_type}
+    disposition = response.headers.get("content-disposition")
+    if disposition:
+        plain["content_disposition"] = disposition
+    body = getattr(response, "body", None)
+    if isinstance(body, bytes):
+        plain.update(_content(body))
+    return plain
+
+
+def _plain(value):
+    # Les modèles pydantic en JSON, sans les champs vides : la page ne montre pas l'absence.
+    if hasattr(value, "model_dump"):
+        # warnings=False : un plugin qui met des dicts là où le schéma attend des modèles
+        # (des phrases, par exemple) ferait crouler la sortie du test sous les avertissements.
+        return value.model_dump(mode="json", exclude_none=True, warnings=False)
+    # L'entrée d'un convertisseur (starlette UploadFile) et celle d'un importeur (un chemin).
+    if hasattr(value, "filename") and hasattr(value, "file"):
+        return _upload(value)
+    if isinstance(value, Path):
+        return {"kind": "file", "filename": value.name, **_content(value.read_bytes())}
+    # La sortie d'un formateur (starlette Response).
+    if hasattr(value, "status_code") and hasattr(value, "media_type"):
+        return _response(value)
+    if isinstance(value, bytes):
+        return _content(value)
+    if isinstance(value, (list, tuple)):
+        return [_plain(item) for item in value]
+    if isinstance(value, dict):
+        return {key: _plain(item) for key, item in value.items()}
+    return value
+
+
+@pytest.fixture
+def help_example(request):
+    directory = request.config.rootpath / EXAMPLES_DIR
+
+    def record(name: str, *, inputs, parameters, outputs) -> None:
+        # Seuls les paramètres qui s'écartent du défaut : ce sont eux que l'exemple illustre.
+        # D'où le modèle et non son dict : un importeur reçoit 'options.model_dump()', mais
+        # c'est 'options' qu'il faut passer ici, sans quoi tout paraît modifié.
+        if isinstance(parameters, dict):
+            raise TypeError(f"help_example({name!r}) : passer le modèle de paramètres, pas son dict")
+        params = parameters.model_dump(mode="json", exclude_defaults=True) if parameters is not None else {}
+        # Un générateur (la sortie d'un importeur) ne se lit qu'une fois : au test d'en faire
+        # une liste, qu'il vérifie et qu'il passe ici.
+        if not isinstance(outputs, (list, tuple)) and hasattr(outputs, "__next__"):
+            raise TypeError(f"help_example({name!r}) : passer une liste, pas un générateur")
+        example = {
+            "test": request.node.nodeid,
+            "parameters": params,
+            "inputs": _plain(inputs),
+            "outputs": _plain(outputs),
+        }
+        directory.mkdir(parents=True, exist_ok=True)
+        path = directory / f"{name}.json"
+        path.write_text(json.dumps(example, ensure_ascii=False, indent=2, sort_keys=True) + "\n", encoding="utf-8")
+
+    return record