Skip to content

Remove recommendation in curses module documentation to initialize LC_ALL and encode strings #85263

Closed
Closed
Remove recommendation in curses module documentation to initialize LC_ALL and encode strings#85263
Labels
docsDocumentation in the Doc dir

Description

@manueljacob
manueljacob
mannequin
opened on Jun 23, 2020
BPO 41091
Nosy @manueljacob
PRs
  • bpo-41091: Remove recommendation in curses module documentation to initialize LC_ALL and encode strings #21159
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2020-06-23.15:26:57.516>
labels = ['docs']
title = 'Remove recommendation in curses module documentation to initialize LC_ALL and encode strings'
updated_at = <Date 2020-06-25.22:25:01.188>
user = 'https://github.com/manueljacob'

    bugs.python.org fields:

    activity = <Date 2020-06-25.22:25:01.188>
actor = 'mjacob'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-06-23.15:26:57.516>
creator = 'mjacob'
dependencies = []
files = []
hgrepos = []
issue_num = 41091
keywords = ['patch']
message_count = 1.0
messages = ['372178']
nosy_count = 2.0
nosy_names = ['docs@python', 'mjacob']
pr_nums = ['21159']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue41091'
versions = []

    Activity

    1. manueljacob commented on Jun 23, 2020

      @manueljacob
      manueljacobmannequin
      on Jun 23, 2020
      MannequinAuthor

      The documentation for the curses module (https://docs.python.org/3.9/library/curses.html) has the following note:

      Since version 5.4, the ncurses library decides how to interpret non-ASCII data using the nl_langinfo function. That means that you have to call locale.setlocale() in the application and encode Unicode strings using one of the system’s available encodings. This example uses the system’s default encoding:

      import locale
      locale.setlocale(locale.LC_ALL, '')
      code = locale.getpreferredencoding()

      Then use code as the encoding for str.encode() calls.

      The recommendation to call locale.setlocale(locale.LC_ALL, '') is problematic as it initializes all locale categories to the user settings, which might be unintended and is not necessary for curses to work correctly. Initializing LC_CTYPE is sufficient for nl_langinfo() to return the correct encoding. Current versions of Python (*) initialize LC_CTYPE at interpreter startup. Therefore calling locale.setlocale() should not be necessary at all.

      The curses module automatically encodes strings. Therefore the recommendation to manually encode strings is outdated.

      (*) It seems to be the case since 177d921. Why was is not previously done on Python 2 and on Python 3 on Windows?

    2. manueljacob
      assigned
      docspython
      on Jun 23, 2020
    3. manueljacob
      added
      docsDocumentation in the Doc dir
      on Jun 23, 2020
    4. manueljacob
      assigned
      docspython
      on Jun 23, 2020
    5. manueljacob
      added
      docsDocumentation in the Doc dir
      on Jun 23, 2020
    6. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    7. serhiy-storchaka
      added this to Curses issueson May 20, 2022

    8. iritkatriel commented on Nov 7, 2022

      @iritkatriel
      iritkatriel
      on Nov 7, 2022
      Member

      Duplicate of #91156.

    9. iritkatriel
      closed this as completedon Nov 7, 2022
    10. iritkatriel
      moved this to Done in Curses issueson Nov 7, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      docsDocumentation in the Doc dir

      Projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions