Skip to content

Commit 3351655

Browse files
committed
Removed 'noinspection' comments since they are PyCharm-specific.
1 parent b82117c commit 3351655

16 files changed

+4
-91
lines changed

cmd2/ansi.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,6 @@ class BgColor(AnsiSequence):
224224
####################################################################################
225225
# Implementations intended for direct use
226226
####################################################################################
227-
# noinspection PyPep8Naming
228227
class Cursor:
229228
"""Create ANSI sequences to alter the cursor position"""
230229

cmd2/argparse_completer.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
ARG_TOKENS = 'arg_tokens'
6262

6363

64-
# noinspection PyProtectedMember
6564
def _build_hint(parser: argparse.ArgumentParser, arg_action: argparse.Action) -> str:
6665
"""Build tab completion hint for a given argument"""
6766
# Check if hinting is disabled for this argument
@@ -82,7 +81,6 @@ def _single_prefix_char(token: str, parser: argparse.ArgumentParser) -> bool:
8281
return len(token) == 1 and token[0] in parser.prefix_chars
8382

8483

85-
# noinspection PyProtectedMember
8684
def _looks_like_flag(token: str, parser: argparse.ArgumentParser) -> bool:
8785
"""
8886
Determine if a token looks like a flag. Unless an argument has nargs set to argparse.REMAINDER,
@@ -144,7 +142,6 @@ def __init__(self, arg_action: argparse.Action) -> None:
144142
self.max = self.action.nargs
145143

146144

147-
# noinspection PyProtectedMember
148145
class _UnfinishedFlagError(CompletionError):
149146
def __init__(self, flag_arg_state: _ArgumentState) -> None:
150147
"""
@@ -171,7 +168,6 @@ def __init__(self, parser: argparse.ArgumentParser, arg_action: argparse.Action)
171168
super().__init__(_build_hint(parser, arg_action), apply_style=False)
172169

173170

174-
# noinspection PyProtectedMember
175171
class ArgparseCompleter:
176172
"""Automatic command line tab completion based on argparse parameters"""
177173

cmd2/argparse_custom.py

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,6 @@ def my_completer(self, text, line, begidx, endidx, arg_tokens)
237237
import argparse
238238
import re
239239
import sys
240-
241-
# noinspection PyUnresolvedReferences,PyProtectedMember
242240
from argparse import (
243241
ONE_OR_MORE,
244242
ZERO_OR_MORE,
@@ -307,7 +305,6 @@ class CompletionItem(str):
307305
def __new__(cls, value: object, *args: Any, **kwargs: Any) -> 'CompletionItem':
308306
return super(CompletionItem, cls).__new__(cls, value)
309307

310-
# noinspection PyUnusedLocal
311308
def __init__(self, value: object, description: str = '', *args: Any) -> None:
312309
"""
313310
CompletionItem Initializer
@@ -731,11 +728,9 @@ def _action_set_custom_parameter(self: argparse.Action, value: Any) -> None:
731728

732729

733730
# Save original _ActionsContainer.add_argument so we can call it in our wrapper
734-
# noinspection PyProtectedMember
735731
orig_actions_container_add_argument = argparse._ActionsContainer.add_argument
736732

737733

738-
# noinspection PyProtectedMember
739734
def _add_argument_wrapper(
740735
self: argparse._ActionsContainer,
741736
*args: Any,
@@ -870,19 +865,16 @@ def _add_argument_wrapper(
870865

871866

872867
# Overwrite _ActionsContainer.add_argument with our wrapper
873-
# noinspection PyProtectedMember
874868
setattr(argparse._ActionsContainer, 'add_argument', _add_argument_wrapper)
875869

876870
############################################################################################################
877871
# Patch ArgumentParser._get_nargs_pattern with our wrapper to support nargs ranges
878872
############################################################################################################
879873

880874
# Save original ArgumentParser._get_nargs_pattern so we can call it in our wrapper
881-
# noinspection PyProtectedMember
882875
orig_argument_parser_get_nargs_pattern = argparse.ArgumentParser._get_nargs_pattern
883876

884877

885-
# noinspection PyProtectedMember
886878
def _get_nargs_pattern_wrapper(self: argparse.ArgumentParser, action: argparse.Action) -> str:
887879
# Wrapper around ArgumentParser._get_nargs_pattern behavior to support nargs ranges
888880
nargs_range = action.get_nargs_range() # type: ignore[attr-defined]
@@ -904,18 +896,15 @@ def _get_nargs_pattern_wrapper(self: argparse.ArgumentParser, action: argparse.A
904896

905897

906898
# Overwrite ArgumentParser._get_nargs_pattern with our wrapper
907-
# noinspection PyProtectedMember
908899
setattr(argparse.ArgumentParser, '_get_nargs_pattern', _get_nargs_pattern_wrapper)
909900

910901

911902
############################################################################################################
912903
# Patch ArgumentParser._match_argument with our wrapper to support nargs ranges
913904
############################################################################################################
914-
# noinspection PyProtectedMember
915905
orig_argument_parser_match_argument = argparse.ArgumentParser._match_argument
916906

917907

918-
# noinspection PyProtectedMember
919908
def _match_argument_wrapper(self: argparse.ArgumentParser, action: argparse.Action, arg_strings_pattern: str) -> int:
920909
# Wrapper around ArgumentParser._match_argument behavior to support nargs ranges
921910
nargs_pattern = self._get_nargs_pattern(action)
@@ -931,7 +920,6 @@ def _match_argument_wrapper(self: argparse.ArgumentParser, action: argparse.Acti
931920

932921

933922
# Overwrite ArgumentParser._match_argument with our wrapper
934-
# noinspection PyProtectedMember
935923
setattr(argparse.ArgumentParser, '_match_argument', _match_argument_wrapper)
936924

937925

@@ -945,7 +933,6 @@ def _match_argument_wrapper(self: argparse.ArgumentParser, action: argparse.Acti
945933
ATTR_AP_COMPLETER_TYPE = 'ap_completer_type'
946934

947935

948-
# noinspection PyPep8Naming
949936
def _ArgumentParser_get_ap_completer_type(self: argparse.ArgumentParser) -> Optional[Type['ArgparseCompleter']]:
950937
"""
951938
Get the ap_completer_type attribute of an argparse ArgumentParser.
@@ -963,7 +950,6 @@ def _ArgumentParser_get_ap_completer_type(self: argparse.ArgumentParser) -> Opti
963950
setattr(argparse.ArgumentParser, 'get_ap_completer_type', _ArgumentParser_get_ap_completer_type)
964951

965952

966-
# noinspection PyPep8Naming
967953
def _ArgumentParser_set_ap_completer_type(self: argparse.ArgumentParser, ap_completer_type: Type['ArgparseCompleter']) -> None:
968954
"""
969955
Set the ap_completer_type attribute of an argparse ArgumentParser.
@@ -984,7 +970,6 @@ def _ArgumentParser_set_ap_completer_type(self: argparse.ArgumentParser, ap_comp
984970
############################################################################################################
985971
# Patch ArgumentParser._check_value to support CompletionItems as choices
986972
############################################################################################################
987-
# noinspection PyPep8Naming
988973
def _ArgumentParser_check_value(self: argparse.ArgumentParser, action: argparse.Action, value: Any) -> None:
989974
"""
990975
Custom override of ArgumentParser._check_value that supports CompletionItems as choices.
@@ -1018,7 +1003,6 @@ def _ArgumentParser_check_value(self: argparse.ArgumentParser, action: argparse.
10181003
############################################################################################################
10191004

10201005

1021-
# noinspection PyPep8Naming,PyProtectedMember
10221006
def _SubParsersAction_remove_parser(self: argparse._SubParsersAction, name: str) -> None: # type: ignore
10231007
"""
10241008
Removes a sub-parser from a sub-parsers group. Used to remove subcommands from a parser.
@@ -1047,7 +1031,6 @@ def _SubParsersAction_remove_parser(self: argparse._SubParsersAction, name: str)
10471031
del self._name_parser_map[cur_name]
10481032

10491033

1050-
# noinspection PyProtectedMember
10511034
setattr(argparse._SubParsersAction, 'remove_parser', _SubParsersAction_remove_parser)
10521035

10531036

@@ -1059,11 +1042,9 @@ def _SubParsersAction_remove_parser(self: argparse._SubParsersAction, name: str)
10591042
############################################################################################################
10601043

10611044

1062-
# noinspection PyCompatibility,PyShadowingBuiltins
10631045
class Cmd2HelpFormatter(argparse.RawTextHelpFormatter):
10641046
"""Custom help formatter to configure ordering of help text"""
10651047

1066-
# noinspection PyProtectedMember
10671048
def _format_usage(
10681049
self,
10691050
usage: Optional[str],
@@ -1126,7 +1107,6 @@ def _format_usage(
11261107
# End cmd2 customization
11271108

11281109
# helper for wrapping lines
1129-
# noinspection PyMissingOrEmptyDocstring,PyShadowingNames
11301110
def get_lines(parts: List[str], indent: str, prefix: Optional[str] = None) -> List[str]:
11311111
lines: List[str] = []
11321112
line: List[str] = []
@@ -1209,7 +1189,6 @@ def _format_action_invocation(self, action: argparse.Action) -> str:
12091189
return ', '.join(action.option_strings) + ' ' + args_string
12101190
# End cmd2 customization
12111191

1212-
# noinspection PyMethodMayBeStatic
12131192
def _determine_metavar(
12141193
self,
12151194
action: argparse.Action,
@@ -1234,7 +1213,6 @@ def _metavar_formatter(
12341213
) -> Callable[[int], Tuple[str, ...]]:
12351214
metavar = self._determine_metavar(action, default_metavar)
12361215

1237-
# noinspection PyMissingOrEmptyDocstring
12381216
def format(tuple_size: int) -> Tuple[str, ...]:
12391217
if isinstance(metavar, tuple):
12401218
return metavar
@@ -1243,7 +1221,6 @@ def format(tuple_size: int) -> Tuple[str, ...]:
12431221

12441222
return format
12451223

1246-
# noinspection PyProtectedMember
12471224
def _format_args(self, action: argparse.Action, default_metavar: Union[str, Tuple[str, ...]]) -> str:
12481225
"""Customized to handle ranged nargs and make other output less verbose"""
12491226
metavar = self._determine_metavar(action, default_metavar)
@@ -1272,7 +1249,6 @@ def _format_args(self, action: argparse.Action, default_metavar: Union[str, Tupl
12721249
return super()._format_args(action, default_metavar) # type: ignore[arg-type]
12731250

12741251

1275-
# noinspection PyCompatibility
12761252
class Cmd2ArgumentParser(argparse.ArgumentParser):
12771253
"""Custom ArgumentParser class that improves error and help output"""
12781254

@@ -1317,7 +1293,6 @@ def __init__(
13171293

13181294
self.set_ap_completer_type(ap_completer_type) # type: ignore[attr-defined]
13191295

1320-
# noinspection PyProtectedMember
13211296
def add_subparsers(self, **kwargs: Any) -> argparse._SubParsersAction: # type: ignore
13221297
"""
13231298
Custom override. Sets a default title if one was not given.
@@ -1346,7 +1321,6 @@ def error(self, message: str) -> NoReturn:
13461321
formatted_message = ansi.style_error(formatted_message)
13471322
self.exit(2, f'{formatted_message}\n\n')
13481323

1349-
# noinspection PyProtectedMember
13501324
def format_help(self) -> str:
13511325
"""Copy of format_help() from argparse.ArgumentParser with tweaks to separately display required parameters"""
13521326
formatter = self._get_formatter()

0 commit comments

Comments
 (0)