Follow BCP 47 for language codes: canonical tags in tests and documents, and rule files matched as tags #3

New issue

Closed

opened 2026-10-01 06:39:31 +00:00 by tiagoagueda · 0 comments

tiagoagueda commented

2026-10-01 06:39:31 +00:00

Owner

The requirement: all language codes must follow BCP 47. A BCP 47 tag (RFC 5646) is made of subtags from the IANA registry joined by hyphens, and §2.1.1 gives the form to write one in: the language in lower case, a script in title case, a region in upper case (pt-BR, en-GB, sr-Cyrl). The rule for the whole project is postulo/postulo#337; this is what it means for this plugin.

What exists today

Forced by gettext, and staying. The catalogues live in src/postulo_imap/locale/ under gettext locale names (fr_FR, pt_BR, pt_PT), and each PO file's Language: header says the same. They are not language tags; the core's postulo-messages derives them from a tag with Django's to_locale.
The core's lower-case codes, in the tests. tests/test_catalogues.py names the working languages as ("fr-fr", "pt-pt") and the European Union's with "fr-fr" and "pt-pt" among them, and tests/test_imap.py switches language with translation.override("fr-fr"), ("pt-pt") and ("en-gb") (lines 641-646). These are the core's own spellings, handed to the core's tool, so they cannot change here before they change there.
A second set of codes, the plugin's own. The phrase files are src/postulo_imap/rules/<code>.json, each saying "language": "<code>": de, en, es, fr, it, nl, pl, pt. All are valid tags in the right form. They are compared by exact string (dates_in and classify(only=…) in src/postulo_imap/classifying.py), and languages() offers them "for the connection form", which has no language field yet. The suggestion's context shows the code as it is: rejected (en): ….
The README's Adding a language says to "name the file after the language", without saying in what form.

What the plugin should do

Once postulo/postulo#337 lands: move the core pin (the dev group in pyproject.toml pins commit 1d6cdd7e0), and write the codes in the tests as the core then does (fr-FR, pt-PT, en-GB).
Say in the README, where it speaks of translations, what a language code is here: a BCP 47 tag in its canonical form, with the locale/ directory names being gettext's and made by the tool.
Compare the rule files' codes as BCP 47 asks: without regard to case, and falling back to the primary subtag (RFC 4647 §3.4), so that pt-BR or PT chosen on a form or kept on a profile finds pt. Today an exact comparison would match nothing, silently.
The README says a rule file is named after a BCP 47 tag (pt, or pt-BR if a variety needs its own phrases), and the test that pins the set checks each name is a canonical tag.

Done when

No lower-case regional code is written in this repository, and the only underscore forms are the locale/ directory names and the PO headers.
uv run pytest passes against the core that carries postulo/postulo#337, and uv run pytest -m release still holds the European Union catalogues complete.
A test asks for pt-BR and gets the pt rules; a rule file with a name that is not a canonical tag fails the suite.

Requested on 2026-10-01: all language codes must follow BCP 47.

The requirement: **all language codes must follow BCP 47.** A BCP 47 tag (RFC 5646) is made of subtags from the IANA registry joined by hyphens, and §2.1.1 gives the form to write one in: the language in lower case, a script in title case, a region in upper case (`pt-BR`, `en-GB`, `sr-Cyrl`). The rule for the whole project is postulo/postulo#337; this is what it means for this plugin. ## What exists today - **Forced by gettext, and staying.** The catalogues live in `src/postulo_imap/locale/` under gettext locale names (`fr_FR`, `pt_BR`, `pt_PT`), and each PO file's `Language:` header says the same. They are not language tags; the core's `postulo-messages` derives them from a tag with Django's `to_locale`. - **The core's lower-case codes, in the tests.** `tests/test_catalogues.py` names the working languages as `("fr-fr", "pt-pt")` and the European Union's with `"fr-fr"` and `"pt-pt"` among them, and `tests/test_imap.py` switches language with `translation.override("fr-fr")`, `("pt-pt")` and `("en-gb")` (lines 641-646). These are the core's own spellings, handed to the core's tool, so they cannot change here before they change there. - **A second set of codes, the plugin's own.** The phrase files are `src/postulo_imap/rules/<code>.json`, each saying `"language": "<code>"`: `de`, `en`, `es`, `fr`, `it`, `nl`, `pl`, `pt`. All are valid tags in the right form. They are compared by exact string (`dates_in` and `classify(only=…)` in `src/postulo_imap/classifying.py`), and `languages()` offers them "for the connection form", which has no language field yet. The suggestion's context shows the code as it is: `rejected (en): …`. - The README's *Adding a language* says to "name the file after the language", without saying in what form. ## What the plugin should do - Once postulo/postulo#337 lands: move the core pin (the dev group in `pyproject.toml` pins commit `1d6cdd7e0`), and write the codes in the tests as the core then does (`fr-FR`, `pt-PT`, `en-GB`). - Say in the README, where it speaks of translations, what a language code is here: a BCP 47 tag in its canonical form, with the `locale/` directory names being gettext's and made by the tool. - Compare the rule files' codes as BCP 47 asks: without regard to case, and falling back to the primary subtag (RFC 4647 §3.4), so that `pt-BR` or `PT` chosen on a form or kept on a profile finds `pt`. Today an exact comparison would match nothing, silently. - The README says a rule file is named after a BCP 47 tag (`pt`, or `pt-BR` if a variety needs its own phrases), and the test that pins the set checks each name is a canonical tag. ## Done when - No lower-case regional code is written in this repository, and the only underscore forms are the `locale/` directory names and the PO headers. - `uv run pytest` passes against the core that carries postulo/postulo#337, and `uv run pytest -m release` still holds the European Union catalogues complete. - A test asks for `pt-BR` and gets the `pt` rules; a rule file with a name that is not a canonical tag fails the suite. Requested on 2026-10-01: all language codes must follow BCP 47.

tiagoagueda added the

enhancement

label

2026-10-01 06:39:31 +00:00

tiagoagueda referenced this issue from Postulo/postulo

2026-10-01 06:49:04 +00:00

Write every language code as a BCP 47 tag in its canonical form: pt-BR, not pt-br or pt_BR #337

tiagoagueda referenced this issue from a commit

2026-10-01 21:11:26 +00:00

Write a language code as Postulo does, and find a rule list the way tags compare

tiagoagueda closed this issue

2026-10-01 21:11:26 +00:00