Skip to content

position

position

Contains tools for expressing positions in text.

Position dataclass

Position of token in text in pyparsing scheme (lines starts from 1, columns also start from 1).

Source code in src/pygerber/common/position.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@dataclass
class Position:
    """Position of token in text in pyparsing scheme (lines starts from 1,
    columns also start from 1).
    """

    line: int
    column: int

    @classmethod
    def from_vscode_position(cls, line: int, character: int) -> Self:
        """Return position in pyparsing scheme from vscode scheme (lines starts from 0,
        columns starts from 0).
        """
        return cls(line + 1, character + 1)

    def to_lspt(self) -> lspt.Position:
        """Return position in pyparsing scheme from vscode scheme (lines starts from 1,
        columns starts from 1).
        """
        return lspt.Position(line=self.line - 1, character=self.column - 1)

    def offset(self, line: int, column: int) -> Self:
        """Create new Position offset by line and column."""
        return self.__class__(self.line + line, self.column + column)

    def __str__(self) -> str:
        return f"[line: {self.line}, col: {self.column}]"

    def __eq__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line == __value.line and self.column == __value.column

    def __ne__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line != __value.line and self.column != __value.column

    def __gt__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line > __value.line or (
            self.line == __value.line and self.column > __value.column
        )

    def __ge__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line >= __value.line or (
            self.line == __value.line and self.column >= __value.column
        )

    def __lt__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line < __value.line or (
            self.line == __value.line and self.column < __value.column
        )

    def __le__(self, __value: object) -> bool:
        if not isinstance(__value, self.__class__):
            return NotImplemented
        return self.line <= __value.line or (
            self.line == __value.line and self.column <= __value.column
        )

from_vscode_position classmethod 

from_vscode_position(line: int, character: int) -> Self

Return position in pyparsing scheme from vscode scheme (lines starts from 0, columns starts from 0).

Source code in src/pygerber/common/position.py 
29
30
31
32
33
34
@classmethod
def from_vscode_position(cls, line: int, character: int) -> Self:
    """Return position in pyparsing scheme from vscode scheme (lines starts from 0,
    columns starts from 0).
    """
    return cls(line + 1, character + 1)

to_lspt 

to_lspt() -> lspt.Position

Return position in pyparsing scheme from vscode scheme (lines starts from 1, columns starts from 1).

Source code in src/pygerber/common/position.py 
36
37
38
39
40
def to_lspt(self) -> lspt.Position:
    """Return position in pyparsing scheme from vscode scheme (lines starts from 1,
    columns starts from 1).
    """
    return lspt.Position(line=self.line - 1, character=self.column - 1)

offset 

offset(line: int, column: int) -> Self

Create new Position offset by line and column.

Source code in src/pygerber/common/position.py 
42
43
44
def offset(self, line: int, column: int) -> Self:
    """Create new Position offset by line and column."""
    return self.__class__(self.line + line, self.column + column)