refactor(settings): Normalize setttings to match pydantic

- Refactored config naming to settings to match pydantic settings
naming structure.
- Enabled .env / .env.prod evaluation capability .
- Add ORTHW_CONFIG_DIR and ORTHW_CONFIG_FILE variables that can be
  evaluated in runtime bypassing as environment file or inside .env.
  The variables are case sensitive.

Signed-off-by: Helio Chissini de Castro <heliocastro@gmail.com>

Author: heliocastro

pyproject.toml

@@ -70,29 +70,6 @@
     types-requests = "^2.32.0.20240622"
 twine = "^5.1.1"
 
-[tool.black]
-    target-version = ["py310"]
-    line-length = 120
-    include = '\.pyi?$'
-    exclude = '''
-(
-  /(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.hg
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | _build
-    | buck-out
-    | build
-    | dist
-  )/
-  | foo.py           # also separately exclude a file named foo.py in
-                     # the root of the project
-)
-'''
-
 [tool.pytest.ini_options]
     addopts = ["--import-mode=importlib"]
     log_cli = true

src/orthw/__init__.py

@@ -16,8 +16,8 @@
 # License-Filename: LICENSE
 from __future__ import annotations
 
-from orthw.utils.config import Config
+from orthw.utils.settings import Settings
 
 """Make config object global
 """
-config: Config = Config()
+settings: Settings = Settings()

src/orthw/commands/analyze.py

@@ -21,7 +21,7 @@
 import click
 from docker.models.containers import Container
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
@@ -56,9 +56,9 @@ def analyze(
     ]
 
     if not docker:
-        if config.ort_config_package_curations_dir.exists():
+        if settings.ort_config_package_curations_dir.exists():
             args.append("--package-curations-dir")
-            args.append(config.ort_config_package_curations_dir.as_posix())
+            args.append(settings.ort_config_package_curations_dir.as_posix())
         else:
             logging.warning("No curations folder available. Running without curations.")
 

src/orthw/commands/clean.py

@@ -16,25 +16,25 @@
 # License-Filename: LICENSE
 from __future__ import annotations
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 
 
 def clean() -> None:
     try:
-        dot_dir = config.configdir
+        dot_dir = settings.configdir
         if dot_dir and dot_dir.is_dir():
             logging.info(f"Removed directory {dot_dir}")
     except OSError:
         logging.error(f"Removing directory {dot_dir}")
     try:
-        config_file = config.repository_configuration_file
+        config_file = settings.repository_configuration_file
         if config_file and config_file.is_file():
             config_file.unlink(missing_ok=True)
             logging.info(f"Removed file {config_file}")
     except OSError:
-        logging.error(f"Error removing directory {config.repository_configuration_file}")
+        logging.error(f"Error removing directory {settings.repository_configuration_file}")
 
 
 @command_group.command(

src/orthw/commands/copyrights.py

@@ -20,7 +20,7 @@
 
 import click
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
@@ -36,9 +36,9 @@ def copyrights(package_id: str = "") -> None:
 
     require_initialized()
 
-    ort_config_copyright_garbage_file: Path = config.ort_config_copyright_garbage_file
-    ort_config_package_configuration_dir: Path = config.ort_config_package_configuration_dir
-    scan_result_file: Path = config.scan_result_file
+    ort_config_copyright_garbage_file: Path = settings.ort_config_copyright_garbage_file
+    ort_config_package_configuration_dir: Path = settings.ort_config_package_configuration_dir
+    scan_result_file: Path = settings.scan_result_file
 
     if not scan_result_file or not ort_config_package_configuration_dir or not ort_config_copyright_garbage_file:
         logging.error("Invalid configuration.")
@@ -57,10 +57,10 @@ def copyrights(package_id: str = "") -> None:
             ort_config_package_configuration_dir.as_posix(),
         ]
 
-        run(args=args, output_file=config.copyrights_file)
+        run(args=args, output_file=settings.copyrights_file)
 
         args += ["--show-raw-statements"]
-        run(args=args, output_file=config.copyrights_debug_file)
+        run(args=args, output_file=settings.copyrights_debug_file)
 
 
 @command_group.command(

src/orthw/commands/evaluate.py

@@ -21,7 +21,7 @@
 import click
 from docker.models.containers import Container
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
@@ -48,21 +48,21 @@ def evaluate(
         "ort",
         "evaluate",
         "--copyright-garbage-file",
-        config.ort_config_copyright_garbage_file.as_posix(),
+        settings.ort_config_copyright_garbage_file.as_posix(),
         "--package-curations-dir",
-        config.ort_config_package_curations_dir.as_posix(),
+        settings.ort_config_package_curations_dir.as_posix(),
         "--output-formats",
         format_,
         "--ort-file",
         ort_file.name,
         "--repository-configuration-file",
-        config.repository_configuration_file.as_posix(),
+        settings.repository_configuration_file.as_posix(),
         "--rules-file",
-        config.ort_config_rules_file.as_posix(),
+        settings.ort_config_rules_file.as_posix(),
         "--license-classifications-file",
-        config.ort_config_license_classifications_file.as_posix(),
+        settings.ort_config_license_classifications_file.as_posix(),
         "--package-configuration-dir",
-        config.ort_config_package_configuration_dir.as_posix(),
+        settings.ort_config_package_configuration_dir.as_posix(),
     ]
 
     # Execute external run

src/orthw/commands/export_copyright_garbage.py

@@ -21,7 +21,7 @@
 
 from rich.pretty import pprint
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
@@ -32,9 +32,9 @@ def export_copyright_garbage() -> None:
     """Command export-copyright-garbage"""
     require_initialized()
 
-    copyrights_file: Path = config.copyrights_file
-    ort_config_copyright_garbage_file: Path = config.ort_config_copyright_garbage_file
-    scan_result_file: Path = config.scan_result_file
+    copyrights_file: Path = settings.copyrights_file
+    ort_config_copyright_garbage_file: Path = settings.ort_config_copyright_garbage_file
+    scan_result_file: Path = settings.scan_result_file
     if (
         copyrights_file.is_file() is None
         or not ort_config_copyright_garbage_file.is_file()
@@ -71,7 +71,7 @@ def export_copyright_garbage() -> None:
         "--input-copyright-garbage-file",
         mapped_copyrights_file.as_posix(),
         "--output-copyright-garbage-file",
-        config.ort_config_copyright_garbage_file.as_posix(),
+        settings.ort_config_copyright_garbage_file.as_posix(),
     ]
     run(args=args)
 

src/orthw/commands/find_license_url.py

@@ -21,7 +21,7 @@
 import click
 import git
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import command_group
 
 
@@ -30,9 +30,9 @@ def find_license_url(license_id: str) -> str:
         key = license_id.strip("LicenseRef-scancode-")
         license_file_path = f"src/licensedcode/data/licenses/{key}.LICENSE"
 
-        license_file: Path = config.scancode_home / license_file_path
+        license_file: Path = settings.scancode_home / license_file_path
         if license_file.exists():
-            git_repo = git.repo.Repo(config.scancode_home.as_posix())
+            git_repo = git.repo.Repo(settings.scancode_home.as_posix())
             revision = git_repo.git.rev_parse("HEAD")
             return f"https://github.com/nexB/scancode-toolkit/blob/{revision}/{license_file_path}"
 

src/orthw/commands/handled_licenses.py

@@ -16,7 +16,7 @@
 # License-Filename: LICENSE
 from __future__ import annotations
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
 
@@ -28,7 +28,7 @@ def handled_licenses() -> None:
         "orth",
         "list-license-categories",
         "--license-classifications-file",
-        config.ort_config_license_classifications_file.as_posix(),
+        settings.ort_config_license_classifications_file.as_posix(),
     ]
 
     run(args)

src/orthw/commands/handled_licenses_by_category.py

@@ -16,7 +16,7 @@
 # License-Filename: LICENSE
 from __future__ import annotations
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
 
@@ -28,7 +28,7 @@ def handled_licenses_by_category() -> None:
         "orth",
         "list-license-categories",
         "--license-classifications-file",
-        config.ort_config_license_classifications_file.as_posix(),
+        settings.ort_config_license_classifications_file.as_posix(),
         "--group-by-category",
     ]
 

src/orthw/commands/init.py

@@ -27,7 +27,7 @@
 import yaml
 from docker.models.containers import Container
 
-from orthw import config
+from orthw import settings
 from orthw.utils import logging
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
@@ -41,7 +41,7 @@ def init(target_url: str) -> int | Container:
     logging.debug(f"filename: {filename}")
     logging.debug(f"extension: {extension}")
 
-    evaluation_md5_sum_file: Path = config.evaluation_md5_sum_file
+    evaluation_md5_sum_file: Path = settings.evaluation_md5_sum_file
     if evaluation_md5_sum_file.exists():
         evaluation_md5_sum_file.unlink()
 
@@ -82,7 +82,7 @@ def init(target_url: str) -> int | Container:
             "orth",
             "extract-repository-configuration",
             "--repository-configuration-file",
-            config.repository_configuration_file.as_posix(),
+            settings.repository_configuration_file.as_posix(),
             "--ort-file",
             scan_result_file.as_posix(),
         ]
@@ -97,7 +97,7 @@ def init(target_url: str) -> int | Container:
             "--ort-file",
             scan_result_file.as_posix(),
             "--scan-results-storage-dir",
-            config.scan_results_storage_dir.as_posix(),
+            settings.scan_results_storage_dir.as_posix(),
         ]
 
         return run(args)

src/orthw/commands/licenses.py

@@ -18,7 +18,7 @@
 
 import click
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
 from orthw.utils.required import require_initialized
@@ -42,9 +42,9 @@ def licenses(package_id: str, source_code_dir: str | None = None) -> None:
         "--omit-excluded",
     ]
 
-    args += ["--ort-file", config.evaluation_result_file.as_posix()]
-    args += ["--repository-configuration-file", config.repository_configuration_file.as_posix()]
-    args += ["--package-configuration-dir", config.ort_config_package_configuration_dir.as_posix()]
+    args += ["--ort-file", settings.evaluation_result_file.as_posix()]
+    args += ["--repository-configuration-file", settings.repository_configuration_file.as_posix()]
+    args += ["--package-configuration-dir", settings.ort_config_package_configuration_dir.as_posix()]
 
     if source_code_dir:
         args += ["--source-code-dir", source_code_dir]

src/orthw/commands/offending_packages.py

@@ -18,7 +18,7 @@
 
 from pathlib import Path
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import command_group
 from orthw.utils.process import run
 from orthw.utils.required import require_initialized
@@ -27,7 +27,7 @@
 def offending_packages() -> None:
     require_initialized()
 
-    scan_result_file: Path = config.scan_result_file
+    scan_result_file: Path = settings.scan_result_file
 
     args: list[str] = [
         "orth",

src/orthw/commands/package_config/clean.py

@@ -20,7 +20,7 @@
 
 import click
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import package_config_group
 from orthw.utils.process import run
 from orthw.utils.required import require_initialized
@@ -30,7 +30,7 @@ def clean(package_id: str) -> None:
     require_initialized()
 
     package_configuration_file = "FIXME find_package(package_id)"
-    scan_result_file: Path = config.scan_result_file
+    scan_result_file: Path = settings.scan_result_file
 
     args: list[str] = [
         "orth",

src/orthw/commands/package_config/create.py

@@ -20,7 +20,7 @@
 
 import click
 
-from orthw import config
+from orthw import settings
 from orthw.utils.cmdgroups import package_config_group
 from orthw.utils.process import run
 from orthw.utils.required import require_initialized
@@ -29,11 +29,11 @@
 def create(package_id: str) -> None:
     require_initialized()
 
-    scan_results_storage_dir: Path = config.scan_results_storage_dir
-    ort_config_license_classifications_file: Path = config.ort_config_license_classifications_file
-    non_offending_license_categories = config.non_offending_license_categories
-    non_offending_license_ids = config.non_offending_license_ids
-    ort_config_package_configurations_dir: Path = config.ort_config_package_configurations_dir
+    scan_results_storage_dir: Path = settings.scan_results_storage_dir
+    ort_config_license_classifications_file: Path = settings.ort_config_license_classifications_file
+    non_offending_license_categories = settings.non_offending_license_categories
+    non_offending_license_ids = settings.non_offending_license_ids
+    ort_config_package_configurations_dir: Path = settings.ort_config_package_configurations_dir
 
     args: list[str] = [
         "orth",
@@ -70,10 +70,10 @@ def create(package_id: str) -> None:
 
         orthw package-config create Maven:org.apache.curator:curator-framework:2.13.0
     """.format(
-        dir=config.ort_config_package_configurations_dir,
+        dir=settings.ort_config_package_configurations_dir,
     ),
     short_help=f"Creates one package configuration in '{dir}' for given package id.".format(
-        dir=config.ort_config_package_configurations_dir,
+        dir=settings.ort_config_package_configurations_dir,
     ),
 )
 @click.argument("package_id")