classification
Title: codecs.charmap_build is untested and undocumented
Type: behavior Stage:
Components: Documentation, Library (Lib) Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: eric.araujo, fijal, georg.brandl, josh.r, lemburg, loewis, terry.reedy
Priority: normal Keywords:

Created on 2008-09-22 12:06 by fijal, last changed 2019-03-15 22:35 by BreamoreBoy.

Messages (7)
msg73569 - (view) Author: Maciek Fijalkowski (fijal) Date: 2008-09-22 12:06
Although it doesn't start with _ and is definitely necessary as codecs
call it.
msg75012 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2008-10-20 22:05
AFAIR, this code was added by Martin as optimization.

The function is a direct interface to PyUnicode_BuildEncodingMap() which
builds either a dictionary or EncodingMap object for use by the charmap
codec.

It is primarily used by the gencodec.py script.
msg112747 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-08-04 03:47
There are numerous undocumented implementation objects that are either private and probably should start with _ but do not, or are semi-private and perhaps left public for the expert user willing to read code. But, being undocumented, it is hard to tell. codecs.charmap_build strikes me as rather private, hence should not be documented. So I would be inclined to close this.
msg120987 - (view) Author: √Čric Araujo (eric.araujo) * (Python committer) Date: 2010-11-12 00:02
I see charmap_build used in encodings too, so it may be useful to make it officially public for the use of third-party encodings.
msg220400 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2014-06-13 00:08
msg120987 states the opposite to msg112747 so what do we do with this issue?
msg220407 - (view) Author: Josh Rosenberg (josh.r) * (Python triager) Date: 2014-06-13 01:04
I've found it rather ugly to even understand from the lack of code comments for the C level API it's wrapping. If nothing else, comments explaining the usage and purpose might be helpful.
msg237006 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2015-03-02 02:36
I do not see much purpose in documenting and testing this one function alone.  I think that all functions in _codecsmodule.c should be looked at to see if they are private or public, but I'm certainly not volunteering to do it.
History
Date User Action Args
2019-03-15 22:35:04BreamoreBoysetnosy: - BreamoreBoy
2015-03-02 02:36:05BreamoreBoysetmessages: + msg237006
2014-06-13 01:04:01josh.rsetnosy: + josh.r
messages: + msg220407
2014-06-13 00:08:42BreamoreBoysetnosy: + BreamoreBoy

messages: + msg220400
versions: + Python 3.4, Python 3.5, - Python 3.2, Python 3.3
2012-05-17 15:20:55serhiy.storchakasetversions: + Python 2.7, Python 3.2
2012-05-17 15:19:57serhiy.storchakasetversions: + Python 3.3, - Python 2.7, Python 3.2
2010-11-12 00:02:58eric.araujosetmessages: + msg120987
2010-10-29 10:07:21adminsetassignee: georg.brandl -> docs@python
2010-08-04 03:47:15terry.reedysetnosy: + terry.reedy

messages: + msg112747
versions: + Python 3.2, - Python 2.6, Python 2.5
2010-02-16 05:55:08eric.araujosetnosy: + eric.araujo
2008-10-20 22:05:39lemburgsetassignee: georg.brandl
messages: + msg75012
components: + Documentation
nosy: + loewis, georg.brandl
2008-10-20 21:17:31benjamin.petersonsetnosy: + lemburg
2008-09-22 12:06:14fijalcreate