コード例 #1
0
def check_docstrings_for_views_dispatch_methods(node: ast.ClassDef,
                                                *args: typing.Any) -> Errors:
    """Проверяет, что dispatch методы вьюх имеют докстринги."""
    if _is_api_view(node) is False:
        return []

    errors = []
    methods_to_check = ['get', 'put', 'post', 'patch', 'delete']

    for function_def in get_classdef_methods(node):
        if function_def.name in methods_to_check:
            errors.extend(check_docstring(function_def))

    return errors
コード例 #2
0
def check_docstrings_for_api_action_handlers(node: ast.ClassDef,
                                             *args: typing.Any) -> Errors:
    """Проверяет, что методы action в апи имеют докстринги."""
    errors = []

    for function_def in get_classdef_methods(node):
        function_has_action_decorator = (
            function_def_has_decorator(function_def, 'action')
            or function_def_has_decorator(function_def, 'drf_action'))

        if function_has_action_decorator:
            errors.extend(check_docstring(function_def))

    return errors
コード例 #3
0
def check_doctstrings_viewsets_dispatch_methods(node: ast.ClassDef,
                                                *args: typing.Any) -> Errors:
    """Проверяет, что dispatch методы вьюсетов имеют докстринги."""
    if _is_api_viewset(node) is False:
        return []

    errors = []
    methods_to_check = [
        'list', 'retrieve', 'create', 'update', 'partial_update', 'delete'
    ]

    for function_def in get_classdef_methods(node):
        if function_def.name in methods_to_check:
            errors.extend(check_docstring(function_def))

    return errors