Skip to content

diagnostic

diagnostic

Container for diagnostic info.

Location

Bases: FrozenGeneralModel

Represents a location inside a resource, such as a line inside a text file.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class Location(FrozenGeneralModel):
    """Represents a location inside a resource, such as a line
    inside a text file.
    """

    uri: str

    range: Range

    def __repr__(self) -> str:
        return f"{self.uri}:{self.range!r}"

    def to_lspt(self) -> lspt.Location:
        """Convert to corresponding language server protocol type."""
        return lspt.Location(uri=self.uri, range=self.range.to_lspt())

to_lspt 

to_lspt() -> lspt.Location

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
35
36
37
def to_lspt(self) -> lspt.Location:
    """Convert to corresponding language server protocol type."""
    return lspt.Location(uri=self.uri, range=self.range.to_lspt())

DiagnosticRelatedInformation

Bases: FrozenGeneralModel

Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g when duplicating a symbol in a scope.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class DiagnosticRelatedInformation(FrozenGeneralModel):
    """Represents a related message and source code location for a diagnostic. This
    should be used to point to code locations that cause or related to a diagnostics,
    e.g when duplicating a symbol in a scope.
    """

    location: Location
    """The location of this related diagnostic information."""

    message: str
    """The message of this related diagnostic information."""

    def to_lspt(self) -> lspt.DiagnosticRelatedInformation:
        """Convert to corresponding language server protocol type."""
        return lspt.DiagnosticRelatedInformation(
            location=self.location.to_lspt(),
            message=self.message,
        )

location instance-attribute 

location: Location

The location of this related diagnostic information.

message instance-attribute 

message: str

The message of this related diagnostic information.

to_lspt 

to_lspt() -> lspt.DiagnosticRelatedInformation

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
52
53
54
55
56
57
def to_lspt(self) -> lspt.DiagnosticRelatedInformation:
    """Convert to corresponding language server protocol type."""
    return lspt.DiagnosticRelatedInformation(
        location=self.location.to_lspt(),
        message=self.message,
    )

CodeDescription

Bases: FrozenGeneralModel

Structure to capture a description for an error code.

@since 3.16.0

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class CodeDescription(FrozenGeneralModel):
    """Structure to capture a description for an error code.

    @since 3.16.0
    """

    # Since: 3.16.0

    href: str
    """An URI to open with more information about the diagnostic error."""

    def to_lspt(self) -> lspt.CodeDescription:
        """Convert to corresponding language server protocol type."""
        return lspt.CodeDescription(href=self.href)

href instance-attribute 

href: str

An URI to open with more information about the diagnostic error.

to_lspt 

to_lspt() -> lspt.CodeDescription

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
71
72
73
def to_lspt(self) -> lspt.CodeDescription:
    """Convert to corresponding language server protocol type."""
    return lspt.CodeDescription(href=self.href)

DiagnosticSeverity

Bases: int, Enum

The diagnostic's severity.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@enum.unique
class DiagnosticSeverity(int, enum.Enum):
    """The diagnostic's severity."""

    Error = 1
    """Reports an error."""
    Warning = 2
    """Reports a warning."""
    Information = 3
    """Reports an information."""
    Hint = 4
    """Reports a hint."""

    def to_lspt(self) -> lspt.DiagnosticSeverity:
        """Convert to corresponding language server protocol type."""
        return lspt.DiagnosticSeverity(self.value)

Error class-attribute instance-attribute 

Error = 1

Reports an error.

Warning class-attribute instance-attribute 

Warning = 2

Reports a warning.

Information class-attribute instance-attribute 

Information = 3

Reports an information.

Hint class-attribute instance-attribute 

Hint = 4

Reports a hint.

to_lspt 

to_lspt() -> lspt.DiagnosticSeverity

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
89
90
91
def to_lspt(self) -> lspt.DiagnosticSeverity:
    """Convert to corresponding language server protocol type."""
    return lspt.DiagnosticSeverity(self.value)

Range

Bases: FrozenGeneralModel

A range in a text document expressed as (zero-based) start and end positions.

If you want to specify a range that contains a line including the line ending character(s) then use an end position denoting the start of the next line. For example: 

{
    start: { line: 5, character: 23 }
    end : { line 6, character : 0 }
}

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class Range(FrozenGeneralModel):
    """A range in a text document expressed as (zero-based) start and end positions.

    If you want to specify a range that contains a line including the line ending
    character(s) then use an end position denoting the start of the next line.
    For example:
    ```ts
    {
        start: { line: 5, character: 23 }
        end : { line 6, character : 0 }
    }
    ```
    """

    start: Position
    """The range's start position."""

    end: Position
    """The range's end position."""

    def __repr__(self) -> str:
        return f"{self.start!r}-{self.end!r}"

    def to_lspt(self) -> lspt.Range:
        """Convert to corresponding language server protocol type."""
        return lspt.Range(start=self.start.to_lspt(), end=self.end.to_lspt())

start instance-attribute 

start: Position

The range's start position.

end instance-attribute 

end: Position

The range's end position.

to_lspt 

to_lspt() -> lspt.Range

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
117
118
119
def to_lspt(self) -> lspt.Range:
    """Convert to corresponding language server protocol type."""
    return lspt.Range(start=self.start.to_lspt(), end=self.end.to_lspt())

DiagnosticTag

Bases: int, Enum

The diagnostic tags.

@since 3.15.0

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@enum.unique
class DiagnosticTag(int, enum.Enum):
    """The diagnostic tags.

    @since 3.15.0
    """

    # Since: 3.15.0
    Unnecessary = 1
    """Unused or unnecessary code.

    Clients are allowed to render diagnostics with this tag faded out instead of having
    an error squiggle."""
    Deprecated = 2
    """Deprecated or obsolete code.

    Clients are allowed to rendered diagnostics with this tag strike through."""

    def to_lspt(self) -> lspt.DiagnosticTag:
        """Convert to corresponding language server protocol type."""
        return lspt.DiagnosticTag(self.value)

Unnecessary class-attribute instance-attribute 

Unnecessary = 1

Unused or unnecessary code.

Clients are allowed to render diagnostics with this tag faded out instead of having an error squiggle.

Deprecated class-attribute instance-attribute 

Deprecated = 2

Deprecated or obsolete code.

Clients are allowed to rendered diagnostics with this tag strike through.

to_lspt 

to_lspt() -> lspt.DiagnosticTag

Convert to corresponding language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
140
141
142
def to_lspt(self) -> lspt.DiagnosticTag:
    """Convert to corresponding language server protocol type."""
    return lspt.DiagnosticTag(self.value)

Diagnostic

Bases: FrozenGeneralModel

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
class Diagnostic(FrozenGeneralModel):
    """Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
    are only valid in the scope of a resource.
    """

    range: Range
    """The range at which the message applies"""

    message: str
    """The diagnostic's message. It usually appears in the user interface"""

    severity: Optional[DiagnosticSeverity] = Field(default=None)
    """The diagnostic's severity. Can be omitted. If omitted it is up to the
    client to interpret diagnostics as error, warning, info or hint."""

    code: Optional[Union[int, str]] = Field(default=None)
    """The diagnostic's code, which usually appear in the user interface."""

    code_description: Optional[CodeDescription] = Field(default=None)
    """An optional property to describe the error code.
    Requires the code field (above) to be present/not null.

    @since 3.16.0"""
    # Since: 3.16.0

    source: Optional[str] = Field(default=None)
    """A human-readable string describing the source of this
    diagnostic, e.g. 'typescript' or 'super lint'. It usually
    appears in the user interface."""

    tags: Optional[List[DiagnosticTag]] = Field(default=None)
    """Additional metadata about the diagnostic.

    @since 3.15.0"""
    # Since: 3.15.0

    related_information: Optional[List[DiagnosticRelatedInformation]] = Field(
        default=None,
    )
    """An array of related diagnostic information, e.g. when symbol-names within
    a scope collide all definitions can be marked via this property."""

    data: Optional[Any] = Field(default=None)
    """A data entry field that is preserved between a `textDocument/publishDiagnostics`
    notification and `textDocument/codeAction` request.

    @since 3.16.0"""

    def to_lspt(self) -> lspt.Diagnostic:
        """Repack into language server protocol type."""
        return lspt.Diagnostic(
            range=self.range.to_lspt(),
            message=self.message,
            severity=(
                lspt.DiagnosticSeverity(self.severity.value) if self.severity else None
            ),
            code=self.code,
            code_description=(
                self.code_description.to_lspt() if self.code_description else None
            ),
            source=self.source,
            tags=[t.to_lspt() for t in self.tags] if self.tags is not None else None,
            related_information=(
                [i.to_lspt() for i in self.related_information]
                if self.related_information is not None
                else None
            ),
        )

range instance-attribute 

range: Range

The range at which the message applies

message instance-attribute 

message: str

The diagnostic's message. It usually appears in the user interface

severity class-attribute instance-attribute 

severity: Optional[DiagnosticSeverity] = Field(default=None)

The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

code class-attribute instance-attribute 

code: Optional[Union[int, str]] = Field(default=None)

The diagnostic's code, which usually appear in the user interface.

code_description class-attribute instance-attribute 

code_description: Optional[CodeDescription] = Field(
    default=None
)

An optional property to describe the error code. Requires the code field (above) to be present/not null.

@since 3.16.0

source class-attribute instance-attribute 

source: Optional[str] = Field(default=None)

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.

tags class-attribute instance-attribute 

tags: Optional[List[DiagnosticTag]] = Field(default=None)

Additional metadata about the diagnostic.

@since 3.15.0

related_information class-attribute instance-attribute 

related_information: Optional[
    List[DiagnosticRelatedInformation]
] = Field(default=None)

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

data class-attribute instance-attribute 

data: Optional[Any] = Field(default=None)

A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.

@since 3.16.0

to_lspt 

to_lspt() -> lspt.Diagnostic

Repack into language server protocol type.

Source code in src\pygerber\gerberx3\linter\diagnostic.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def to_lspt(self) -> lspt.Diagnostic:
    """Repack into language server protocol type."""
    return lspt.Diagnostic(
        range=self.range.to_lspt(),
        message=self.message,
        severity=(
            lspt.DiagnosticSeverity(self.severity.value) if self.severity else None
        ),
        code=self.code,
        code_description=(
            self.code_description.to_lspt() if self.code_description else None
        ),
        source=self.source,
        tags=[t.to_lspt() for t in self.tags] if self.tags is not None else None,
        related_information=(
            [i.to_lspt() for i in self.related_information]
            if self.related_information is not None
            else None
        ),
    )