Skip to content

Commit 9108dce

Browse files
committed
Rename cli module to _detail.logging
This renaming is effectively two changes, based on code review feedback: - The module is moved into a separate _detail package, to highlight that its contents are an implementation detail and not part of CBI's public interface. - The module is renamed from "cli" to "logging", since the three classes it defines (Formatter, MetaWarning, WarningAggregator) are all related to logging. Signed-off-by: John Pennycook <john.pennycook@intel.com>
1 parent 1dff063 commit 9108dce

File tree

6 files changed

+12
-4
lines changed

6 files changed

+12
-4
lines changed

codebasin/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import sys
1212

1313
from codebasin import CodeBase, config, finder, report, util
14-
from codebasin.cli import Formatter, WarningAggregator
14+
from codebasin._detail.logging import Formatter, WarningAggregator
1515

1616
log = logging.getLogger("codebasin")
1717
version = "1.2.0"

codebasin/_detail/__init__.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (C) 2019-2025 Intel Corporation
2+
# SPDX-License-Identifier: BSD-3-Clause
3+
"""
4+
This package contains implementation details that are not part of the public
5+
interface of Code Base Investigator. These implementation details are not
6+
intended to be used by other scripts, and should not be relied upon.
7+
"""
8+
import codebasin._detail.logging
File renamed without changes.

tests/cli/test_formatter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import logging
55
import unittest
66

7-
from codebasin.cli import Formatter
7+
from codebasin._detail.logging import Formatter
88

99

1010
class TestFormatter(unittest.TestCase):

tests/cli/test_meta_warning.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import re
66
import unittest
77

8-
from codebasin.cli import MetaWarning
8+
from codebasin._detail.logging import MetaWarning
99

1010

1111
class TestMetaWarning(unittest.TestCase):

tests/cli/test_warning_aggregator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import logging
55
import unittest
66

7-
from codebasin.cli import WarningAggregator
7+
from codebasin._detail.logging import WarningAggregator
88

99

1010
class TestWarningAggregator(unittest.TestCase):

0 commit comments

Comments
 (0)