selfie_lib.SnapshotSystem.Mode Class Reference

Inheritance diagram for selfie_lib.SnapshotSystem.Mode:

Public Member Functions
bool	can_write (self, bool is_todo, CallStack call, SnapshotSystem system)
str	msg_snapshot_not_found (self)
str	msg_snapshot_not_found_no_such_file (self, file)
str	msg_snapshot_mismatch (self, str expected, str actual)
str	msg_snapshot_mismatch_binary (self, bytes expected, bytes actual)
str	msg (self, str headline)

Static Public Attributes
	interactive = auto()
	readonly = auto()
	overwrite = auto()

Protected Member Functions
str	_to_quoted_printable (self, bytes byte_data)

Detailed Description

Definition at line 99 of file SnapshotSystem.py.

Member Function Documentation

_to_quoted_printable()

str selfie_lib.SnapshotSystem.Mode._to_quoted_printable (   self, bytes  byte_data  )

protected

Definition at line 137 of file SnapshotSystem.py.

    def _to_quoted_printable(self, byte_data: bytes) -> str:
        result = []
        for b in byte_data:
            # b is already an integer in [0..255] when iterating through a bytes object
            if 33 <= b <= 126 and b != 61:  # '=' is ASCII 61, so skip it
                result.append(chr(b))
            else:
                # Convert to uppercase hex, pad to 2 digits, and prepend '='
                result.append(f"={b:02X}")
        return "".join(result)
 

can_write()

bool selfie_lib.SnapshotSystem.Mode.can_write	(		self,
		bool	is_todo,
		CallStack	call,
		SnapshotSystem	system
	)

Definition at line 104 of file SnapshotSystem.py.

    def can_write(self, is_todo: bool, call: CallStack, system: SnapshotSystem) -> bool:
        if self == Mode.interactive:
            return is_todo or system.source_file_has_writable_comment(call)
        elif self == Mode.readonly:
            if system.source_file_has_writable_comment(call):
                layout = system.layout
                path = layout.sourcefile_for_call(call.location)
                comment, line = CommentTracker.commentString(path)
                raise system.fs.assert_failed(
                    f"Selfie is in readonly mode, so `{comment}` is illegal at {call.location.with_line(line).ide_link(layout)}"
                )
            return False
        elif self == Mode.overwrite:
            return True
        else:
            raise ValueError(f"Unknown mode: {self}")
 

msg()

str selfie_lib.SnapshotSystem.Mode.msg	(		self,
		str	headline
	)

Definition at line 148 of file SnapshotSystem.py.

    def msg(self, headline: str) -> str:
        if self == Mode.interactive:
            return (
                f"{headline}\n"
                "- update this snapshot by adding `_TODO` to the function name\n"
                "- update all snapshots in this file by adding `#selfieonce` or `#SELFIEWRITE`"
            )
        elif self == Mode.readonly:
            return headline
        elif self == Mode.overwrite:
            return f"{headline}\n(didn't expect this to ever happen in overwrite mode)"
        else:
            raise ValueError(f"Unknown mode: {self}")

msg_snapshot_mismatch()

str selfie_lib.SnapshotSystem.Mode.msg_snapshot_mismatch	(		self,
		str	expected,
		str	actual
	)

Definition at line 127 of file SnapshotSystem.py.

    def msg_snapshot_mismatch(self, expected: str, actual: str) -> str:  # noqa: ARG002
        return self.msg(
            "Snapshot mismatch (error msg could be better https://github.com/diffplug/selfie/issues/501)"
        )
 

msg_snapshot_mismatch_binary()

str selfie_lib.SnapshotSystem.Mode.msg_snapshot_mismatch_binary	(		self,
		bytes	expected,
		bytes	actual
	)

Definition at line 132 of file SnapshotSystem.py.

    def msg_snapshot_mismatch_binary(self, expected: bytes, actual: bytes) -> str:
        return self.msg_snapshot_mismatch(
            self._to_quoted_printable(expected), self._to_quoted_printable(actual)
        )
 

msg_snapshot_not_found()

str selfie_lib.SnapshotSystem.Mode.msg_snapshot_not_found

(

self

)

Definition at line 121 of file SnapshotSystem.py.

    def msg_snapshot_not_found(self) -> str:
        return self.msg("Snapshot not found")
 

msg_snapshot_not_found_no_such_file()

str selfie_lib.SnapshotSystem.Mode.msg_snapshot_not_found_no_such_file	(		self,
			file
	)

Definition at line 124 of file SnapshotSystem.py.

    def msg_snapshot_not_found_no_such_file(self, file) -> str:
        return self.msg(f"Snapshot not found: no such file {file}")
 

Member Data Documentation

interactive

selfie_lib.SnapshotSystem.Mode.interactive = auto()

static

Definition at line 100 of file SnapshotSystem.py.

overwrite

selfie_lib.SnapshotSystem.Mode.overwrite = auto()

static

Definition at line 102 of file SnapshotSystem.py.

readonly

selfie_lib.SnapshotSystem.Mode.readonly = auto()

static

Definition at line 101 of file SnapshotSystem.py.

---

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

• selfie-lib/selfie_lib/SnapshotSystem.py