Handle en_GB and en_US locale

[dangillet]

Fixes #210
Replaces existing PR and closes #222

I tried to push that PR over the finishing line. The commits could all be squashed in a single commit. I wanted to keep track of the original author contribution.

Changes proposed in this pull request:

• Add i18n support for en_GB, en_US and any languages starting with en_*

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.49%. Comparing base (de8b8a1) to head (35562f8).
Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #230      +/-   ##
==========================================
+ Coverage   99.47%   99.49%   +0.01%     
==========================================
  Files          11       11              
  Lines         760      785      +25     
==========================================
+ Hits          756      781      +25     
  Misses          4        4              

Flag	Coverage Δ
macos-latest	97.70% <92.30%> (-0.19%)	⬇️
ubuntu-latest	97.70% <92.30%> (-0.19%)	⬇️
windows-latest	95.92% <80.76%> (-0.53%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[hugovk]

I wanted to keep track of the original author contribution.

Appreciated!

What's the reason for removing humanize.i18n.activate(None) from the test (in 36d77e8)? Do we not want to allow that?

[dangillet]

The current type hint for activate is

def activate(
    locale: str, path: str | os.PathLike[str] | None = None
) -> gettext_module.NullTranslations:

So humanize.i18n.activate(None) is not allowed from a type hinting point of view.

If this is desired though, it's absolutely OK to amend the type hint. I will then also need to slightly amend the function implementation to deal with None for locale, which would be the same as choosing an English language.

I don't really see the reason for humanize.i18n.activate(None). If you don't want any translation, or because you're done with one language, I would assume the client would use instead humanize.i18n.deactivate().

I'll let you decide what you think is best.

[hugovk]

Yes, these are good points.

I do see a couple of uses of humanize.i18n.activate(None if lang == "en" else lang) in the wild, which admittedly isn't much for a package downloaded 13 million times per month.

https://github.com/search?q=%2Factivate%5C%28None%2F&ref=opensearch&type=code

But we don't know how much non-GitHub code might do activate(None), and on balance I think it's probably better to allow it for compatability. It doesn't cost us much to allow None.

What do you think?

[dangillet]

I fully agree. It seems like a good idea to allow activate(None). I just wanted to make sure you were aware of it.

I made the change and I moved to test inside the TestActivate class as it seems to belong there - we're testing more usage to activate.

I then noticed that the original test had a small issue. It did not use the decorator @freeze_time("2020-02-02"), which means that when it was calling humanize.naturaltime(three_seconds), the result actually was 5 years ago which is pretty surprising.

I decided to reduce this gotcha effect by making NOW a pytest fixture. Any code that would use it would have its time frozen in 2020-02-02.

[dangillet]

My unit tests were failing on Windows because gettext was not installed. I amended test.yml file to install gettext on Windows and compile the translation files.

The unit tests now pass on Windows but I'm getting two failures for linting and code coverage one failure for coverage.

I don't understand the linting issue. Locally I'm not getting any linting issue. I also tried to copy-paste test.yml content in https://rhysd.github.io/actionlint/ and I'm not getting any failures. The linter uses actionlint which uses ShellCheck for run commands. It's a shell script static analysis tool, which then does not understand Windows commands. I decided to move those commands to a separate script file. I'm torn on the location. I put it under scripts, but it's only useful for the Github Action, as it's dealing with $env:GITHUB_PATH. Maybe it would be better placed within the .github folder?

For code coverage, I'm looking on Sentry, but the only lines that are not tested seem to be the docstring I added to the pytest fixture. What am I missing?

[hugovk]

Let's not bother with the .ps1 scripts, we only need to run it during the automated release process, which is done on Ubuntu. It's one less thing to maintain and test.

(And I've noticed it was accidentally left out when adding the automation, I've reported this in #231.)

[dangillet]

Hi,

I'm happy to remove the ps1 scripts. But the unittests in the CI would not work then for Windows. One of my test uses a translation, and thus needs those files present.

Unless you want me to also change the test so we never try to translate anything in the unittests?

I noticed in other tests this pattern

    try:
        humanize.i18n.activate("ru_RU")
        assert humanize.naturaltime(three_seconds) == "3 секунды назад"
        assert humanize.ordinal(5) == "5ый"
        assert humanize.precisedelta(one_min_three_seconds) == "1 минута и 7 секунд"

    except FileNotFoundError:
        pytest.skip("Generate .mo with scripts/generate-translation-binaries.sh")

Is it how we want to handle it? No unittests should run translations on the CI?

[hugovk]

Yes, let's use the try/except.

We can see skips for the Windows CI:

• https://github.com/python-humanize/humanize/actions/runs/13268474110/job/37041909246#step:8:44

But they're run on the macOS and Ubuntu CI:

• https://github.com/python-humanize/humanize/actions/runs/13268474110/job/37041910044#step:8:44
• https://github.com/python-humanize/humanize/actions/runs/13268474110/job/37041910678#step:8:45

Because we're installing gettext and running/testing the script for those:

humanize/.github/workflows/test.yml

Lines 28 to 43 in de8b8a1

	- name: Install Linux dependencies
	if: startsWith(matrix.os, 'ubuntu')
	run: |
	sudo apt install gettext
	- name: Install macOS dependencies
	if: startsWith(matrix.os, 'macos')
	run: |
	brew install gettext
	- name: Install uv
	uses: hynek/setup-cached-uv@v2
	- name: Generate translation binaries
	run: |
	scripts/generate-translation-binaries.sh

This means people can also test locally without generating the binaries.

[hugovk]

Thanks for your patience, I think we're almost there!

[hugovk]

Thank you very much!