test_name_lead_chars fails with sphinx >= 8.2

[danigm]

test_name_lead_chars fails with sphinx >= 8.2

Failing tests:

• test_name_lead_chars[11_\x0b]
• test_name_lead_chars[12_\x0c]
• test_name_lead_chars[13_\r]
• test_name_lead_chars[28_\x1c]
• test_name_lead_chars[29_\x1d]
• test_name_lead_chars[30_\x1e]
• test_name_lead_chars[133_\x85]

Full output:

=================================================================================================================================== test session starts ===================================================================================================================================
platform linux -- Python 3.13.2, pytest-8.3.5, pluggy-1.5.0
cachedir: .tox/py313-sphx_latest-attrs_latest-jsch_latest/.pytest_cache
rootdir: /home/danigm/Projects/suse/tmp/sphobjinv
configfile: tox.ini
plugins: flaky-3.8.1, timeout-2.3.1, ordering-0.6, check-2.5.3
collected 758 items                                                                                                                                                                                                                                                                       

tests/test_api_fail.py ................................xxxx                                                                                                                                                                                                                         [  4%]
tests/test_api_good.py ..............................................................................................................s.ssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss.sssssssssssssssssssssssssssssssssssssssssssssssssssssssssss.                    [ 35%]
tests/test_api_good_nonlocal.py ..s.sssssssssssssssssssssssssssssssssssssssssssssssssssssssssss                                                                                                                                                                                     [ 43%]
tests/test_cli.py ......s...s...s.........s.sssssssssssssssssssssssssssssssssssssssssssssssssssssssssss.............................                                                                                                                                                [ 58%]
tests/test_cli_nonlocal.py ............                                                                                                                                                                                                                                             [ 60%]
tests/test_fixture.py .....                                                                                                                                                                                                                                                         [ 61%]
tests/test_flake8_ext.py s                                                                                                                                                                                                                                                          [ 61%]
tests/test_intersphinx.py ....                                                                                                                                                                                                                                                      [ 61%]
tests/test_valid_objects.py .............................................xFFF..............FFF....x.................................................................................................F.............................................................................. [ 94%]
...........................................                                                                                                                                                                                                                                         [100%]

======================================================================================================================================== FAILURES =========================================================================================================================================
______________________________________________________________________________________________________________________________ test_name_lead_chars[11_\x0b] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 11

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x0b foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x0b foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x0b foo' = DataObjStr(name='\x0b foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
______________________________________________________________________________________________________________________________ test_name_lead_chars[12_\x0c] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 12

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x0c foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x0c foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x0c foo' = DataObjStr(name='\x0c foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
_______________________________________________________________________________________________________________________________ test_name_lead_chars[13_\r] _______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 13

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\r foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\r foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\r foo' = DataObjStr(name='\r foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
______________________________________________________________________________________________________________________________ test_name_lead_chars[28_\x1c] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 28

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x1c foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x1c foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x1c foo' = DataObjStr(name='\x1c foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
______________________________________________________________________________________________________________________________ test_name_lead_chars[29_\x1d] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 29

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x1d foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x1d foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x1d foo' = DataObjStr(name='\x1d foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
______________________________________________________________________________________________________________________________ test_name_lead_chars[30_\x1e] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 30

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x1e foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x1e foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x1e foo' = DataObjStr(name='\x1e foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError
_____________________________________________________________________________________________________________________________ test_name_lead_chars[133_\x85] ______________________________________________________________________________________________________________________________

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, leadint = 133

    @pytest.mark.parametrize("leadint", range(255), ids=latin_1_id)
    def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
        """Screen for valid/invalid first characters."""
        name = int_to_latin_1(leadint) + " foo"
    
        # Expect only two fail cases, newline and '#'
        if leadint in (10, 35):
            pytest.xfail("Known invalid name lead char")
    
>       test_dataobjstr_valid_objects(
            misc_info,
            sphinx_ifile_data_count,
            name=name,
            domain="py",
            role="data",
            prio=1,
            uri="data.html#$",
            dispname="-",
        )

tests/test_valid_objects.py:173: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

misc_info = <conftest.misc_info.<locals>.Info object at 0x7fc584c7c1a0>, sphinx_ifile_data_count = <function sphinx_ifile_data_count at 0x7fc584f368e0>, name = '\x85 foo', domain = 'py', role = 'data', prio = 1, uri = 'data.html#$', dispname = '-'

    @pytest.mark.parametrize(
        ("name", "domain", "role", "prio", "uri", "dispname"),
        [
            ("foo", "py", "data", 1, "quux.html#$", "-"),  # Priorities
            ("foo", "py", "data", 0, "quux.html#$", "-"),
            ("foo", "py", "data", -1, "quux.html#$", "-"),
            ("foo", "py", "data", -1235778, "quux.html#$", "-"),
            ("foo", "py", "data", 2214888, "quux.html#$", "-"),
            ("foo bar", "std", "term", 1, "quux.html#$", "-"),  # Space in name
            ("foo\tbar", "std", "term", 1, "quux.html#$", "-"),  # Valid but discouraged
            ("Index Page", "std", "doc", 1, "index.html", "-"),
            ("Index Page", "std", "doc", 1, "index.html", "Index Page Thing"),
            ("Index Page", "std", "doc", 1, "index.html", "Index\tPage\tThing"),
            ("Index Page", "std", "doc", 1, "", "-"),  # Zero-length uri
            ("Index # Page", "std", "doc", 1, "index.html", "-"),  # Symbol in name
            ("Thing \u33a4", "std", "ref", 1, "index.html#$", "-"),  # Unicode in name
            ("Thing One", "std", "ref", 1, "index.html#$", "\u33a4"),  # Unicode in dispname
            ("foo", "py", "da:ta", 1, "data.html#$", "-"),  # Colon in role (used in Sphinx)
            ("foo", "py$", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py\u33a4", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data$", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data\u33a4", 1, "data.html#$", "-"),  # Valid but discouraged
            ("foo", "py", "data", 1, "data/\u33a4.html#$", "-"),  # Valid but discouraged
            ("  foo", "py", "data", 1, "data.html#$", "-"),  # Valid but discouraged
            # Colon in domain (invalid but undetectable)
            ("foo", "p:y", "data", 1, "data.html#$", "-"),
        ],
    )
    def test_dataobjstr_valid_objects(
        misc_info, sphinx_ifile_data_count, name, domain, role, prio, uri, dispname
    ):
        """Run sphobjinv/sphinx comparison on specific object data lines."""
        dos = soi.DataObjStr(
            name=name,
            domain=domain,
            role=role,
            priority=str(prio),
            uri=uri,
            dispname=dispname,
        )
    
        assert dos
    
        inv = soi.Inventory()
        inv.project = "Foo"
        inv.version = "1.0"
        inv.objects.append(
            soi.DataObjStr(
                name="bar", domain="py", role="data", priority="1", uri="$", dispname="-"
            )
        )
        inv.objects.append(dos)
    
        df = inv.data_file(contract=True)
    
        ifile_data = IFile.load(BytesIO(soi.compress(df)), "", osp.join)
    
        ifile_count = sphinx_ifile_data_count(ifile_data)
    
        assert inv.count == ifile_count
    
        domrole = "{dos.domain}:{dos.role}".format(dos=dos)
    
        assert domrole in ifile_data
>       assert dos.name in ifile_data[domrole]
E       AssertionError: assert '\x85 foo' in {' foo': _InventoryItem(project_name='Foo', project_version='1.0', uri='data.html# foo', display_name='-'), 'bar': _InventoryItem(project_name='Foo', project_version='1.0', uri='bar', display_name='-')}
E        +  where '\x85 foo' = DataObjStr(name='\x85 foo', domain='py', role='data', priority='1', uri='data.html#$', dispname='-').name

tests/test_valid_objects.py:123: AssertionError

[bskinn]

Thanks for the report, @danigm!

This test is probing edge cases in Sphinx's data contract for the objects.inv format, in particular handling of non-printing and high-ASCII characters in object names.

In the short term, IMO it would be appropriate to silence these failures to allow builds/releases to proceed. I will investigate and get a new sphobjinv version out that addresses these properly in the test suite and the docs.

[danigm]

That's exactly what I thought, so for now I've disabled this test in openSUSE. Thank you for the confirmation

[mitya57]

According to git bisect, it started failing with sphinx-doc/sphinx@df06e6d.

[mitya57]

I bisected that commit even further and found that it was caused by replacing split('\n') with splitlines(). Reverting this change in Sphinx makes the test pass again:

--- a/sphinx/util/inventory.py
+++ b/sphinx/util/inventory.py
@@ -110,7 +110,7 @@ def _loads_v2(cls, inv_data: bytes, *, uri: str) -> _Inventory:
             raise ValueError(msg)
 
         decompressed_content = zlib.decompress(compressed)
-        for line in decompressed_content.decode().splitlines():
+        for line in decompressed_content.decode().split('\n'):
             # be careful to handle names with embedded spaces correctly
             m = re.match(
                 r'(.+?)\s+(\S+)\s+(-?\d+)\s+?(\S*)\s+(.*)',

According to the documentation of splitlines() method, it splits on the following characters:

Representation	Description
\n	Line Feed
\r	Carriage Return
\r\n	Carriage Return + Line Feed
\v or \x0b	Line Tabulation
\f or \x0c	Form Feed
\x1c	File Separator
\x1d	Group Separator
\x1e	Record Separator
\x85	Next Line (C1 Control Code)
\u2028	Line Separator
\u2029	Paragraph Separator

However, I am not sure if these characters should be a supported scenario at all. If it is, I can submit a PR in Sphinx with the above patch. Or maybe we should just skip them in the tests, e.g. this way?

--- a/tests/test_valid_objects.py
+++ b/tests/test_valid_objects.py
@@ -166,8 +166,8 @@ def test_name_lead_chars(misc_info, sphinx_ifile_data_count, leadint):
     """Screen for valid/invalid first characters."""
     name = int_to_latin_1(leadint) + " foo"
 
-    # Expect only two fail cases, newline and '#'
-    if leadint in (10, 35):
+    # Fail cases: line boundaries (as defined by str.splitlines) and '#'
+    if leadint in (10, 11, 12, 13, 28, 29, 30, 35, 133):
         pytest.xfail("Known invalid name lead char")
 
     test_dataobjstr_valid_objects(

@bskinn Which of the changes is the right one?

[bskinn]

@mitya57 Great work narrowing this down and fleshing out the info - thanks!

The only action I might take on the Sphinx repo itself is possibly opening an issue to inform them of the changed edge case behavior. I suspect the intention behind the .split('\n') ➡ .splitlines() change was to catch any Windows \r\n that might have ended up in the objects.inv, and that they're not concerned about the change in behavior for these other non-printing characters. I'm inclined not to even bother them about it: -0.5 on opening a ticket there.

What I plan to do here for sphobjinv is revise the tests to account for this behavior change on a per-Sphinx-version basis, and then maybe (but likely not) add a note to the docs about it.... I would consider the presence of non-printing characters in a cross-reference name to be off-label/non-intended usage, and thus not worthy of bringing to the average docs reader's attention.

---

I'd welcome a PR for this, and your change to test_valid_objects.py is on the right track. It can't be a blanket change, though, because the tox test matrix I use during my release-prep process parameterizes over a range of Sphinx versions, and this change would make the tests fail for older Sphinxes. The list of expected-to-fail characters will need to be different depending on the Sphinx version.

When you test your changes, after setting up a virtual environment and installing development requirements with pip install -r requirements-dev.txt, use the following tox invocation with the venv activated to test both a new and old Sphinx version:

$ tox -e py312-sphx_{7_x,latest}-attrs_latest-jsch_latest

Replace py312 with the version of Python you're using for your venv. Both tox environments will need to pass.

Once you have a passing test, please take a look at tox.ini and add environment definitions and envlist entries for the Sphinx versions immediately before and immediately after this behavior change, so that the tox matrix can bracket the change as closely as possible. (If you're not sure what I mean, just get the PR with the changes to the test first, and we can work from there.)

Thanks again!

[bskinn]

Fixed in #315.