Python 3.11 - getdefaultlocale() deprecated

[vsalvino]

Running this package on Python 3.11 yields deprecation warnings:

/opt/hostedtoolcache/Python/3.11.0/x64/lib/python3.11/site-packages/pytest_nunit/nunit.py:119: DeprecationWarning: Use setlocale(), getencoding() and getlocale() instead
    language_code = locale.getdefaultlocale()[0]

See:

• Deprecate locale.getdefaultlocale() function python/cpython#90817
• https://docs.python.org/release/3.11.0/library/locale.html#locale.getdefaultlocale

(I will try to provide a fix at some point if nobody else takes it up... logging the issue here for memory's sake)

[jamesmyatt]

I'm not clear about what the fix for this is. Is it just to call locale.getlocale() instead? On my machine, that returns the locale in a different form.

[vsalvino]

After looking into it, I don't actually know what the correct upgrade path is. Admittedly I don't know much about how locales work. Stumbled across this bug which might be worth watching: python/cpython#82986

[mjpieters]

Ideally, you should just use locale.getlocale()[0] instead. Except that that's a hot mess on Windows as vsalvino pointed out.

The other solution is to just.. silence the warning and hope for a better solution before 3.13 comes out:

def _getlocale():
    with warnings.catch_warnings():
        # temporary work-around for https://github.com/python/cpython/issues/82986
        # by continuing to use getdefaultlocale() even though it has been deprecated.
        warnings.simplefilter('ignore', category=DeprecationWarning)
        language_code = locale.getdefaultlocale()[0]
    if language_code:
        return language_code
    return "en-US"

Perhaps inject a warning there if sys.version_info >= (3, 13) is true to make sure this is caught before then?

[MalcolmTyler]

Changing :
language_code = locale.getdefaultlocale()[0]
to
language_code = locale.getlocale()[0]
worked for me, they both return the same only the first is being deprecated so gives a warning

[mjpieters]

Changing : language_code = locale.getdefaultlocale()[0] to language_code = locale.getlocale()[0] worked for me, they both return the same only the first is being deprecated so gives a warning

They may give the same for you, but that's not the case for all platforms. See python/cpython#82986 as to why this could be problematic on Windows.

Please read the whole discussion here, as this was already covered.

[MalcolmTyler]

Changing : language_code = locale.getdefaultlocale()[0] to language_code = locale.getlocale()[0] worked for me, they both return the same only the first is being deprecated so gives a warning

They may give the same for you, but that's not the case for all platforms. See python/cpython#82986 as to why this could be problematic on Windows.

Please read the whole discussion here, as this was already covered.

Fair point, we were seeing the deprecation warning when using pytest and it was only MAC users that were seeing it.

[mathrick]

locale.setlocale(locale.LC_CTYPE, None) will return a string describing the current locale. Be aware however that it also includes the encoding, ie. en_GB.UTF-8, rather than just en_GB.

[alecglen]

Does anyone have a temp solution to hide these from the xml output? I'd love to not have 900 lines of this per run in my log.

[mathrick]

Does anyone have a temp solution to hide these from the xml output? I'd love to not have 900 lines of this per run in my log.

Add the following in your pytest.ini:

filterwarnings =
    ignore:Use setlocale:DeprecationWarning:pytest_nunit

[yuenherny]

Does anyone have a temp solution to hide these from the xml output? I'd love to not have 900 lines of this per run in my log.

Add the following in your pytest.ini:

filterwarnings =
    ignore:Use setlocale:DeprecationWarning:pytest_nunit

If you are using pyproject.toml, then add this to your pyproject.toml:

[tool.pytest.ini_options]
filterwarnings = [
    "ignore:Use setlocale:DeprecationWarning:pytest_nunit"
]

[tonybaloney]

Changing : language_code = locale.getdefaultlocale()[0] to language_code = locale.getlocale()[0] worked for me, they both return the same only the first is being deprecated so gives a warning

They may give the same for you, but that's not the case for all platforms. See python/cpython#82986 as to why this could be problematic on Windows.

Please read the whole discussion here, as this was already covered.

I'm going to mute the deprecation warning because getlocale seems fraught with complexity and unresolved issues after reading this and many other related discussions

[tonybaloney]

Fixed in 1.0.5 by muting deprecation warnings in the existing call. I think the Python API will change before it is fully removed in 3.15