Add the BytesSyntaxError class

zeroSteiner · Jun 8, 2024 · 548a6bd · 548a6bd
1 parent b20667a
commit 548a6bd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/source/rule_engine/errors.rst b/docs/source/rule_engine/errors.rst
@@ -24,6 +24,11 @@ Exceptions
    :show-inheritance:
    :special-members: __init__
 
+.. autoexception:: BytesSyntaxError
+   :members:
+   :show-inheritance:
+   :special-members: __init__
+
 .. autoexception:: DatetimeSyntaxError
    :members:
    :show-inheritance:
@@ -100,6 +105,7 @@ The class hierarchy for Rule Engine exceptions is:
          +-- SymbolResolutionError
          +-- SymbolTypeError
     +-- SyntaxError
+         +-- BytesSyntaxError
          +-- DatetimeSyntaxError
          +-- FloatSyntaxError
          +-- RegexSyntaxError

diff --git a/lib/rule_engine/errors.py b/lib/rule_engine/errors.py
@@ -66,6 +66,21 @@ class EvaluationError(EngineError):
 class SyntaxError(EngineError):
 	"""A base error for syntax related issues."""
 
+class BytesSyntaxError(SyntaxError):
+	"""
+	An error raised for issues regarding the use of improperly formatted bytes expressions.
+
+	.. versionadded:: 4.5.0
+	"""
+	def __init__(self, message, value):
+		"""
+		:param str message: A text description of what error occurred.
+		:param str value: The bytes value which contains the syntax error which caused this exception to be raised.
+		"""
+		super(BytesSyntaxError, self).__init__(message)
+		self.value = value
+		"""The bytes value which contains the syntax error which caused this exception to be raised."""
+
 class DatetimeSyntaxError(SyntaxError):
 	"""An error raised for issues regarding the use of improperly formatted datetime expressions."""
 	def __init__(self, message, value):