test_set_name fails on OpenIndiana

[serhiy-storchaka]

It seems that pthread_setname_np() only works with ASCII names here.

>>> import _thread
>>> _thread.set_name('€')
Traceback (most recent call last):
  File "<python-input-1>", line 1, in <module>
    _thread.set_name('€')
    ~~~~~~~~~~~~~~~~^^^^^
OSError: [Errno 22] Invalid argument

In addition to making the test more lenient, we can make _thread.set_name() more tolerant to such restriction -- use ASCII encoding with the "replace" or "ignore" error handler as a fallback.

cc @vstinner

Linked PRs

• gh-138004: Encode thread names on Solaris-based platforms as ASCII and fix main/worker threading test #138017
• [3.14] gh-138004: Fix setting a thread name on OpenIndiana (GH-138017) #138384

[jadonduff]

Decided to try my first issue with Python - I attempted to create a fallback in the _threadmodule and made the test more lenient. See pull request for details.

Please let me know if this was not the issue you were describing and/or fix you were hoping for. Note that all tests (including manually testing above) ran fine on macOS, but I did not test on OpenIndiana.

[serhiy-storchaka]

This turned out to be more complicated than I thought.

The following script:

import threading
import _thread

def test(name):
    print('test', repr(name))
    print('<', repr(_thread._get_name()))
    try:
        _thread.set_name(name)
        print('>', repr(_thread._get_name()))
    except OSError as e:
        print('>', repr(e))

test('main name')
test('main nam€')

t = threading.Thread(target=test, args=('set nam€',))
t.start()
t.join()

t = threading.Thread(target=test, args=('set name',), name='init name')
t.start()
t.join()

t = threading.Thread(target=test, args=('set nam€',), name='init nam€')
t.start()
t.join()

produces an expected output on Linux:

test 'main name'
< 'python'
> 'main name'
test 'main nam€'
< 'main name'
> 'main nam€'
test 'set nam€'
< 'Thread-1 (test)'
> 'set nam€'
test 'set name'
< 'init name'
> 'set name'
test 'set nam€'
< 'init nam€'
> 'set nam€'

But on OpenIndiana it is:

test 'main name'
< ''
> 'main name'
test 'main nam€'
< 'main name'
> OSError(22, 'Invalid argument')
test 'set nam€'
< 'Thread-1 (test)'
> 'Thread-1 (test)'
test 'set name'
< 'init name'
> 'set name'
test 'set nam€'
< ''
> ''

Setting a non-ASCII name does not work in the main thread and has no effect in other threads. Setting an ASCII name works in all cases.

Adding a fallback in _thread.set_name() only affects the main thread and does not help to solve the problem with tests.

[serhiy-storchaka]

Since pthread_setname_np() on OpenIndiana does nor return error, but silently does nothing, the only way to check this its to call pthread_getname_np() and compare the result with new name. But this is too much hassle.

A simpler solution is just always use ASCII on OpenIndiana. This is less generic, and we can miss when they fix this, but this is the simplest solution.

We need to add also a test for the main thread with non-ASCII name.

[vstinner]

In C, is there a way to detect OpenIndiana with a macro? If not, sadly, I would suggest to always use ASCII/replace on Solaris and OpenIndiana.

[jadonduff]

@vstinner I could not find a way to detect OpenIndiana with a macro in C (more specifically, differentiate it from other solaris/illumos platforms), so my new changes simply always use ASCII/replace on Solaris and OpenIndiana. If anyone does know of a way, let me know and we can change it.