Skip to content

Commit fc8501c

Browse files
committed
[fix] Rename cmd modules to avoid conflict with built-in cmd
Rename the module defined in 'codechecker_common/cmd' to 'codechecker_common/cli_commands' (as there is already a cli.py file in the same folder) in order to avoid ambiguity with Python's built-in cmd module when using `pdb.set_trace()`. The new name better reflects its purpose and eliminates potential naming conflicts. Rename all 'cmd' directories to 'cli' for consistency with 'codechecker_common/cli_commands'.
1 parent 25299c7 commit fc8501c

File tree

24 files changed

+22
-22
lines changed

24 files changed

+22
-22
lines changed

Makefile

+5-5
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ package: package_dir_structure set_git_commit_template package_gerrit_skiplist
6363
$(CC_BUILD_DIR)/config/web_version.json
6464

6565
${PYTHON_BIN} ./scripts/build/create_commands.py -b $(BUILD_DIR) \
66-
--cmd-dir $(ROOT)/codechecker_common/cmd \
67-
$(CC_WEB)/codechecker_web/cmd \
68-
$(CC_SERVER)/codechecker_server/cmd \
69-
$(CC_CLIENT)/codechecker_client/cmd \
70-
$(CC_ANALYZER)/codechecker_analyzer/cmd \
66+
--cmd-dir $(ROOT)/codechecker_common/cli_commands \
67+
$(CC_WEB)/codechecker_web/cli \
68+
$(CC_SERVER)/codechecker_server/cli \
69+
$(CC_CLIENT)/codechecker_client/cli \
70+
$(CC_ANALYZER)/codechecker_analyzer/cli \
7171
--bin-file $(ROOT)/bin/CodeChecker
7272

7373
# Copy license file.

analyzer/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ package: package_analyzer
116116

117117
# Copy CodeChecker entry point sub-commands.
118118
${PYTHON_BIN} $(ROOT)/scripts/build/create_commands.py -b $(BUILD_DIR) \
119-
--cmd-dir $(ROOT)/codechecker_common/cmd \
120-
$(CC_ANALYZER)/codechecker_analyzer/cmd \
119+
--cmd-dir $(ROOT)/codechecker_common/cli_commands \
120+
$(CC_ANALYZER)/codechecker_analyzer/cli \
121121
--bin-file $(ROOT)/bin/CodeChecker
122122

123123
# Copy license file.

analyzer/codechecker_analyzer/cmd/check.py renamed to analyzer/codechecker_analyzer/cli/check.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@
2222
OrderedCheckersAction, OrderedConfigAction, \
2323
analyzer_config, checker_config, existing_abspath
2424

25-
from codechecker_analyzer.cmd.analyze import \
25+
from codechecker_analyzer.cli.analyze import \
2626
EPILOG_ENV_VAR as analyzer_epilog_env_var, \
2727
EPILOG_ISSUE_HASHES as analyzer_epilog_issue_hashes
2828

29-
from codechecker_analyzer.cmd.log import \
29+
from codechecker_analyzer.cli.log import \
3030
EPILOG_ENV_VAR as log_epilog_env_var
3131

32-
from codechecker_analyzer.cmd.parse import \
32+
from codechecker_analyzer.cli.parse import \
3333
EPILOG_ENV_VAR as parse_epilog_env_var
3434

3535
from codechecker_common import arg, cmd_config, logger
@@ -905,7 +905,7 @@ def __update_if_key_exists(source, target, key):
905905
__update_if_key_exists(args, log_args, 'quiet')
906906
__update_if_key_exists(args, log_args, 'verbose')
907907

908-
import codechecker_analyzer.cmd.log as log_module
908+
import codechecker_analyzer.cli.log as log_module
909909
LOG.debug("Calling LOG with args:")
910910
LOG.debug(log_args)
911911

@@ -973,7 +973,7 @@ def __update_if_key_exists(source, target, key):
973973
__update_if_key_exists(args, analyze_args, 'verbose')
974974
__update_if_key_exists(args, analyze_args, 'no_missing_checker_error')
975975

976-
import codechecker_analyzer.cmd.analyze as analyze_module
976+
import codechecker_analyzer.cli.analyze as analyze_module
977977
LOG.debug("Calling ANALYZE with args:")
978978
LOG.debug(analyze_args)
979979

@@ -991,7 +991,7 @@ def __update_if_key_exists(source, target, key):
991991
__update_if_key_exists(args, parse_args, 'skipfile')
992992
__update_if_key_exists(args, parse_args, 'suppress')
993993

994-
import codechecker_analyzer.cmd.parse as parse_module
994+
import codechecker_analyzer.cli.parse as parse_module
995995
LOG.debug("Calling PARSE with args:")
996996
LOG.debug(parse_args)
997997

analyzer/tests/libtest/cmd_line.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# -------------------------------------------------------------------------
88

99
import argparse
10-
from codechecker_analyzer.cmd import analyze
10+
from codechecker_analyzer.cli import analyze
1111

1212

1313
class NoExitArgumentParser(argparse.ArgumentParser):

analyzer/tests/unit/test_analyzer_command.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import unittest
1111
from codechecker_analyzer.analyzers.clangsa.analyzer import ClangSA
1212
from codechecker_analyzer.buildlog import log_parser
13-
from codechecker_analyzer.cmd import analyze
13+
from codechecker_analyzer.cli import analyze
1414
from libtest.cmd_line import create_analyze_argparse
1515

1616

analyzer/tests/unit/test_checker_handling.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import ClangTidyConfigHandler
2727
from codechecker_analyzer.arg import AnalyzerConfig, CheckerConfig, \
2828
analyzer_config
29-
from codechecker_analyzer.cmd.analyze import \
29+
from codechecker_analyzer.cli.analyze import \
3030
is_analyzer_config_valid, is_checker_config_valid
3131

3232
from codechecker_analyzer import analyzer_context

codechecker_common/cmd/version.py renamed to codechecker_common/cli_commands/version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ def main(args):
6767
# Get analyzer version information if the module is available.
6868
analyzer_version = None
6969
try:
70-
from codechecker_analyzer.cmd.analyzer_version import Version
70+
from codechecker_analyzer.cli.analyzer_version import Version
7171
analyzer_version = Version()
7272
except Exception:
7373
pass
7474

7575
# Get web version information if the module is available.
7676
web_version = None
7777
try:
78-
from codechecker_web.cmd.web_version import Version
78+
from codechecker_web.cli.web_version import Version
7979
web_version = Version()
8080
except Exception:
8181
pass

web/Makefile

+4-4
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ package: package_dir_structure package_web
116116

117117
# Copy CodeChecker entry point sub-commands.
118118
${PYTHON_BIN} $(ROOT)/scripts/build/create_commands.py -b $(BUILD_DIR) \
119-
--cmd-dir $(ROOT)/codechecker_common/cmd \
120-
$(CC_WEB)/codechecker_web/cmd \
121-
$(CC_SERVER)/codechecker_server/cmd \
122-
$(CC_CLIENT)/codechecker_client/cmd \
119+
--cmd-dir $(ROOT)/codechecker_common/cli_commands \
120+
$(CC_WEB)/codechecker_web/cli \
121+
$(CC_SERVER)/codechecker_server/cli \
122+
$(CC_CLIENT)/codechecker_client/cli \
123123
--bin-file $(ROOT)/bin/CodeChecker
124124

125125
# Copy license file.

0 commit comments

Comments
 (0)