selfie_lib.WriteTracker.InlineWriteTracker Class Reference

Inheritance diagram for selfie_lib.WriteTracker.InlineWriteTracker:

Public Member Functions
bool	hasWrites (self)
	record (self, LiteralValue snapshot, CallStack call, SnapshotFileLayout layout)
	persist_writes (self, SnapshotFileLayout layout)
Public Member Functions inherited from selfie_lib.WriteTracker.WriteTracker
	__init__ (self)
	recordInternal (self, T key, U snapshot, CallStack call, SnapshotFileLayout layout, bool allow_multiple_equivalent_writes=True)
Public Member Functions inherited from selfie_lib.WriteTracker.CallLocation
	__init__ (self, Optional[str] file_name, int line)
Optional[str]	file_name (self)
int	line (self)
"CallLocation"	with_line (self, int line)
str	ide_link (self, "SnapshotFileLayout" _)
bool	same_path_as (self, "CallLocation" other)
str	source_filename_without_extension (self)
bool	__lt__ (self, other)
bool	__eq__ (self, other)
	__hash__ (self)
Public Member Functions inherited from selfie_lib.Literals.LiteralValue
None	__init__ (self, Optional[T] expected, T actual, "LiteralFormat" fmt)

Public Attributes
	writes
Public Attributes inherited from selfie_lib.WriteTracker.WriteTracker
	lock
Public Attributes inherited from selfie_lib.Literals.LiteralValue
	expected
	actual
	format

Additional Inherited Members
Protected Attributes inherited from selfie_lib.WriteTracker.CallLocation
	_file_name
	_line

Detailed Description

Definition at line 168 of file WriteTracker.py.

Member Function Documentation

hasWrites()

bool selfie_lib.WriteTracker.InlineWriteTracker.hasWrites

(

self

)

Definition at line 169 of file WriteTracker.py.

    def hasWrites(self) -> bool:
        return len(self.writes) > 0
 

persist_writes()

selfie_lib.WriteTracker.InlineWriteTracker.persist_writes	(		self,
		SnapshotFileLayout	layout
	)

Definition at line 204 of file WriteTracker.py.

    def persist_writes(self, layout: SnapshotFileLayout):
        # Assuming there is at least one write to process
        if not self.writes:
            return
 
        # Sorting writes based on file name and line number
        sorted_writes = sorted(
            self.writes.values(),
            key=lambda x: (x.call_stack.location.file_name, x.call_stack.location.line),
        )
 
        # Initialize from the first write
        first_write = sorted_writes[0]
        current_file = layout.sourcefile_for_call(first_write.call_stack.location)
        content = SourceFile(current_file.name, layout.fs.file_read(current_file))
        delta_line_numbers = 0
 
        for write in sorted_writes:
            # Determine the file path for the current write
            file_path = layout.sourcefile_for_call(write.call_stack.location)
            # If we switch to a new file, write changes to the disk for the previous file
            if file_path != current_file:
                layout.fs.file_write(current_file, content.as_string)
                current_file = file_path
                content = SourceFile(
                    current_file.name, layout.fs.file_read(current_file)
                )
                delta_line_numbers = 0
 
            # Calculate the line number taking into account changes that shifted line numbers
            line = write.call_stack.location.line + delta_line_numbers
            if isinstance(write.snapshot.format, LiteralTodoStub):
                kind: TodoStub = write.snapshot.actual  # type: ignore
                content.replace_on_line(line, f".{kind.name}_TODO(", f".{kind.name}(")
            else:
                to_be_literal = content.parse_to_be_like(line)
                # Attempt to set the literal value and adjust for line shifts due to content changes
                literal_change = to_be_literal.set_literal_and_get_newline_delta(
                    write.snapshot
                )
                delta_line_numbers += literal_change
 
        # Final write to disk for the last file processed
        layout.fs.file_write(current_file, content.as_string)
 
 

record()

selfie_lib.WriteTracker.InlineWriteTracker.record	(		self,
		LiteralValue	snapshot,
		CallStack	call,
		SnapshotFileLayout	layout
	)

Definition at line 172 of file WriteTracker.py.

    ):
        super().recordInternal(call.location, snapshot, call, layout)
 
        file = layout.sourcefile_for_call(call.location)
 
        if (
            snapshot.expected is not None
            and isinstance(snapshot.expected, str)
            and isinstance(snapshot.format, LiteralString)
        ):
            content = SourceFile(file.name, layout.fs.file_read(file))
            try:
                snapshot = cast(LiteralValue, snapshot)
                parsed_value = content.parse_to_be_like(
                    call.location.line
                ).parse_literal(snapshot.format)
            except Exception as e:
                raise AssertionError(
                    f"Error while parsing the literal at {call.location.ide_link(layout)}. Please report this error at https://github.com/diffplug/selfie"
                ) from e
            if parsed_value != snapshot.expected:
                raise layout.fs.assert_failed(
                    f"Selfie cannot modify the literal at {call.location.ide_link(layout)} because Selfie has a parsing bug. Please report this error at https://github.com/diffplug/selfie",
                    snapshot.expected,
                    parsed_value,
                )
 

Member Data Documentation

writes

selfie_lib.WriteTracker.InlineWriteTracker.writes

Definition at line 170 of file WriteTracker.py.

---

The documentation for this class was generated from the following file:

• selfie-lib/selfie_lib/WriteTracker.py