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 <[email protected]>

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",
     ]