From f6c6d1e2304a06efdf65c60c3e1c6bbe1f192fd0 Mon Sep 17 00:00:00 2001 From: Zachary Ware Date: Sat, 13 May 2017 09:30:20 -0500 Subject: [PATCH] bpo-11681: Document the `-b` and `-bb` options (GH-1562) --- Doc/using/cmdline.rst | 15 ++++++++++++++- Modules/main.c | 2 ++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index c6b372b184a6..b567818858f4 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -24,7 +24,7 @@ Command line When invoking Python, you may specify any of these options:: - python [-BdEiOQsRStuUvVWxX3?] [-c command | -m module-name | script | - ] [args] + python [-bBdEiOQsRStuUvVWxX3?] [-c command | -m module-name | script | - ] [args] The most common use case is, of course, a simple invocation of a script:: @@ -191,6 +191,19 @@ Generic options Miscellaneous options ~~~~~~~~~~~~~~~~~~~~~ +.. cmdoption:: -b + + Issue a warning when comparing :class:`unicode` with :class:`bytearray`. + Issue an error when the option is given twice (:option:`!-bb`). + + Note that, unlike the corresponding Python 3.x flag, this will **not** emit + warnings for comparisons between :class:`str` and :class:`unicode`. + Instead, the ``str`` instance will be implicitly decoded to ``unicode`` and + Unicode comparison used. + + .. versionadded:: 2.6 + + .. cmdoption:: -B If given, Python won't try to write ``.pyc`` or ``.pyo`` files on the diff --git a/Modules/main.c b/Modules/main.c index 73e87e08fd4a..a6edf822d039 100644 --- a/Modules/main.c +++ b/Modules/main.c @@ -62,6 +62,8 @@ static char *usage_line = /* Long usage message, split into parts < 512 bytes */ static char *usage_1 = "\ Options and arguments (and corresponding environment variables):\n\ +-b : issue warnings about comparing bytearray with unicode\n\ + (-bb: issue errors)\n\ -B : don't write .py[co] files on import; also PYTHONDONTWRITEBYTECODE=x\n\ -c cmd : program passed in as string (terminates option list)\n\ -d : debug output from parser; also PYTHONDEBUG=x\n\ -- 2.47.3