Tools/Scripts/libraries/webkitscmpy/mypy.ini

# Copyright (C) 2026 Apple Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1.  Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2.  Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

[mypy]
python_version = 3.9
strict = True
warn_unused_configs = True
# Only report errors in the package being checked. Other libraries still provide their types.
follow_imports = silent
mypy_path = $MYPY_CONFIG_FILE_DIR:$MYPY_CONFIG_FILE_DIR/../webkitcorepy:$MYPY_CONFIG_FILE_DIR/../webkitbugspy
# Modules that have not been annotated yet (see the ignore_errors section below).
untyped_calls_exclude = webkitscmpy.mocks,webkitscmpy.mocks.local,webkitscmpy.mocks.local.git,webkitscmpy.mocks.local.svn,webkitscmpy.mocks.remote,webkitscmpy.mocks.remote.bitbucket,webkitscmpy.mocks.remote.git_hub,webkitscmpy.mocks.remote.svn,webkitscmpy.program,webkitscmpy.program.apply,webkitscmpy.program.blame,webkitscmpy.program.branch,webkitscmpy.program.canonicalize,webkitscmpy.program.canonicalize.committer,webkitscmpy.program.canonicalize.message,webkitscmpy.program.checkout,webkitscmpy.program.cherry_pick,webkitscmpy.program.classify,webkitscmpy.program.clean,webkitscmpy.program.clone,webkitscmpy.program.command,webkitscmpy.program.commit,webkitscmpy.program.conflict,webkitscmpy.program.create_bug,webkitscmpy.program.credentials,webkitscmpy.program.diff,webkitscmpy.program.diff.diff,webkitscmpy.program.diff.editor_diff,webkitscmpy.program.diff.html_diff,webkitscmpy.program.diff.terminal_diff,webkitscmpy.program.find,webkitscmpy.program.install_git_lfs,webkitscmpy.program.install_hooks,webkitscmpy.program.land,webkitscmpy.program.log,webkitscmpy.program.pickable,webkitscmpy.program.publish,webkitscmpy.program.pull,webkitscmpy.program.pull_request,webkitscmpy.program.revert,webkitscmpy.program.review,webkitscmpy.program.setup,webkitscmpy.program.setup_git_svn,webkitscmpy.program.show,webkitscmpy.program.squash,webkitscmpy.program.trace,webkitscmpy.program.track,webkitscmpy.program.tracker_metadata

# Tests are checked with mypy's defaults, so unannotated tests aren't checked at all.
[mypy-webkitscmpy.test.*]
disallow_untyped_defs = False
disallow_incomplete_defs = False
disallow_untyped_calls = False
disallow_untyped_decorators = False
check_untyped_defs = False
warn_return_any = False
disallow_any_generics = False
disallow_subclassing_any = False
implicit_reexport = True

[mypy-webkitscmpy.mocks.*]
warn_return_any = False
disallow_any_generics = False
disallow_subclassing_any = False

# webkitbugspy is checked by its own mypy test, including that it exports what it provides.
# Importing a name from the package shouldn't depend on that here.
[mypy-webkitbugspy.*]
implicit_reexport = True

[mypy-mypy.*]
follow_imports = skip

[mypy-fasteners.*]
ignore_missing_imports = True

# Tests load git hooks, which aren't modules, by path.
[mypy-prepare_commit_msg]
ignore_missing_imports = True

# Radar's client library is Apple-internal, and isn't available everywhere.
[mypy-radarclient.*]
ignore_missing_imports = True

# AutoInstall only installs these packages once something imports them, so whether mypy can find
# them depends on what ran before. Treat them as untyped everywhere.
[mypy-jinja2.*,rapidfuzz.*]
follow_imports = skip
ignore_missing_imports = True

# These packages' types come from separate stub distributions, which AutoInstall doesn't
# install. Treat them as untyped everywhere, even where their stubs happen to be installed.
[mypy-requests.*,urllib3.*,xmltodict.*,yaml.*]
follow_imports = skip
follow_imports_for_stubs = True
ignore_missing_imports = True

# Modules that have not been annotated yet. Remove modules from this list, and from
# untyped_calls_exclude above, as they're annotated.
[mypy-webkitscmpy.mocks,webkitscmpy.mocks.local,webkitscmpy.mocks.local.git,webkitscmpy.mocks.local.svn,webkitscmpy.mocks.remote,webkitscmpy.mocks.remote.bitbucket,webkitscmpy.mocks.remote.git_hub,webkitscmpy.mocks.remote.svn,webkitscmpy.program,webkitscmpy.program.apply,webkitscmpy.program.blame,webkitscmpy.program.branch,webkitscmpy.program.canonicalize,webkitscmpy.program.canonicalize.committer,webkitscmpy.program.canonicalize.message,webkitscmpy.program.checkout,webkitscmpy.program.cherry_pick,webkitscmpy.program.classify,webkitscmpy.program.clean,webkitscmpy.program.clone,webkitscmpy.program.command,webkitscmpy.program.commit,webkitscmpy.program.conflict,webkitscmpy.program.create_bug,webkitscmpy.program.credentials,webkitscmpy.program.diff,webkitscmpy.program.diff.diff,webkitscmpy.program.diff.editor_diff,webkitscmpy.program.diff.html_diff,webkitscmpy.program.diff.terminal_diff,webkitscmpy.program.find,webkitscmpy.program.install_git_lfs,webkitscmpy.program.install_hooks,webkitscmpy.program.land,webkitscmpy.program.log,webkitscmpy.program.pickable,webkitscmpy.program.publish,webkitscmpy.program.pull,webkitscmpy.program.pull_request,webkitscmpy.program.revert,webkitscmpy.program.review,webkitscmpy.program.setup,webkitscmpy.program.setup_git_svn,webkitscmpy.program.show,webkitscmpy.program.squash,webkitscmpy.program.trace,webkitscmpy.program.track,webkitscmpy.program.tracker_metadata]
ignore_errors = True