remove fhconfparser and replace with configurator

FredHappyface · FredHappyface · commit 392f230544f3 · 2025-03-26T23:55:27.000Z
diff --git a/README.md b/README.md
@@ -35,7 +35,6 @@ the project license
 - [Configuration Example](#configuration-example)
 	- [Example 1: pyproject.toml](#example-1-pyprojecttoml)
 	- [Example 2: licensecheck.json](#example-2-licensecheckjson)
-	- [Example 3: licensecheck.ini](#example-3-licensecheckini)
 - [Documentation](#documentation)
 - [Install With PIP](#install-with-pip)
 - [Language information](#language-information)
@@ -215,51 +214,63 @@ in the DOCS
 
 ## Configuration Example
 
-Configuration files are parsed in the following order: `pyproject.toml`,
-`setup.cfg`, `licensecheck.toml`, `licensecheck.json`, `licensecheck.ini`,
-`~/licensecheck.toml`, `~/licensecheck.json`, `~/licensecheck.ini`
+Configuration files are parsed in the following order: `pyproject.toml`, `setup.cfg`,
+ `licensecheck.toml`, `licensecheck.json`, `~/licensecheck.toml`, `~/licensecheck.json`,
 
 - ⚠ All config files are parsed, however configuration defined in previous files takes precedent
 
-Add optional path to requirements.txt as outlined in
-https://github.com/FHPythonUtils/LicenseCheck/issues/9#issuecomment-898878228
-for example: `licensecheck --using requirements:c:/path/to/reqs.txt;path/to/other/reqs.txt`
 
 ### Example 1: pyproject.toml
 
-The following config is equivalent to `licensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json`
-
 ```toml
+
 [tool.licensecheck]
-using = "requirements:requirements.txt;requirements_optional.txt"
-format = "json"
+license = "mit"               # Specify the project license explicitly
+format = "simple"             # Output format (e.g., "json", "csv", etc.)
+requirements_paths = []       # List of filenames to read from
+groups = []                   # List of selected groups
+extras = []                   # List of selected extras
+file = ""                     # Output file (leave empty for stdout)
+ignore_packages = []          # Packages/dependencies to ignore
+fail_packages = []            # Packages/dependencies that cause failure
+ignore_licenses = []          # Licenses to ignore
+fail_licenses = []            # Licenses that cause failure
+only_licenses = []            # Allowed licenses (all others will fail)
+skip_dependencies = []        # Dependencies to skip (compatibility = True)
+hide_output_parameters = []   # Parameters to hide from output
+show_only_failing = false     # Show only incompatible/failing packages
+pypi_api = "https://pypi.org" # Custom PyPI API endpoint
+zero = false                  # Return non-zero exit code for incompatible licenses (for CI/CD)
+
 ```
 
 ### Example 2: licensecheck.json
 
-The following config is equivalent to `licensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json`
-
 ```json
 {
-	"tool": {
-		"licensecheck": {
-			"using": "requirements:requirements.txt;requirements_optional.txt",
-			"format": "json"
-		}
-	}
+  "tool": {
+    "licensecheck": {
+      "extras": [],
+      "fail_licenses": [],
+      "fail_packages": [],
+      "file": "",
+      "format": "simple",
+      "groups": [],
+      "hide_output_parameters": [],
+      "ignore_licenses": [],
+      "ignore_packages": [],
+      "license": "mit",
+      "only_licenses": [],
+      "pypi_api": "https://pypi.org",
+      "requirements_paths": [],
+      "show_only_failing": false,
+      "skip_dependencies": [],
+      "zero": false
+    }
+  }
 }
 ```
 
-### Example 3: licensecheck.ini
-
-The following config is equivalent to `licensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json`
-
-```ini
-[licensecheck]
-using = "requirements:requirements.txt;requirements_optional.txt"
-format = "json"
-```
-
 ## Documentation
 
 A high-level overview of how the documentation is organized organized will help you know
diff --git a/licensecheck/cli.py b/licensecheck/cli.py
@@ -9,8 +9,9 @@
 from pathlib import Path
 from sys import exit as sysexit
 from sys import stdin, stdout
-
-from fhconfparser import FHConfParser, SimpleConf
+from configurator import Config
+from configurator.node import ConfigNode
+from pathlib import Path
 
 from licensecheck import checker, fmt, license_matrix, packageinfo, types
 
@@ -129,26 +130,29 @@ def main(args: dict) -> int:
 	"""
 	exitCode = 0
 
-	configparser = FHConfParser()
-	namespace = ["tool"]
-	configparser.parseConfigList(
-		[("pyproject.toml", "toml"), ("setup.cfg", "ini")]
-		+ [
-			(f"{directory}/licensecheck.{ext}", ext)
-			for ext in ("toml", "json", "ini")
-			for directory in [".", str(Path.home())]
-		],
-		namespace,
-		namespace,
-	)
-	simpleConf = SimpleConf(configparser, "licensecheck", args)
+	config: ConfigNode = Config()
+
+	config_files = [
+		"~/licensecheck.json",
+		"~/licensecheck.toml",
+		"licensecheck.json",
+		"licensecheck.toml",
+		"setup.cfg",
+		"pyproject.toml",
+	]
+
+	for file in config_files:
+		config += Config.from_path(file, optional=True)
+
+	scopedData: ConfigNode = config.get("tool", default={}).get("licensecheck", default=ConfigNode())
+	scopedConfig = {**scopedData.data, **args}
 
 	# File
-	requirements_paths = simpleConf.get("requirements_paths") or ["__stdin__"]
+	requirements_paths = scopedConfig.get("requirements_paths") or ["__stdin__"]
 	output_file = (
 		stdout
-		if simpleConf.get("file") is None
-		else Path(simpleConf.get("file")).open("w", encoding="utf-8")
+		if scopedConfig.get("file") in [None, ""]
+		else Path(scopedConfig.get("file")).open("w", encoding="utf-8")
 	)
 
 	# Get my license
@@ -158,14 +162,14 @@ def main(args: dict) -> int:
 	this_license = license_matrix.licenseType(this_license_text)[0]
 
 	def getFromConfig(key: str) -> list[types.ucstr]:
-		return list(map(types.ucstr, simpleConf.get(key, [])))
+		return list(map(types.ucstr, scopedConfig.get(key, [])))
 
-	package_info_manager = packageinfo.PackageInfoManager(simpleConf.get("pypi_api"))
+	package_info_manager = packageinfo.PackageInfoManager(scopedConfig.get("pypi_api"))
 
 	incompatible, depsWithLicenses = checker.check(
 		requirements_paths=requirements_paths,
-		groups=simpleConf.get("groups", []),
-		extras=simpleConf.get("extras", []),
+		groups=scopedConfig.get("groups", []),
+		extras=scopedConfig.get("extras", []),
 		this_license=this_license,
 		package_info_manager=package_info_manager,
 		ignore_packages=getFromConfig("ignore_packages"),
@@ -177,18 +181,20 @@ def getFromConfig(key: str) -> list[types.ucstr]:
 	)
 
 	# Format the results
-	hide_output_parameters = [types.ucstr(x) for x in simpleConf.get("hide_output_parameters", [])]
+	hide_output_parameters = [
+		types.ucstr(x) for x in scopedConfig.get("hide_output_parameters", [])
+	]
 	available_params = [param.name.upper() for param in fields(types.PackageInfo)]
 	if not all(hop in available_params for hop in hide_output_parameters):
 		msg = (
 			f"Invalid parameter(s) in `hide_output_parameters`. "
 			f"Valid parameters are: {', '.join(available_params)}"
 		)
 		raise ValueError(msg)
-	if simpleConf.get("format", "simple") in fmt.formatMap:
+	if scopedConfig.get("format", "simple") in fmt.formatMap:
 		print(
 			fmt.fmt(
-				simpleConf.get("format", "simple"),
+				scopedConfig.get("format", "simple"),
 				this_license,
 				sorted(depsWithLicenses),
 				hide_output_parameters,
@@ -200,10 +206,10 @@ def getFromConfig(key: str) -> list[types.ucstr]:
 		exitCode = 2
 
 	# Exit code of 1 if args.zero
-	if simpleConf.get("zero", False) and incompatible:
+	if scopedConfig.get("zero", False) and incompatible:
 		exitCode = 1
 
 	# Cleanup + exit
-	if simpleConf.get("file") is not None:
+	if scopedConfig.get("file") not in [None, ""]:
 		output_file.close()
 	return exitCode
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,18 +21,18 @@ classifiers = [
 	"Topic :: Utilities",
 ]
 dependencies = [
-    "appdirs>=1.4.4",
-    "fhconfparser>=2024.1",
-    "license-expression>=30.4.1",
-    "loguru>=0.7.3",
-    "markdown>=3.7",
-    "packaging>=24.2",
-    "requests>=2.32.3",
-    "requests-cache>=1.2.1",
-    "requirements-parser>=0.11.0",
-    "rich>=13.9.4",
-    "tomli>=2.2.1",
-    "uv>=0.6.8",
+	"appdirs>=1.4.4",
+	"configurator>=3.2.0",
+	"license-expression>=30.4.1",
+	"loguru>=0.7.3",
+	"markdown>=3.7",
+	"packaging>=24.2",
+	"requests>=2.32.3",
+	"requests-cache>=1.2.1",
+	"requirements-parser>=0.11.0",
+	"rich>=13.9.4",
+	"tomli>=2.2.1",
+	"uv>=0.6.8",
 ]
 
 [project.urls]
@@ -45,13 +45,13 @@ licensecheck = "licensecheck:cli"
 
 [dependency-groups]
 dev = [
-    "coverage>=7.6.12",
-    "handsdown>=2.1.0",
-    "pyright>=1.1.396",
-    "pytest>=8.3.5",
-    "pytest-loguru>=0.4.0",
-    "ruff>=0.11.0",
-    "safety>=3.3.1",
+	"coverage>=7.6.12",
+	"handsdown>=2.1.0",
+	"pyright>=1.1.396",
+	"pytest>=8.3.5",
+	"pytest-loguru>=0.4.0",
+	"ruff>=0.11.0",
+	"safety>=3.3.1",
 ]
 
 [tool.ruff]
@@ -62,13 +62,13 @@ target-version = "py38"
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-	"COM812",  # enforce trailing comma
-	"D2",  # pydocstyle formatting
+	"COM812", # enforce trailing comma
+	"D2",     # pydocstyle formatting
 	"ISC001",
-	"N",  # pep8 naming
+	"N",      # pep8 naming
 	"PLR09",  # pylint refactor too many
-	"TCH",  # type check blocks
-	"W191"  # ignore this to allow tabs
+	"TCH",    # type check blocks
+	"W191",   # ignore this to allow tabs
 ]
 fixable = ["ALL"]
 
@@ -88,15 +88,32 @@ venvPath = "."
 venv = ".venv"
 
 [tool.licensecheck]
+license = "mit"               # Specify the project license explicitly
+format = "simple"             # Output format (e.g., "json", "csv", etc.)
+requirements_paths = []       # List of filenames to read from
+groups = []                   # List of selected groups
+extras = []                   # List of selected extras
+file = ""                     # Output file (leave empty for stdout)
+ignore_packages = []          # Packages/dependencies to ignore
+fail_packages = []            # Packages/dependencies that cause failure
+ignore_licenses = []          # Licenses to ignore
+fail_licenses = []            # Licenses that cause failure
+only_licenses = []            # Allowed licenses (all others will fail)
+skip_dependencies = []        # Dependencies to skip (compatibility = True)
+hide_output_parameters = []   # Parameters to hide from output
+show_only_failing = false     # Show only incompatible/failing packages
+pypi_api = "https://pypi.org" # Custom PyPI API endpoint
+zero = false                  # Return non-zero exit code for incompatible licenses (for CI/CD)
+
 
 [tool.tox]
 legacy_tox_ini = """
 [tox]
 env_list =
-	py311
+	py313
+	py312
 	py310
 	py39
-	py38
 
 [testenv]
 deps = pytest
diff --git a/tests/data/test_issue_112.txt b/tests/data/test_issue_112.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_issue_112_expected.txt b/tests/data/test_issue_112_expected.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_main_tc1.txt b/tests/data/test_main_tc1.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_main_tc1_expected.txt b/tests/data/test_main_tc1_expected.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_main_tc3.txt b/tests/data/test_main_tc3.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_main_tc3_expected.txt b/tests/data/test_main_tc3_expected.txt
@@ -20,7 +20,7 @@
 │ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
 │ ✔          │ charset-normalizer  │ MIT LICENSE                           │
 │ ✔          │ colorama            │ BSD LICENSE                           │
-│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ configurator        │ MIT LICENSE                           │
 │ ✔          │ idna                │ BSD LICENSE                           │
 │ ✔          │ license-expression  │ APACHE-2.0                            │
 │ ✔          │ loguru              │ MIT LICENSE                           │
diff --git a/tests/data/test_main_tc4.json b/tests/data/test_main_tc4.json
@@ -63,9 +63,9 @@
 			"errorCode": 0
 		},
 		{
-			"name": "fhconfparser",
-			"homePage": "https://github.com/FHPythonUtils/FHConfParser",
-			"author": "FredHappyface",
+			"name": "configurator",
+			"homePage": "https://github.com/Simplistix/configurator",
+			"author": "Chris Withers",
 			"license": "MIT LICENSE",
 			"licenseCompat": true,
 			"errorCode": 0
diff --git a/tests/data/test_main_tc4_expected.json b/tests/data/test_main_tc4_expected.json
@@ -63,9 +63,9 @@
 			"errorCode": 0
 		},
 		{
-			"name": "fhconfparser",
-			"homePage": "https://github.com/FHPythonUtils/FHConfParser",
-			"author": "FredHappyface",
+			"name": "configurator",
+			"homePage": "https://github.com/Simplistix/configurator",
+			"author": "Chris Withers",
 			"license": "MIT LICENSE",
 			"licenseCompat": true,
 			"errorCode": 0
