cbpr-usage-rules 0.3.0__tar.gz → 0.4.0__tar.gz

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0}/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0]
+
+### Added
+- List only the **enforceable** rules for a year + message type:
+  `list_rules(year, msgtype, enforced_only=True)` in the API and
+  `cbpr-validate --enforced --year … --type …` on the CLI (advisory rules omitted;
+  composes with `--json`).
+
 ## [0.3.0]
 
 ### Added

{cbpr_usage_rules-0.3.0/src/cbpr_usage_rules.egg-info → cbpr_usage_rules-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cbpr-usage-rules
-Version: 0.3.0
+Version: 0.4.0
 Summary: Validate ISO 20022 CBPR+ XML messages against SWIFT usage (business) rules.
 Author: Pete Houghton
 License: MIT License
@@ -258,11 +258,13 @@ matching is by local name, so namespace prefixes never matter.
 ```python
 cbpr_rules.available(2025)              # -> ['camt.052', 'pacs.008', ...]
 cbpr_rules.list_rules(2025, "pacs.008") # -> [{rule_number, name, description, severity, enforced}, ...]
+cbpr_rules.list_rules(2025, "pacs.008", enforced_only=True)  # only the enforceable rules
 ```
 
 ```bash
 cbpr-validate --year 2025 --list-types
-cbpr-validate --year 2025 --type pacs.008 --list
+cbpr-validate --year 2025 --type pacs.008 --list               # all rules
+cbpr-validate --year 2025 --type pacs.008 --enforced           # enforceable rules only
 ```
 
 ### Algorithmic field validation

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0}/README.md

@@ -203,11 +203,13 @@ matching is by local name, so namespace prefixes never matter.
 ```python
 cbpr_rules.available(2025)              # -> ['camt.052', 'pacs.008', ...]
 cbpr_rules.list_rules(2025, "pacs.008") # -> [{rule_number, name, description, severity, enforced}, ...]
+cbpr_rules.list_rules(2025, "pacs.008", enforced_only=True)  # only the enforceable rules
 ```
 
 ```bash
 cbpr-validate --year 2025 --list-types
-cbpr-validate --year 2025 --type pacs.008 --list
+cbpr-validate --year 2025 --type pacs.008 --list               # all rules
+cbpr-validate --year 2025 --type pacs.008 --enforced           # enforceable rules only
 ```
 
 ### Algorithmic field validation

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0}/src/cbpr_rules/__init__.py

@@ -4,7 +4,7 @@ This package is AI generated. See the README for details and caveats.
 """
 from __future__ import annotations
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 from .models import Rule, Severity, Violation
 from .engine import (

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0}/src/cbpr_rules/cli.py

@@ -77,6 +77,12 @@ def _build_parser() -> argparse.ArgumentParser:
         action="store_true",
         help="List the rules for --year/--type instead of validating.",
     )
+    p.add_argument(
+        "--enforced",
+        action="store_true",
+        help="List only the enforceable (mechanically-checked) rules for --year/--type; "
+        "advisory rules are omitted. Implies --list.",
+    )
     p.add_argument(
         "--list-types", action="store_true", help="List message types available for --year."
     )
@@ -216,11 +222,11 @@ def main(argv: Optional[List[str]] = None) -> int:
             return 2
         return 0
 
-    if args.list:
+    if args.list or args.enforced:
         if args.year is None or args.msgtype is None:
             print("error: --year and --type are required for --list", file=sys.stderr)
             return 2
-        rules = list_rules(args.year, args.msgtype)
+        rules = list_rules(args.year, args.msgtype, enforced_only=args.enforced)
         if args.json:
             print(json.dumps(rules, indent=2))
         else:

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0}/src/cbpr_rules/engine.py

@@ -95,9 +95,16 @@ def validate_string(xml: str, year: int, msgtype: Optional[str] = None, xsd=None
     return _validate_tree(tree, year, msgtype, xsd)
 
 
-def list_rules(year: int, msgtype: str) -> List[dict]:
-    """Return metadata for every rule registered for a (year, message type)."""
-    return [r.to_dict() for r in load_rules(year, msgtype)]
+def list_rules(year: int, msgtype: str, enforced_only: bool = False) -> List[dict]:
+    """Return metadata for the rules registered for a (year, message type).
+
+    With ``enforced_only=True`` only the enforceable (mechanically-checked) rules
+    are returned, omitting advisory/catalogue-only ones.
+    """
+    rules = [r.to_dict() for r in load_rules(year, msgtype)]
+    if enforced_only:
+        rules = [r for r in rules if r["enforced"]]
+    return rules
 
 
 def available(year: int) -> List[str]:

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.4.0/src/cbpr_usage_rules.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cbpr-usage-rules
-Version: 0.3.0
+Version: 0.4.0
 Summary: Validate ISO 20022 CBPR+ XML messages against SWIFT usage (business) rules.
 Author: Pete Houghton
 License: MIT License
@@ -258,11 +258,13 @@ matching is by local name, so namespace prefixes never matter.
 ```python
 cbpr_rules.available(2025)              # -> ['camt.052', 'pacs.008', ...]
 cbpr_rules.list_rules(2025, "pacs.008") # -> [{rule_number, name, description, severity, enforced}, ...]
+cbpr_rules.list_rules(2025, "pacs.008", enforced_only=True)  # only the enforceable rules
 ```
 
 ```bash
 cbpr-validate --year 2025 --list-types
-cbpr-validate --year 2025 --type pacs.008 --list
+cbpr-validate --year 2025 --type pacs.008 --list               # all rules
+cbpr-validate --year 2025 --type pacs.008 --enforced           # enforceable rules only
 ```
 
 ### Algorithmic field validation