fmt; fix #132

Author: FredHappyface

licensecheck/io/cli.py

@@ -4,6 +4,7 @@
 
 import argparse
 from dataclasses import fields
+from enum import Enum
 from pathlib import Path
 from sys import exit as sysexit
 from sys import stdin, stdout
@@ -20,6 +21,12 @@
 stdout.reconfigure(encoding="utf-8")  # type: ignore[general-type-issues]
 
 
+class ExitCode(Enum):
+	SUCCESS = 0
+	INCOMPATIBLE_LICENSE = 1
+	NO_PACKAGES = 3
+
+
 def cli() -> None:  # pragma: no cover
 	"""Cli entry point."""
 	parser = argparse.ArgumentParser(description=__doc__, argument_default=argparse.SUPPRESS)
@@ -84,7 +91,7 @@ def cli() -> None:  # pragma: no cover
 	)
 	parser.add_argument(
 		"--skip-dependencies",
-		help="set of packages/dependencies to skip (this sets the 'compatibility' to True)",
+		help="set of packages/dependencies to skip resolving",
 		nargs="+",
 	)
 	parser.add_argument(
@@ -109,9 +116,6 @@ def cli() -> None:  # pragma: no cover
 	)
 	args = vars(parser.parse_args())
 
-	if args.get("format", "simple") not in fmt.FMT:
-		args["format"] = "simple"
-
 	stdin_path = Path("__stdin__")
 	if not args.get("requirements_paths"):
 		if stdin.isatty():
@@ -139,12 +143,12 @@ def cli() -> None:  # pragma: no cover
 	ec = main(licensecheckConf)
 	stdin_path.unlink(missing_ok=True)
 
-	sysexit(ec)
+	sysexit(ec.value)
 
 
-def main(licensecheckConf: LC_Config) -> int:
+def main(licensecheckConf: LC_Config) -> ExitCode:
 	"""Test entry point."""
-	exitCode = 0
+	exitCode = ExitCode.SUCCESS
 
 	# File
 	requirements_paths = licensecheckConf.requirements_paths or {"__stdin__"}
@@ -185,23 +189,23 @@ def main(licensecheckConf: LC_Config) -> int:
 		)
 		raise ValueError(msg)
 
-	if licensecheckConf.format in fmt.FMT:
-		print(
-			fmt.fmt(
-				licensecheckConf.format,
-				this_license,
-				sorted(depsWithLicenses),
-				hide_output_parameters,
-				show_only_failing=licensecheckConf.show_only_failing,
-			),
-			file=output_file,
-		)
-	else:
-		exitCode = 2
+	print(
+		fmt.fmt(
+			licensecheckConf.format,
+			this_license,
+			sorted(depsWithLicenses),
+			hide_output_parameters,
+			show_only_failing=licensecheckConf.show_only_failing,
+		),
+		file=output_file,
+	)
 
 	# Exit code of 1 if args.zero
-	if licensecheckConf.zero and incompatible:
-		exitCode = 1
+	if licensecheckConf.zero:
+		if len(depsWithLicenses) == 0:
+			exitCode = ExitCode.NO_PACKAGES
+		if incompatible:
+			exitCode = ExitCode.INCOMPATIBLE_LICENSE
 
 	# Cleanup + exit
 	if licensecheckConf.file != "":

licensecheck/io/fmt.py

@@ -40,10 +40,10 @@
 from __future__ import annotations
 
 import csv
-from enum import StrEnum, auto
 import json
 import re
 from collections import OrderedDict
+from enum import StrEnum, auto
 from importlib.metadata import PackageNotFoundError, version
 from io import StringIO
 from pathlib import Path
@@ -335,6 +335,7 @@ class FMT(StrEnum):
 	ansi = auto()
 	simple = auto()
 
+
 formatMap = {
 	FMT.json: raw,
 	FMT.markdown: markdown,

licensecheck/models/config.py

@@ -1,9 +1,13 @@
 from __future__ import annotations
 
 from dataclasses import field
+from typing import Any, Literal
+
+from pydantic import field_validator
 
-from licensecheck.models.defaultonnone import DefaultOnNoneModel
 from licensecheck.io.fmt import FMT
+from licensecheck.models.defaultonnone import DefaultOnNoneModel
+
 
 class LC_Config(DefaultOnNoneModel):
 	"""LC_Config type."""
@@ -25,3 +29,10 @@ class LC_Config(DefaultOnNoneModel):
 	only_licenses: set[str] = field(default_factory=set)
 	skip_dependencies: set[str] = field(default_factory=set)
 	hide_output_parameters: set[str] = field(default_factory=set)
+
+	@field_validator("format", mode="before")
+	@classmethod
+	def normalize_format(cls, value: Any) -> Any | Literal[FMT.simple]:
+		if value not in FMT:
+			return FMT.simple
+		return value

licensecheck/packageinforesolver.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from boolean.boolean import Expression
 import configparser
 import contextlib
 import re
@@ -16,6 +15,7 @@
 import license_expression
 import requests
 import tomli
+from boolean.boolean import Expression
 from depgather.parse import gather
 from license_expression import Licensing
 from packaging.requirements import Requirement
@@ -115,15 +115,14 @@ def normalize_license(lice: str) -> str:
 	licensing = Licensing()
 	parsed = None
 	with contextlib.suppress(license_expression.ExpressionParseError):
-		parsed = licensing.parse(
-			re.sub(r"[^a-zA-Z0-9_.:\- ]", "_", lice.splitlines()[0])
-		)
+		parsed = licensing.parse(re.sub(r"[^a-zA-Z0-9_.:\- ]", "_", lice.splitlines()[0]))
 	if parsed is None:
 		return lice
 
 	tokens: list[Expression] = sorted(parsed.literals)
 	return str(JOINS.join(getattr(x, "key", str(x)) for x in tokens))
 
+
 class LocalPackageInfo:
 	"""Handles retrieval of package info from local installation."""
 

tests/io/test_cli_main.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from licensecheck.io.cli import main
+from licensecheck.io.cli import ExitCode, main
 from licensecheck.models.config import LC_Config
 
 
@@ -29,6 +29,28 @@ def config() -> LC_Config:
 	)
 
 
+@pytest.fixture
+def config_invalid_fmt() -> LC_Config:
+	return LC_Config(
+		requirements_paths={"requirements.txt"},
+		file=None,
+		license="MIT",
+		pypi_api=None,
+		groups=set(),
+		extras=set(),
+		ignore_packages=set(),
+		fail_packages=set(),
+		ignore_licenses=set(),
+		fail_licenses=set(),
+		only_licenses=set(),
+		skip_dependencies=set(),
+		hide_output_parameters=set(),
+		format="invalid_format",
+		show_only_failing=False,
+		zero=False,
+	)
+
+
 def test_main_success(
 	config: LC_Config,
 	monkeypatch,
@@ -48,14 +70,13 @@ def test_main_success(
 		lambda *_args, **_kwargs: "output",
 	)
 
-	assert main(config) == 0
+	assert main(config) == ExitCode.SUCCESS
 
 
 def test_main_invalid_format(
-	config: LC_Config,
+	config_invalid_fmt: LC_Config,
 	monkeypatch,
 ) -> None:
-	config.format = "does-not-exist"
 
 	monkeypatch.setattr(
 		"licensecheck.io.cli.checker.check",
@@ -67,16 +88,16 @@ def test_main_invalid_format(
 		{},
 	)
 
-	assert main(config) == 2
+	assert main(config_invalid_fmt) == ExitCode.SUCCESS
 
 
 @pytest.mark.parametrize(
 	("zero", "incompatible", "expected"),
 	[
-		(False, False, 0),
-		(False, True, 0),
-		(True, False, 0),
-		(True, True, 1),
+		(False, False, ExitCode.SUCCESS),
+		(False, True, ExitCode.SUCCESS),
+		(True, False, ExitCode.NO_PACKAGES),
+		(True, True, ExitCode.INCOMPATIBLE_LICENSE),
 	],
 )
 def test_main_exit_code_zero_mode(
@@ -155,7 +176,7 @@ def test_main_valid_hidden_parameters(
 		lambda *_args, **_kwargs: "",
 	)
 
-	assert main(config) == 0
+	assert main(config) == ExitCode.SUCCESS
 
 
 def test_main_passes_args_to_checker(
@@ -214,5 +235,5 @@ def test_main_closes_output_file(
 		lambda *_args, **_kwargs: "hello",
 	)
 
-	assert main(config) == 0
+	assert main(config) == ExitCode.SUCCESS
 	assert output.read_text() == "hello\n"

tests/models/test_config.py

@@ -1,13 +1,13 @@
+import tomli
 
 from licensecheck.io.fmt import FMT
 from licensecheck.models.config import LC_Config
-import tomli
+
 
 def test_no_config() -> None:
 	LC_Config.model_validate({})
 
 
-
 def test_basic_config() -> None:
 	raw_conf = tomli.loads("""
 
@@ -36,7 +36,6 @@ def test_basic_config() -> None:
 	assert conf.pypi_api == "https://pypi.org"
 
 
-
 def test_basic_config2() -> None:
 	raw_conf = tomli.loads("""