Centralized code for config = <bool>

line_profiler/cli_utils.py[i]::get_cli_config()
    Rolled back last commit

line_profiler/explicit_profiler.py[i]::GlobalProfiler
    - Updated docstring
    - Added missing `config` argument to `.__init__()` in the stub file

line_profiler/line_profiler.py
    Removed wrapper function around
    `line_profiler.toml_config.get_config()`

line_profiler/toml_config.py[i]::get_config()
    Added handling for `config = <bool>`:
    - `False`: don't look up or load any user-supplied config and just
      use the default
    - `True`: same as `None` (default behavior)

tests/test_toml_config.py::test_config_lookup_hierarchy()
    Now also testing `get_config(True)` and `get_config(False)`

Author: TTsangSC

line_profiler/cli_utils.py

@@ -67,7 +67,7 @@ def add_argument(parser_like, *args,
     return action
 
 
-def get_cli_config(subtable, /, config=None, *args, **kwargs):
+def get_cli_config(subtable, /, *args, **kwargs):
     """
     Get the `tool.line_profiler.<subtable>` configs and normalize
     its keys (`some-key` -> `some_key`).
@@ -76,14 +76,6 @@ def get_cli_config(subtable, /, config=None, *args, **kwargs):
         subtable (str):
             Name of the subtable the CLI app should refer to (e.g.
             'kernprof')
-        config (Union[str, PurePath, bool, None]):
-            Optional filename from which to load configurations (e.g.
-            output column widths);
-            default (= `True` or `None`) is to look for a config file
-            based on the environment variable `${LINE_PROFILER_RC}` and
-            path-based lookup;
-            passing `False` disables all lookup and falls back to the
-            default configuration
         *args, **kwargs
             Passed to `line_profiler.toml_config.get_config()`
 
@@ -96,12 +88,7 @@ def get_cli_config(subtable, /, config=None, *args, **kwargs):
             - `path`: absolute path to the config file whence the
               config options are loaded
     """
-    if config in (True,):
-        config = None
-    if config in (False,):
-        conf, source = get_default_config()
-    else:
-        conf, source = get_config(config, *args, **kwargs)
+    conf, source = get_config(*args, **kwargs)
     cli_conf = {key.replace('-', '_'): value
                 for key, value in conf[subtable].items()}
     return cli_conf, source

line_profiler/cli_utils.pyi

@@ -33,7 +33,6 @@ def add_argument(parser_like: ParserLike[A_co], *args,
 
 
 def get_cli_config(subtable: str, /,
-                   config: Union[str, pathlib.PurePath, bool, None] = None,
                    *args, **kwargs) -> Tuple[dict, pathlib.Path]:
     ...
 

line_profiler/explicit_profiler.py

@@ -181,16 +181,18 @@ class GlobalProfiler:
     The :py:obj:`line_profile.profile` decorator is an instance of this object.
 
     Arguments:
-        config (Union[str, PurePath, None]):
+        config (Union[str, PurePath, bool, None]):
             Optional TOML config file from which to load the
             configurations (see Attributes);
-            if not explicitly given, it is either resolved from the
-            ``LINE_PROFILER_RC`` environment variable or looked up among
-            the current directory or its ancestors.
-            Should all that fail, the default config file at
+            if not explicitly given (= ``True`` or ``None``), it is
+            either resolved from the ``LINE_PROFILER_RC`` environment
+            variable or looked up among the current directory or its
+            ancestors.  Should all that fail, the default config file at
             ``importlib.resources.path('line_profiler.rc',
             'line_profiler.toml')``
-            is used.
+            is used;
+            passing ``False`` disables all lookup and falls back to the
+            default configuration
 
     Attributes:
         setup_config (Dict[str, List[str]]):

line_profiler/explicit_profiler.pyi

@@ -1,6 +1,8 @@
+from pathlib import PurePath
 from typing import Dict
 from typing import List
 from typing import Callable
+from typing import Union
 from _typeshed import Incomplete
 
 
@@ -11,7 +13,8 @@ class GlobalProfiler:
     show_config: Dict[str, bool]
     enabled: bool | None
 
-    def __init__(self) -> None:
+    def __init__(self,
+                 config: Union[str, PurePath, bool, None] = None) -> None:
         ...
 
     def enable(self, output_prefix: Incomplete | None = ...) -> None:

line_profiler/line_profiler.py

@@ -24,7 +24,7 @@
                              is_property, is_cached_property,
                              is_boundmethod, is_classmethod, is_staticmethod,
                              is_partial, is_partialmethod)
-from .toml_config import get_config, get_default_config
+from .toml_config import get_config
 from .cli_utils import (
     add_argument, get_cli_config, positive_float, short_string_path)
 
@@ -38,15 +38,7 @@
 @functools.lru_cache()
 def get_minimum_column_widths():
     return types.MappingProxyType(
-        get_default_config()[0]['show']['column_widths'])
-
-
-def _get_config(config):
-    if config in (True,):
-        config = None
-    if config in (False,):
-        return get_default_config()
-    return get_config(config=config)
+        get_config(False)[0]['show']['column_widths'])
 
 
 def load_ipython_extension(ip):
@@ -297,7 +289,7 @@ def show_func(filename, start_lineno, func_name, timings, unit,
         sublines = [''] * nlines
 
     # Define minimum column sizes so text fits and usually looks consistent
-    conf_column_sizes = _get_config(config)[0]['show']['column_widths']
+    conf_column_sizes = get_config(config)[0]['show']['column_widths']
     default_column_sizes = {
         col: max(width, conf_column_sizes.get(col, width))
         for col, width in get_minimum_column_widths().items()}
@@ -428,7 +420,7 @@ def show_text(stats, unit, output_unit=None, stream=None, stripzeros=False,
         stats_order = sorted(stats.items())
 
     # Pre-lookup the appropriate config file
-    _, config = _get_config(config)
+    _, config = get_config(config)
 
     if details:
         # Show detailed per-line information for each function.

line_profiler/toml_config.py

@@ -162,9 +162,13 @@ def get_headers(table, *, include_implied=False):
 def get_config(config=None, *, read_env=True):
     """
     Arguments:
-        config (Union[str | PurePath | None]):
+        config (Union[str, PurePath, bool, None]):
             Optional path to a specific TOML file;
-            if provided, skip lookup and just try to read from that file
+            if a (string) path, skip lookup and just try to read from
+            that file;
+            if `None` or `True`, use lookup to resolve to the correct
+            file;
+            if `False`, skip lookup and just use the default configs
         read_env (bool):
             Whether to read the environment variable
             `${LINE_PROFILER_RC}` for a config file (instead of moving
@@ -203,6 +207,11 @@ def merge(template, supplied):
         return result
 
     default_conf, default_source = get_default_config()
+    if config in (True, False):
+        if config:
+            config = None
+        else:
+            return default_conf, default_source
     if config is not None:
         # Promote to `Path` (and catch type errors) early
         config = pathlib.Path(config)

line_profiler/toml_config.pyi

@@ -33,7 +33,7 @@ def get_headers(table: NestedTable[K, Any], *,
     ...
 
 
-def get_config(config: Union[str, pathlib.PurePath, None] = None, *,
+def get_config(config: Union[str, pathlib.PurePath, bool, None] = None, *,
                read_env: bool = True) -> Config:
     ...
 

tests/test_toml_config.py

@@ -139,3 +139,7 @@ def test_config_lookup_hierarchy(monkeypatch: pytest.MonkeyPatch,
         get_config(highest_priority)
     highest_priority.touch()
     assert get_config(highest_priority)[1].samefile(highest_priority)
+    # Also test that `True` is equivalent to the default behavior
+    # (`None`), and `False` to disabling all lookup
+    assert get_config(True)[1].samefile(high_priority)
+    assert get_config(False)[1].samefile(default)