Fix the record field name validator regex (#151)

The original regex allowed a literal "[]" at the end of a name, which breaks using the name as Python identifier.
fox-it · Nov 11, 2024 · 941f2cb · 941f2cb
1 parent c17dc6b
commit 941f2cb
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/flow/record/base.py b/flow/record/base.py
@@ -89,7 +89,7 @@
 RECORDSTREAM_MAGIC = b"RECORDSTREAM\n"
 RECORDSTREAM_MAGIC_DEPTH = 4 + 2 + len(RECORDSTREAM_MAGIC)
 
-RE_VALID_FIELD_NAME = re.compile(r"^_?[a-zA-Z][a-zA-Z0-9_]*(?:\[\])?$")
+RE_VALID_FIELD_NAME = re.compile(r"^_?[a-zA-Z][a-zA-Z0-9_]*$")
 RE_VALID_RECORD_TYPE_NAME = re.compile("^[a-zA-Z][a-zA-Z0-9_]*(/[a-zA-Z][a-zA-Z0-9_]*)*$")
 
 RECORD_CLASS_TEMPLATE = """

diff --git a/tests/test_regression.py b/tests/test_regression.py
@@ -316,6 +316,8 @@ def test_mixed_case_name():
     assert is_valid_field_name("Test")
     assert is_valid_field_name("test")
     assert is_valid_field_name("TEST")
+    assert not is_valid_field_name("test[]")
+    assert not is_valid_field_name("_test")
 
     TestRecord = RecordDescriptor(
         "Test/Record",