Gecko [ renovalkoronred.com.tr ]

Name	Size	Permission
__pycache__	[ DIR ]	drwxr-xr-x
__init__.py	575 B	-rw-r--r--
_check_docs_utils.py	25.74 KB	-rw-r--r--
bad_builtin.py	2.22 KB	-rw-r--r--
broad_try_clause.py	2.25 KB	-rw-r--r--
check_elif.py	2.09 KB	-rw-r--r--
code_style.py	12.51 KB	-rw-r--r--
comparetozero.py	3.09 KB	-rw-r--r--
comparison_placement.py	2.3 KB	-rw-r--r--
confusing_elif.py	1.99 KB	-rw-r--r--
consider_refactoring_into_whil...	3.23 KB	-rw-r--r--
consider_ternary_expression.py	1.66 KB	-rw-r--r--
dict_init_mutate.py	2.06 KB	-rw-r--r--
docparams.py	25.3 KB	-rw-r--r--
docstyle.py	2.87 KB	-rw-r--r--
dunder.py	2.33 KB	-rw-r--r--
empty_comment.py	1.91 KB	-rw-r--r--
emptystring.py	2.9 KB	-rw-r--r--
eq_without_hash.py	1.42 KB	-rw-r--r--
for_any_all.py	5.69 KB	-rw-r--r--
magic_value.py	4.14 KB	-rw-r--r--
mccabe.py	6.89 KB	-rw-r--r--
no_self_use.py	3.62 KB	-rw-r--r--
overlapping_exceptions.py	3.26 KB	-rw-r--r--
private_import.py	10.97 KB	-rw-r--r--
redefined_loop_name.py	3.14 KB	-rw-r--r--
redefined_variable_type.py	4 KB	-rw-r--r--
set_membership.py	1.75 KB	-rw-r--r--
typing.py	19.91 KB	-rw-r--r--
while_used.py	1.07 KB	-rw-r--r--

Code Editor : docstyle.py

# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt

from __future__ import annotations

import linecache
from typing import TYPE_CHECKING

from astroid import nodes

from pylint import checkers
from pylint.checkers.utils import only_required_for_messages
from pylint.interfaces import HIGH

if TYPE_CHECKING:
    from pylint.lint import PyLinter

class DocStringStyleChecker(checkers.BaseChecker):
    """Checks format of docstrings based on PEP 0257."""

name = "docstyle"

msgs = {
        "C0198": (
            'Bad docstring quotes in %s, expected """, given %s',
            "bad-docstring-quotes",
            "Used when a docstring does not have triple double quotes.",
        ),
        "C0199": (
            "First line empty in %s docstring",
            "docstring-first-line-empty",
            "Used when a blank line is found at the beginning of a docstring.",
        ),
    }

@only_required_for_messages("docstring-first-line-empty", "bad-docstring-quotes")
    def visit_module(self, node: nodes.Module) -> None:
        self._check_docstring("module", node)

def visit_classdef(self, node: nodes.ClassDef) -> None:
        self._check_docstring("class", node)

def visit_functiondef(self, node: nodes.FunctionDef) -> None:
        ftype = "method" if node.is_method() else "function"
        self._check_docstring(ftype, node)

visit_asyncfunctiondef = visit_functiondef

def _check_docstring(
        self, node_type: str, node: nodes.Module | nodes.ClassDef | nodes.FunctionDef
    ) -> None:
        docstring = node.doc_node.value if node.doc_node else None
        if docstring and docstring[0] == "\n":
            self.add_message(
                "docstring-first-line-empty",
                node=node,
                args=(node_type,),
                confidence=HIGH,
            )

# Use "linecache", instead of node.as_string(), because the latter
        # looses the original form of the docstrings.

if docstring:
            lineno = node.fromlineno + 1
            line = linecache.getline(node.root().file, lineno).lstrip()
            if line and line.find('"""') == 0:
                return
            if line and "'''" in line:
                quotes = "'''"
            elif line and line[0] == '"':
                quotes = '"'
            elif line and line[0] == "'":
                quotes = "'"
            else:
                quotes = ""
            if quotes:
                self.add_message(
                    "bad-docstring-quotes",
                    node=node,
                    args=(node_type, quotes),
                    confidence=HIGH,
                )

def register(linter: PyLinter) -> None:
    linter.register_checker(DocStringStyleChecker(linter))

${this.title}

Code Editor : docstyle.py