PyUnicode_DecodeCharmap: mapping argument not fully documented

Documentation

PyUnicode_DecodeCharmap has a mapping argument that either takes a mapping or a str:

Lines 8826 to 8833 in e8158d1

    
           if (PyUnicode_CheckExact(mapping)) { 
        
               if (charmap_decode_string(s, size, mapping, errors, &writer) < 0) 
        
                   goto onError; 
        
           } 
        
           else { 
        
               if (charmap_decode_mapping(s, size, mapping, errors, &writer) < 0) 
        
                   goto onError; 
        
           }

That it takes a str is not documented: https://docs.python.org/3/c-api/unicode.html#character-map-codecs

Linked PRs

gh-156098: Document the str form of PyUnicode_DecodeCharmap()'s mapping argument #156147

Hi everyone! I would like to work on this issue.

My plan to resolve it is to [explica aquí brevemente tu solución en inglés, por ejemplo: update the C implementation in module X / fix the documentation typo in Y / add a test case for this specific edge case].

Does this approach sound good to the core team? If so, I'll go ahead and open a PR.

Thanks!

Navigation Menu

Repository navigation

`PyUnicode_DecodeCharmap`: `mapping` argument not fully documented #156098

Documentation

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	if (PyUnicode_CheckExact(mapping)) {
	if (charmap_decode_string(s, size, mapping, errors, &writer) < 0)
	goto onError;
	}
	else {
	if (charmap_decode_mapping(s, size, mapping, errors, &writer) < 0)
	goto onError;
	}

PyUnicode_DecodeCharmap: mapping argument not fully documented #156098

Description

Documentation

Linked PRs

Activity

Diogoec2006 commented on Oct 19, 2026

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

`PyUnicode_DecodeCharmap`: `mapping` argument not fully documented #156098