Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion pyrite/schema/field_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ def resolve_filename(self, entry: Entry) -> str | None:
from string import Formatter

data_fields = (
{f.name for f in dataclasses.fields(entry)}
{f.name for f in dataclasses.fields(entry) if not f.name.startswith("_")}
if dataclasses.is_dataclass(entry)
else set()
)
Expand Down Expand Up @@ -334,6 +334,15 @@ def _is_missing(value: Any) -> bool:
"attribute/index access, no positional placeholders); "
"refusing to resolve it"
)
if field_name.startswith("_"):
# Private bookkeeping fields (_schema_version, _create_fields,
# _importance_given, etc.) are internal entry state, not data
# fields, and must not be resolved into file names (#1639).
raise ValidationError(
f"file_pattern {self.file_pattern!r} names {{{field_name}}}, "
f"which is not a data field of entry {entry.id!r} (type "
f"{entry.entry_type!r}); refusing to resolve it"
)
if field_name in data_fields:
value = getattr(entry, field_name, None)
elif field_name in meta:
Expand Down
17 changes: 17 additions & 0 deletions tests/test_file_pattern.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,23 @@ def test_non_data_attribute_placeholder_is_refused(self):
with pytest.raises(ValidationError):
schema.resolve_filename(entry)

def test_private_field_placeholder_is_refused(self):
"""#1639: private bookkeeping fields (_schema_version, _create_fields,
_importance_given, etc.) are internal entry state, not data fields, and
must be refused rather than resolved into file names."""
from pyrite.exceptions import ValidationError

for field_name in (
"_schema_version",
"_create_fields",
"_importance_given",
"_custom_private",
):
schema = TypeSchema(name="adr", file_pattern=f"{{{field_name}}}.md")
entry = self._adr_entry()
with pytest.raises(ValidationError, match="not a data field of entry"):
schema.resolve_filename(entry)

def test_nul_byte_in_resolved_filename_is_refused(self):
from pyrite.exceptions import ValidationError

Expand Down
Loading