Class Source

src/_pytest/_code/source.py:16–117

An immutable object holding a source code fragment. When using Source(...), the source lines are deindented.

class Source:
    class="st">"""An immutable object holding a source code fragment.

    When using Source(...), the source lines are deindented.
    class="st">"""

    def __init__(self, obj: object = None) -> None:
        if not obj:
            self.lines: list[str] = []
            self.raw_lines: list[str] = []
        elif isinstance(obj, Source):
            self.lines = obj.lines
            self.raw_lines = obj.raw_lines
        elif isinstance(obj, tuple | list):
            self.lines = deindent(x.rstrip(class="st">"\n") for x in obj)
            self.raw_lines = list(x.rstrip(class="st">"\n") for x in obj)
        elif isinstance(obj, str):
            self.lines = deindent(obj.split(class="st">"\n"))
            self.raw_lines = obj.split(class="st">"\n")
        else:
            try:
                rawcode = getrawcode(obj)
                src = inspect.getsource(rawcode)
            except TypeError:
                src = inspect.getsource(obj)  class="cm"># type: ignore[arg-type]
            self.lines = deindent(src.split(class="st">"\n"))
            self.raw_lines = src.split(class="st">"\n")

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Source):
            return NotImplemented
        return self.lines == other.lines

    class="cm"># Ignore type because of https://github.com/python/mypy/issues/4266.
    __hash__ = None  class="cm"># type: ignore

    @overload
    def __getitem__(self, key: int) -> str: ...

    @overload
    def __getitem__(self, key: slice) -> Source: ...

    def __getitem__(self, key: int | slice) -> str | Source:
        if isinstance(key, int):
            return self.lines[key]
        else:
            if key.step not in (None, 1):
                raise IndexError(class="st">"cannot slice a Source with a step")
            newsource = Source()
            newsource.lines = self.lines[key.start : key.stop]
            newsource.raw_lines = self.raw_lines[key.start : key.stop]
            return newsource

    def __iter__(self) -> Iterator[str]:
        return iter(self.lines)

    def __len__(self) -> int:
        return len(self.lines)