[WIP] Split clinic.py into smaller files

[vstinner]

[vstinner]

@erlend-aasland: Here is a PR based on https://github.com/Argument-Clinic/cpython main branch which splits Argument Clinic into sub-files. I created it to discuss how we can reorganize the code.

I didn't try to group related code at all. I just splitted clinic.py into smaller pieces, that's all.

Main outside changes:

• Rename Tools/clinic/libclinic/ to Tools/clinic/clinic/
• Add Tools/clinic/clinic/__main__.py (not used by the Makefile)
• Rename Tools/clinic/clinic.py to Tools/clinic/run_clinic.py (the one run by make clinic).

I'm not sure how to handle imports. For example, dslparser.py starts with:

from __future__ import annotations
import ast
import enum
import inspect
import re
import shlex
import pprint
import sys
from typing import Any, NamedTuple
from collections.abc import Callable
from types import FunctionType, NoneType
from typing import TYPE_CHECKING

import clinic
from clinic import (
    fail, warn, VersionTuple, ClinicError, unknown, unspecified, NULL)
from clinic.block_parser import Block
from clinic.function import (
    Module, Class, Function, Parameter, FunctionKind,
    METHOD_NEW, METHOD_INIT, GETTER, SETTER, CALLABLE,
    CLASS_METHOD, STATIC_METHOD)
from clinic.converter import converters, legacy_converters
from clinic.converters import (
    self_converter, correct_name_for_self, defining_class_converter)
from clinic.return_converters import (
    CReturnConverter, return_converters, int_return_converter)
from clinic.parser import create_parser_namespace
if TYPE_CHECKING:
    from clinic.clinic_class import Clinic

test_clinic.py imports directly classes and functions:

test_tools.skip_if_missing('clinic')
with test_tools.imports_under_tool('clinic'):
    import clinic
    from clinic import (
        suffix_all_lines, normalize_snippet,
        indent_all_lines, format_escape, docstring_for_c_string)
    from clinic.cpp import Monitor
    from clinic import ClinicError
    from clinic.dslparser import DSLParser
    from clinic.option_groups import (
        permute_optional_groups, permute_left_option_groups,
        permute_right_option_groups)
    from clinic.cli import parse_file
    from clinic.clinic_class import Clinic
    from clinic.clanguage import CLanguage
    from clinic.converters import self_converter, str_converter, int_converter
    from clinic.return_converters import int_return_converter
    from clinic.block_parser import Block, BlockParser
    from clinic.block_printer import BlockPrinter, Destination
    from clinic.function import (
        Module, Class, Function, FunctionKind, Parameter)

I see clinic as an application, and so it might only expose main() and that's it. Similar API to pip. But I'm open to discussion.

cc @serhiy-storchaka

[vstinner]

Only in terms of classes, my PR creates the following organization.

clinic.block_parser

• Block
• BlockParser

clinic.block_printer

• BlockPrinter
• BufferSeries
• Destination

clinic.clanguage

• CLanguage

clinic.clinic_class

• Clinic

clinic.converter

• CConverterAutoRegister
• CConverter

clinic.converters

• bool_converter
• defining_class_converter
• char_converter
• unsigned_char_converter
• byte_converter
• short_converter
• unsigned_short_converter
• int_converter
• unsigned_int_converter
• long_converter
• unsigned_long_converter
• long_long_converter
• unsigned_long_long_converter
• Py_ssize_t_converter
• slice_index_converter
• size_t_converter
• fildes_converter
• float_converter
• double_converter
• Py_complex_converter
• object_converter
• buffer pass
• rwbuffer pass
• robuffer pass
• str_converter
• PyBytesObject_converter
• PyByteArrayObject_converter
• unicode_converter
• Py_UNICODE_converter
• Py_buffer_converter
• self_converter

clinic.cpp

• Monitor

clinic.crenderdata

• CRenderData
• Include

clinic.dslparser

• FunctionNames
• IndentStack
• ParamState
• DSLParser

clinic.errors

• ClinicError
• ParseError

clinic.function

• Module
• Class
• FunctionKind
• Function
• Parameter

clinic.language

• Language
• PythonLanguage

clinic.parser

• Parser

clinic.parsers

• PythonParser

clinic.return_converters

• CReturnConverter
• CReturnConverterAutoRegister
• Py_ssize_t_return_converter
• bool_return_converter
• double_return_converter
• float_return_converter
• int_return_converter
• long_return_converter
• size_t_return_converter
• unsigned_int_return_converter
• unsigned_long_return_converter

clinic.utils

• FormatCounterFormatter
• Sentinels
• Null

[vstinner]

This PR was merged as smaller changes in the Python main branch.