Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-27 03:34:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.13] gh-134109: Fix showing comments in pydoc output for argparse (GH-134110) (GH-134113)

Browse source 
Comments immediately preceding the object's source code are used
if the object has no docstring.
Comments that do not describe the object should be separated from
the following source code by an empty line.
(cherry picked from commit 71cf4dd622)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-05-16 22:52:42 +02:00 • committed by GitHub
parent 4291bbe88b
commit 510e28ec29
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Lib/argparse.py
View file

@ -190,6 +190,7 @@ def __init__(self,
# =============================== # ===============================
# Section and indentation methods # Section and indentation methods
# =============================== # ===============================
def _indent(self): def _indent(self):
self._current_indent += self._indent_increment self._current_indent += self._indent_increment
self._level += 1 self._level += 1
@ -237,6 +238,7 @@ def _add_item(self, func, args):
# ======================== # ========================
# Message building methods # Message building methods
# ======================== # ========================
def start_section(self, heading): def start_section(self, heading):
self._indent() self._indent()
section = self._Section(self, self._current_section, heading) section = self._Section(self, self._current_section, heading)
@ -280,6 +282,7 @@ def add_arguments(self, actions):
# ======================= # =======================
# Help-formatting methods # Help-formatting methods
# ======================= # =======================
def format_help(self): def format_help(self):
help = self._root_section.format_help() help = self._root_section.format_help()
if help: if help:
@ -1402,6 +1405,7 @@ def __init__(self,
# ==================== # ====================
# Registration methods # Registration methods
# ==================== # ====================
def register(self, registry_name, value, object): def register(self, registry_name, value, object):
registry = self._registries.setdefault(registry_name, {}) registry = self._registries.setdefault(registry_name, {})
registry[value] = object registry[value] = object
@ -1412,6 +1416,7 @@ def _registry_get(self, registry_name, value, default=None):
# ================================== # ==================================
# Namespace default accessor methods # Namespace default accessor methods
# ================================== # ==================================
def set_defaults(self, **kwargs): def set_defaults(self, **kwargs):
self._defaults.update(kwargs) self._defaults.update(kwargs)
@ -1431,6 +1436,7 @@ def get_default(self, dest):
# ======================= # =======================
# Adding argument actions # Adding argument actions
# ======================= # =======================
def add_argument(self, *args, **kwargs): def add_argument(self, *args, **kwargs):
""" """
add_argument(dest, ..., name=value, ...) add_argument(dest, ..., name=value, ...)
@ -1820,6 +1826,7 @@ def identity(string):
# ======================= # =======================
# Pretty __repr__ methods # Pretty __repr__ methods
# ======================= # =======================
def _get_kwargs(self): def _get_kwargs(self):
names = [ names = [
'prog', 'prog',
@ -1834,6 +1841,7 @@ def _get_kwargs(self):
# ================================== # ==================================
# Optional/Positional adding methods # Optional/Positional adding methods
# ================================== # ==================================
def add_subparsers(self, **kwargs): def add_subparsers(self, **kwargs):
if self._subparsers is not None: if self._subparsers is not None:
raise ArgumentError(None, _('cannot have multiple subparser arguments')) raise ArgumentError(None, _('cannot have multiple subparser arguments'))
@ -1885,6 +1893,7 @@ def _get_positional_actions(self):
# ===================================== # =====================================
# Command line argument parsing methods # Command line argument parsing methods
# ===================================== # =====================================
def parse_args(self, args=None, namespace=None): def parse_args(self, args=None, namespace=None):
args, argv = self.parse_known_args(args, namespace) args, argv = self.parse_known_args(args, namespace)
if argv: if argv:
@ -2479,6 +2488,7 @@ def parse_known_intermixed_args(self, args=None, namespace=None):
# ======================== # ========================
# Value conversion methods # Value conversion methods
# ======================== # ========================
def _get_values(self, action, arg_strings): def _get_values(self, action, arg_strings):
# optional argument produces a default when not present # optional argument produces a default when not present
if not arg_strings and action.nargs == OPTIONAL: if not arg_strings and action.nargs == OPTIONAL:
@ -2570,6 +2580,7 @@ def _check_value(self, action, value):
# ======================= # =======================
# Help-formatting methods # Help-formatting methods
# ======================= # =======================
def format_usage(self): def format_usage(self):
formatter = self._get_formatter() formatter = self._get_formatter()
formatter.add_usage(self.usage, self._actions, formatter.add_usage(self.usage, self._actions,
@ -2605,6 +2616,7 @@ def _get_formatter(self):
# ===================== # =====================
# Help-printing methods # Help-printing methods
# ===================== # =====================
def print_usage(self, file=None): def print_usage(self, file=None):
if file is None: if file is None:
file = _sys.stdout file = _sys.stdout
@ -2626,6 +2638,7 @@ def _print_message(self, message, file=None):
# =============== # ===============
# Exiting methods # Exiting methods
# =============== # ===============
def exit(self, status=0, message=None): def exit(self, status=0, message=None):
if message: if message:
self._print_message(message, _sys.stderr) self._print_message(message, _sys.stderr)