selfie_lib.CommentTracker.CommentTracker Class Reference

Public Member Functions
	__init__ (self)
Iterable[TypedPath]	paths_with_once (self)
bool	hasWritableComment (self, CallStack call, SnapshotFileLayout layout)

Static Public Member Functions
tuple[str, int]	commentString (TypedPath typedPath)

Public Attributes
	lock

Detailed Description

Definition at line 20 of file CommentTracker.py.

Constructor & Destructor Documentation

__init__()

selfie_lib.CommentTracker.CommentTracker.__init__

(

self

)

Definition at line 21 of file CommentTracker.py.

    def __init__(self):
        self.cache: dict[TypedPath, WritableComment] = {}
        self.lock = threading.Lock()
 

Member Function Documentation

commentString()

tuple[str, int] selfie_lib.CommentTracker.CommentTracker.commentString ( TypedPath  typedPath )

static

Definition at line 44 of file CommentTracker.py.

    def commentString(typedPath: TypedPath) -> tuple[str, int]:
        comment, line = CommentTracker.__commentAndLine(typedPath)
        if comment == WritableComment.NO_COMMENT:
            raise ValueError("No writable comment found")
        elif comment == WritableComment.ONCE:
            return ("#selfieonce", line)
        elif comment == WritableComment.FOREVER:
            return ("#SELFIEWRITE", line)
        else:
            raise ValueError("Invalid comment type")
 

hasWritableComment()

bool selfie_lib.CommentTracker.CommentTracker.hasWritableComment	(		self,
		CallStack	call,
		SnapshotFileLayout	layout
	)

Definition at line 33 of file CommentTracker.py.

    def hasWritableComment(self, call: CallStack, layout: SnapshotFileLayout) -> bool:
        path = layout.sourcefile_for_call(call.location)
        with self.lock:
            if path in self.cache:
                return self.cache[path].writable
            else:
                new_comment, _ = self.__commentAndLine(path)
                self.cache[path] = new_comment
                return new_comment.writable
 

paths_with_once()

Iterable[TypedPath] selfie_lib.CommentTracker.CommentTracker.paths_with_once

(

self

)

Definition at line 25 of file CommentTracker.py.

    def paths_with_once(self) -> Iterable[TypedPath]:
        with self.lock:
            return [
                path
                for path, comment in self.cache.items()
                if comment == WritableComment.ONCE
            ]
 

Member Data Documentation

lock

selfie_lib.CommentTracker.CommentTracker.lock

Definition at line 23 of file CommentTracker.py.

---

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

• selfie-lib/selfie_lib/CommentTracker.py