chore: some suggestions from copilot

Author: pbastia

bc_obps/common/exceptions.py

@@ -7,9 +7,9 @@ class UserError(Exception):
     pass
 
 
-class SystemError(Exception):
+class InternalSystemError(Exception):
     """
-    Base class for system-related errors.
+    Base class for obps system-related errors.
     These errors are typically used for unexpected conditions that indicate a problem in either
     unforeseen manipulation of the system, or a bug in the code.
     """

bc_obps/reporting/service/report_validation/validators/reporting_configuration_validator.py

@@ -1,3 +1,4 @@
+from common.exceptions import InternalSystemError
 from django.contrib.postgres.aggregates import ArrayAgg
 from django.db.models import OuterRef, QuerySet
 from reporting.models.configuration_element import ConfigurationElement
@@ -33,7 +34,7 @@ def validate_configuration_elements_present(report_version: ReportVersion) -> di
     )
 
     if missing_config.exists():
-        raise SystemError(
+        raise InternalSystemError(
             f"Missing configuration elements for report methodology IDs: {str.join(', ', [str(m['id']) for m in missing_config])}"
         )
 
@@ -71,7 +72,7 @@ def validate(report_version: ReportVersion) -> dict[str, ReportValidationError]:
     Validator ensuring that all the activity data reported has a matching configuration
     defined for the reporting year of the report.
 
-    For each ReportMethodlogy record:
+    For each ReportMethodology record:
     - Collect ReportMethodology -> ReportEmission (Gas Type) -> ReportSourceType -> ReportActivity -> Report (Reporting Year)
     - Validate that there is a ConfigurationElement record matching that combination
     - Validate that the extra reporting fields reported are in that configuration element

bc_obps/reporting/tests/service/report_validation/validators/test_reporting_configuration_validator.py

@@ -1,3 +1,4 @@
+from common.exceptions import InternalSystemError
 from model_bakery.baker import make, make_recipe, prepare_recipe
 import pytest
 from reporting.models.configuration_element import ConfigurationElement
@@ -53,7 +54,7 @@ def test_raises_if_configuration_doesnt_match_reporting_year(self):
         )
 
         with pytest.raises(
-            SystemError,
+            InternalSystemError,
             match=f"Missing configuration elements for report methodology IDs: {report_methodology.id}",
         ):
             self.validator_under_test.validate(self.report_version)
@@ -76,7 +77,7 @@ def test_raises_if_configuration_doesnt_match_activity(self):
         )
 
         with pytest.raises(
-            SystemError,
+            InternalSystemError,
             match=f"Missing configuration elements for report methodology IDs: {report_methodology.id}",
         ):
             self.validator_under_test.validate(self.report_version)
@@ -100,7 +101,7 @@ def test_raises_if_reported_fields_not_allowed_in_configuration_element(self):
         )
 
         with pytest.raises(
-            SystemError,
+            InternalSystemError,
             match=f"ReportMethodology ID {report_methodology.id} has reporting fields"
             " {'unexpectedField'} which are not in the allowed fields {'allowedField'} of its matching configuration element.",
         ):