Streamline settings and update tests

Also bump version

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

src/python_inspector/api.py

@@ -29,7 +29,7 @@
 from _packagedcode.pypi import can_process_dependent_package
 from _packagedcode.pypi import get_resolved_purl
 from python_inspector import dependencies
-from python_inspector import pyinspector_settings as settings
+from python_inspector import pyinspector_settings
 from python_inspector import utils
 from python_inspector import utils_pypi
 from python_inspector.package_data import get_pypi_data_from_purl
@@ -82,7 +82,7 @@ def resolve_dependencies(
     specifiers=tuple(),
     python_version=None,
     operating_system=None,
-    index_urls: tuple[str, ...] = settings.INDEX_URL,
+    index_urls: tuple[str, ...] = pyinspector_settings.INDEX_URL,
     pdt_output=None,
     netrc_file=None,
     max_rounds=200000,
@@ -251,10 +251,10 @@ def resolve_dependencies(
     repos_by_url = {}
     if not use_pypi_json_api:
         # Collect PyPI repos
-        use_only_confed = settings.USE_ONLY_CONFIGURED_INDEX_URLS
+        use_only_confed = pyinspector_settings.USE_ONLY_CONFIGURED_INDEX_URLS
         for index_url in index_urls:
             index_url = index_url.strip("/")
-            if use_only_confed and index_url not in settings.INDEX_URL:
+            if use_only_confed and index_url not in pyinspector_settings.INDEX_URL:
                 if verbose:
                     printer(f"Skipping index URL unknown in settings: {index_url!r}")
                 continue

src/python_inspector/resolve_cli.py

@@ -13,16 +13,17 @@
 
 import click
 
-from python_inspector import pyinspector_settings as settings
+from python_inspector import settings
 from python_inspector import utils_pypi
 from python_inspector.cli_utils import FileOptionType
 from python_inspector.utils import write_output_in_file
 
 TRACE = False
 
-__version__ = "0.13.0"
+__version__ = "0.14.0"
 
 DEFAULT_PYTHON_VERSION = settings.DEFAULT_PYTHON_VERSION
+PYPI_SIMPLE_URL = settings.PYPI_SIMPLE_URL
 
 
 def print_version(ctx, param, value):
@@ -71,7 +72,6 @@ def print_version(ctx, param, value):
     "python_version",
     type=click.Choice(utils_pypi.valid_python_versions),
     metavar="PYVER",
-    default=settings.DEFAULT_PYTHON_VERSION,
     show_default=True,
     required=True,
     help="Python version to use for dependency resolution. One of "
@@ -83,19 +83,18 @@ def print_version(ctx, param, value):
     "operating_system",
     type=click.Choice(utils_pypi.PLATFORMS_BY_OS),
     metavar="OS",
-    default=settings.DEFAULT_OS,
     show_default=True,
     required=True,
     help="OS to use for dependency resolution. One of " + ", ".join(utils_pypi.PLATFORMS_BY_OS),
 )
 @click.option(
     "--index-url",
     "index_urls",
-    envvar="PYINSP_INDEX_URL",
     type=str,
     metavar="INDEX",
     show_default=True,
-    default=tuple(settings.INDEX_URL),
+    # since multiple is True, this is a sequence
+    default=[settings.PYPI_SIMPLE_URL],
     multiple=True,
     help="PyPI simple index URL(s) to use in order of preference. "
     "This option can be used multiple times.",
@@ -123,7 +122,6 @@ def print_version(ctx, param, value):
     "--netrc",
     "netrc_file",
     type=click.Path(exists=True, readable=True, path_type=str, dir_okay=False),
-    envvar="PYINSP_NETRC_FILE",
     metavar="NETRC-FILE",
     hidden=True,
     required=False,
@@ -165,7 +163,6 @@ def print_version(ctx, param, value):
 )
 @click.option(
     "--verbose",
-    envvar="PYINSP_VERBOSE",
     is_flag=True,
     help="Enable verbose debug output.",
 )

src/python_inspector/settings.py

@@ -13,6 +13,9 @@
 from pydantic_settings import BaseSettings
 from pydantic_settings import SettingsConfigDict
 
+DEFAULT_PYTHON_VERSION = "39"
+PYPI_SIMPLE_URL = "https://pypi.org/simple"
+
 
 class Settings(BaseSettings):
     """
@@ -27,28 +30,30 @@ class Settings(BaseSettings):
         env_prefix="PYINSP_",
         case_sensitive=True,
         extra="allow",
+        # never treat data as JSON
+        enable_decoding=False,
     )
 
     # the default Python version to use if none is provided
-    DEFAULT_PYTHON_VERSION: str = "39"
+    DEFAULT_PYTHON_VERSION: str = DEFAULT_PYTHON_VERSION
 
     # the default OS to use if none is provided
     DEFAULT_OS: str = "linux"
 
-    # a list of PyPI simple index URLs. Use a JSON array to represent multiple URLs
-    INDEX_URL: tuple[str, ...] = ("https://pypi.org/simple",)
+    # a string with a tuple of PyPI simple index URLs, each separated by a space
+    INDEX_URL: tuple[str, ...] = (PYPI_SIMPLE_URL,)
 
     # If True, only uses configured INDEX_URLs listed above and ignore other URLs found in requirements
     USE_ONLY_CONFIGURED_INDEX_URLS: bool = False
 
     # a path string where to store the cached downloads. Will be created if it does not exists.
     CACHE_THIRDPARTY_DIR: str = str(Path(Path.home() / ".cache/python_inspector"))
 
-    @field_validator("INDEX_URL")
+    @field_validator("INDEX_URL", mode="before")
     @classmethod
     def validate_index_url(cls, value):
         if isinstance(value, str):
-            return (value,)
+            return tuple(value.split())
         elif isinstance(value, (tuple, list)):
             return tuple(value)
         else:

tests/data/pinned-pdt-requirements.txt-expected.json

@@ -2,7 +2,6 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/aboutcode-org/python-inspector",
-    "tool_version": "0.13.0",
     "options": [
       "--index-url https://pypi.org/simple",
       "--json-pdt <file>",

tests/data/pinned-requirements.txt-expected.json

@@ -2,7 +2,6 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/aboutcode-org/python-inspector",
-    "tool_version": "0.13.0",
     "options": [
       "--index-url https://pypi.org/simple",
       "--json <file>",