mypyc/options.py

from __future__ import annotations

import sys


class CompilerOptions:
    def __init__(
        self,
        strip_asserts: bool = False,
        multi_file: bool = False,
        verbose: bool = False,
        separate: bool = False,
        target_dir: str | None = None,
        include_runtime_files: bool | None = None,
        capi_version: tuple[int, int] | None = None,
        python_version: tuple[int, int] | None = None,
        strict_dunder_typing: bool = False,
        group_name: str | None = None,
        log_trace: bool = False,
        depends_on_librt_internal: bool = False,
        experimental_features: bool = False,
        strict_traceback_checks: bool = False,
    ) -> None:
        self.strip_asserts = strip_asserts
        self.multi_file = multi_file
        self.verbose = verbose
        self.separate = separate
        self.global_opts = not separate
        self.target_dir = target_dir or "build"
        self.include_runtime_files = (
            include_runtime_files if include_runtime_files is not None else not multi_file
        )
        # The target Python C API version. Overriding this is mostly
        # useful in IR tests, since there's no guarantee that
        # binaries are backward compatible even if no recent API
        # features are used.
        self.capi_version = capi_version or sys.version_info[:2]
        self.python_version = python_version
        # Make possible to inline dunder methods in the generated code.
        # Typically, the convention is the dunder methods can return `NotImplemented`
        # even when its return type is just `bool`.
        # By enabling this option, this convention is no longer valid and the dunder
        # will assume the return type of the method strictly, which can lead to
        # more optimization opportunities.
        self.strict_dunders_typing = strict_dunder_typing
        # Override the automatic group name derived from the hash of module names.
        # This affects the names of generated .c, .h and shared library files.
        # This is only supported when compiling exactly one group, and a shared
        # library is generated (with shims). This can be used to make the output
        # file names more predictable.
        self.group_name = group_name
        # If enabled, write a trace log of events based on executed operations to
        # mypyc_trace.txt when compiled module is executed. This is useful for
        # performance analysis.
        self.log_trace = log_trace
        # If enabled, add capsule imports of librt.internal API. This should be used
        # only for mypy itself, third-party code compiled with mypyc should not use
        # librt.internal.
        self.depends_on_librt_internal = depends_on_librt_internal
        # Some experimental features are only available when building librt in
        # experimental mode (e.g. use _experimental suffix in librt run test).
        # These can't be used with a librt wheel installed from PyPI.
        self.experimental_features = experimental_features
        # If enabled, mypyc will assert that every traceback it generates has a
        # positive line number.
        # Currently each AST node is assigned line number -1 by default to indicate
        # that it's unset. If the line number is never set and a traceback is
        # generated that points at such node, then the line number will be interpreted
        # as None instead of an integer by Python and potentially crash code that
        # expects an integer, such as pytest.
        # The goal is to prevent the incorrect tracebacks but it will require a lot
        # of changes across mypyc. In the meantime, this option should be enabled in
        # tests to make sure that no new code which leads to incorrect tracebacks is
        # added.
        self.strict_traceback_checks = strict_traceback_checks