pyproject.toml

[build-system]
requires = ["setuptools>=70.1"]
build-backend = "setuptools.build_meta"

[project]
name = "ardupilot_methodic_configurator"
authors = [
    {name = "Amilcar do Carmo Lucas", email = "amilcar.lucas@iav.de"},
]
maintainers = [
    {name = "Amilcar do Carmo Lucas", email = "amilcar.lucas@iav.de"},
]
description = "A clear configuration sequence for ArduPilot vehicles"
readme = {file = "README.md", content-type = "text/markdown"}
requires-python = ">=3.11"
keywords = ["ArduPilot", "Configuration", "SCM", "Methodic", "ArduCopter", "ArduPlane", "ArduRover", "ArduSub"]
license = "GPL-3.0-or-later"
license-files = ["LICENSE.md", "LICENSES/*.txt", "credits/CREDITS.md"]

classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: Manufacturing",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Natural Language :: Chinese (Simplified)",
    "Natural Language :: German",
    "Natural Language :: Portuguese",
    "Natural Language :: Italian",
    "Natural Language :: Japanese",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Software Development :: Embedded Systems",
    "Topic :: System :: Installation/Setup",
    "Topic :: Scientific/Engineering",
    "Typing :: Typed",
]

dependencies = [
    "argcomplete==3.7.2",
    "certifi==2026.10.19",
    "defusedxml==0.7.1",
    "jsonschema==4.26.0",
    "matplotlib==3.10.3; python_version < '3.14'",
    "matplotlib==3.10.9; python_version >= '3.14' and python_version < '3.15'",
    "matplotlib==3.11.2; python_version >= '3.15'",
    "numpy==2.0.2; python_version < '3.13'",
    "numpy==2.3.4; python_version >= '3.13' and python_version < '3.15'",
    "numpy==2.5.4; python_version >= '3.15'",
    "pillow==13.0.0",
    "pip_system_certs==5.3",
    "platformdirs==4.13.0",
    "pymavlink==2.4.50",
    "pyserial==3.5",
    "requests==2.34.2",
    "screeninfo==0.8.1",
    "selenium==4.51.0",
    "simpleeval==1.0.8",
]

dynamic = ["version"]

[project.optional-dependencies]
dev = [
    "coverage==7.16.2",
    "mock==5.2.0",
    "mypy==2.4.0",
    "pre-commit==4.7.0",
    "pylint==4.1.3",
    "pyautogui==0.9.54",
    "pyright==1.1.414",
    "pytest==9.1.1",
    "pytest-cov==7.1.0",
    "pytest-md==0.2.0",
    "pytest-mock==3.17.0",
    "pytest-timeout==2.4.0",
    "python-gettext==5.0",
    "ruff==0.17.3",
    "types-requests==2.33.0.20261006",
    "ty==0.0.89",
]

ci_headless_tests = [
    "pytest-xvfb==3.1.1",
]

mutation = [
    "mutmut==3.8.0",
]

scripts = [
    "bs4==0.0.2",
    "psutil==7.2.2",
    "webdriver_manager==4.1.2",
]

pypi_dist = [
    "build==1.6.1",
    "packaging==26.3",
    "setuptools==84.1.0",
]

win_dist = [
    "pip==26.2.1",
    "pywin32==312",
    "pyinstaller==6.20.0; python_full_version < '3.14.7'",
    "pyinstaller==6.22.3; python_full_version >= '3.14.7'",
    "pyinstaller-hooks-contrib==2026.6; python_full_version < '3.14.7'",
    "pyinstaller-hooks-contrib==2026.8; python_full_version >= '3.14.7'",
    "packaging==26.3",
]

mac_dist = [
    "pip==26.2.1",
    "pyinstaller==6.20.0; python_full_version < '3.14.7'",
    "pyinstaller==6.22.3; python_full_version >= '3.14.7'",
    "pyinstaller-hooks-contrib==2026.6; python_full_version < '3.14.7'",
    "pyinstaller-hooks-contrib==2026.8; python_full_version >= '3.14.7'",
    "packaging==26.3",
]

linux_dist = [
    "pip==26.2.1",
    "pyinstaller==6.20.0; python_full_version < '3.14.7'",
    "pyinstaller==6.22.3; python_full_version >= '3.14.7'",
    "pyinstaller-hooks-contrib==2026.6; python_full_version < '3.14.7'",
    "pyinstaller-hooks-contrib==2026.8; python_full_version >= '3.14.7'",
    "packaging==26.3",
]

[project.scripts]
ardupilot_methodic_configurator = "ardupilot_methodic_configurator.__main__:main"
extract_param_defaults = "ardupilot_methodic_configurator.extract_param_defaults:main"
annotate_params = "ardupilot_methodic_configurator.annotate_params:main"
param_pid_adjustment_update = "ardupilot_methodic_configurator.param_pid_adjustment_update:main"
mavftp = "ardupilot_methodic_configurator.backend_mavftp:main"
amc_mavftp = "ardupilot_methodic_configurator.frontend_tkinter_file_browser:main"
amc_parameter_compare_and_upload = "ardupilot_methodic_configurator.frontend_tkinter_parameter_compare_and_upload:main"
amc_parameter_export = "ardupilot_methodic_configurator.frontend_tkinter_parameter_export:main"
amc_mavlink_inspector = "ardupilot_methodic_configurator.frontend_tkinter_mavlink_inspector:main"
amc_firmware_upload = "ardupilot_methodic_configurator.frontend_tkinter_firmware_upload:main"

[project.entry-points."argcomplete.completers"]
ardupilot_methodic_configurator = "ardupilot_methodic_configurator.__main__:create_argument_parser"
extract_param_defaults = "ardupilot_methodic_configurator.extract_param_defaults:create_argument_parser"
annotate_params = "ardupilot_methodic_configurator.annotate_params:create_argument_parser"
param_pid_adjustment_update = "ardupilot_methodic_configurator.param_pid_adjustment_update:create_argument_parser"
mavftp = "ardupilot_methodic_configurator.backend_mavftp:create_argument_parser"
amc_mavftp = "ardupilot_methodic_configurator.frontend_tkinter_file_browser:create_argument_parser"
amc_parameter_compare_and_upload = "ardupilot_methodic_configurator.frontend_tkinter_parameter_compare_and_upload:create_argument_parser"
amc_parameter_export = "ardupilot_methodic_configurator.frontend_tkinter_parameter_export:create_argument_parser"
amc_mavlink_inspector = "ardupilot_methodic_configurator.frontend_tkinter_mavlink_inspector:create_argument_parser"
amc_firmware_upload = "ardupilot_methodic_configurator.frontend_tkinter_firmware_upload:create_argument_parser"

[project.urls]
homepage = "https://ardupilot.github.io/MethodicConfigurator/"
documentation = "https://github.com/ArduPilot/MethodicConfigurator/blob/master/USERMANUAL.md"
issues = "https://github.com/ArduPilot/MethodicConfigurator/issues"
source = "https://github.com/ArduPilot/MethodicConfigurator"
forum = "https://discuss.ardupilot.org/t/new-ardupilot-methodic-configurator-gui/115038/"
chat = "https://discord.com/invite/ArduPilot"
download = "https://github.com/ArduPilot/MethodicConfigurator/releases"
changelog = "https://github.com/ArduPilot/MethodicConfigurator/releases"

[tool.uv]
required-version = ">=0.12.6"

[tool.setuptools]
# Discover the application and its subpackages; specify data via package-data.
include-package-data = false

[tool.setuptools.packages.find]
include = ["ardupilot_methodic_configurator*"]

[tool.setuptools.package-data]
ardupilot_methodic_configurator = ["**/*.param", "**/*.png", "**/*.jpg", "**/*.json", "**/*.xml", "**/*.mo"]

[tool.setuptools.dynamic]
version = {attr = "ardupilot_methodic_configurator.__version__"}

[tool.codespell]
check-filenames = true
ignore-words-list = "datas,intoto,juli,laf,ned,parm,sade,sitl,thst,sie,mot,carisma,ine,InE"
skip = "*.pdef.xml,*.pdf,*.po"

[tool.mutmut]
source_paths = ["ardupilot_methodic_configurator/"]
# Cover parameter handling, parsing, calculations, and every plugin backend/data model.
only_mutate = [
    # Globs keep new plugin backends and data models in scope automatically.
    "ardupilot_methodic_configurator/plugins/backend_*.py",
    "ardupilot_methodic_configurator/plugins/data_model_*.py",
    # External parameter selection, file-upload policy, atomic writes, and diagnostics.
    "ardupilot_methodic_configurator/data_model_parameter_compare_and_upload.py",
    "ardupilot_methodic_configurator/data_model_file_upload.py",
    "ardupilot_methodic_configurator/backend_safe_file_io.py",
    "ardupilot_methodic_configurator/data_model_fc_diagnostics.py",
    # Shared implementations used by telemetry and calibration plugins.
    "ardupilot_methodic_configurator/backend_data_telemetry.py",
    "ardupilot_methodic_configurator/backend_esc_telemetry.py",
    "ardupilot_methodic_configurator/backend_mavlink_telemetry.py",
    "ardupilot_methodic_configurator/backend_radio_status.py",
    "ardupilot_methodic_configurator/backend_flightcontroller_commands.py",
    "ardupilot_methodic_configurator/data_model_data_telemetry.py",
    "ardupilot_methodic_configurator/data_model_esc_telemetry.py",
    "ardupilot_methodic_configurator/data_model_mavlink_inspector.py",
    "ardupilot_methodic_configurator/data_model_configuration_step.py",
    "ardupilot_methodic_configurator/data_model_parameter_upgrade.py",
    "ardupilot_methodic_configurator/backend_flightcontroller_business_logic.py",
    "ardupilot_methodic_configurator/data_model_transfer_progress.py",
    "ardupilot_methodic_configurator/data_model_safe_evaluator.py",
    "ardupilot_methodic_configurator/battery_cell_voltages.py",
    "ardupilot_methodic_configurator/data_model_ardupilot_parameter.py",
    "ardupilot_methodic_configurator/data_model_par_dict.py",
    "ardupilot_methodic_configurator/backend_flightcontroller_bootloader.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_display.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_validation.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_base.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_templates.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_import.py",
    "ardupilot_methodic_configurator/data_model_vehicle_components_json_schema.py",
    "ardupilot_methodic_configurator/backend_firmware_upload.py",
    "ardupilot_methodic_configurator/frontend_tkinter_usage_popup_windows.py",
    "ardupilot_methodic_configurator/frontend_tkinter_log_analysis.py",
    "ardupilot_methodic_configurator/backend_flightcontroller_connection.py",
    "ardupilot_methodic_configurator/frontend_tkinter_fc_banner_window.py",
    "ardupilot_methodic_configurator/frontend_tkinter_mavlink_inspector.py",
    "ardupilot_methodic_configurator/log_analysis/data_model_plane_landing.py",
    "ardupilot_methodic_configurator/log_analysis/data_model_availability_imu.py",
    "ardupilot_methodic_configurator/log_analysis/data_model_availability_esc.py",
    "ardupilot_methodic_configurator/log_analysis/data_model_firmware_version.py",
    "ardupilot_methodic_configurator/log_analysis/data_model_parameter_history.py",
    "ardupilot_methodic_configurator/plugins/imu_helpers.py",
    "ardupilot_methodic_configurator/data_model_firmware_upload.py",
    "ardupilot_methodic_configurator/log_analysis/backend_log_analysis.py",
    "ardupilot_methodic_configurator/frontend_tkinter_usage_popup_window.py",
    "ardupilot_methodic_configurator/frontend_tkinter_file_browser.py",
    "ardupilot_methodic_configurator/frontend_tkinter_file_browser_tasks.py",
    "ardupilot_methodic_configurator/frontend_tkinter_parameter_editor_table.py",
    "ardupilot_methodic_configurator/plugins/frontend_tkinter_motor_test.py",
    "ardupilot_methodic_configurator/backend_filesystem_json_with_schema.py",
]
# Keep mutation scope aligned with [report].omit in .coveragerc: these files are
# generated, synchronized, or maintained in another repository.
do_not_mutate = [
    "ardupilot_methodic_configurator/backend_mavftp.py",
    "ardupilot_methodic_configurator/mavftp_example.py",
    "ardupilot_methodic_configurator/tempcal_imu.py",
    "ardupilot_methodic_configurator/data_model_fc_ids.py",
    "ardupilot_methodic_configurator/configuration_steps_strings.py",
    "ardupilot_methodic_configurator/vehicle_components.py",
    "ardupilot_methodic_configurator/decode_devid.py",
]
pytest_add_cli_args_test_selection = [
    # Include model, backend, unit, behavior, and real-widget plugin regressions.
    "tests/plugins/",
    "tests/test_data_model_parameter_compare_and_upload.py",
    "tests/test_data_model_file_upload.py",
    "tests/unit_backend_safe_file_io.py",
    "tests/bdd_backend_safe_file_io.py",
    "tests/test_backend_safe_file_io_write_capture.py",
    "tests/test_data_model_fc_diagnostics.py",
    "tests/test_backend_data_telemetry.py",
    "tests/test_esc_telemetry.py",
    "tests/test_backend_flightcontroller_commands.py",
    "tests/unit_backend_flightcontroller_commands.py",
    "tests/test_data_model_configuration_step.py",
    "tests/test_data_model_parameter_upgrade.py",
    "tests/test_backend_flightcontroller_business_logic.py",
    "tests/test_data_model_transfer_progress.py",
    "tests/test_data_model_safe_evaluator.py",
    "tests/unit_battery_cell_voltages.py",
    "tests/test_data_model_ardupilot_parameter.py",
    "tests/unit_manual_override.py",
    "tests/acceptance_manual_override.py",
    "tests/integration_manual_override.py",
    "tests/test_data_model_par_dict.py",
    "tests/test_derived_parameter_confirmation.py",
    "tests/test_backend_flightcontroller_bootloader.py",
    "tests/test_bootloader_identity.py",
    "tests/test_bootloader_partial_read.py",
    "tests/test_data_model_imu_analysis.py",
    "tests/test_data_model_availability_models.py",
    "tests/test_data_model_log_analysis.py",
    "tests/test_bus_labels.py",
    "tests/test_data_model_vehicle_components_display.py",
    "tests/unit_data_model_vehicle_components_display.py",
    "tests/test_data_model_vehicle_components_validation.py",
    "tests/test_data_model_vehicle_components_validation_bdd.py",
    "tests/unit_data_model_vehicle_components_validation_constants.py",
    "tests/unit_data_model_vehicle_components_validation.py",
    "tests/test_data_model_vehicle_components_base.py",
    "tests/unit_data_model_vehicle_components_base.py",
    "tests/test_data_model_vehicle_components_templates.py",
    "tests/test_data_model_vehicle_components_import.py",
    "tests/unit_data_model_vehicle_components_import.py",
    "tests/test_data_model_vehicle_components_json_schema.py",
    "tests/unit_data_model_vehicle_components_json_schema.py",
    "tests/test_backend_firmware_upload.py",
    "tests/test_data_model_firmware_upload.py",
    "tests/test_frontend_tkinter_usage_popup_windows.py",
    "tests/test_frontend_tkinter_log_analysis.py",
    "tests/test_backend_flightcontroller_connection.py",
    "tests/test_frontend_tkinter_fc_banner_window.py",
    "tests/test_frontend_tkinter_mavlink_inspector.py",
    "tests/test_data_model_mavlink_inspector.py",
    "tests/test_data_model_plane_landing.py",
    "tests/test_data_model_firmware_version.py",
    "tests/test_data_model_parameter_history.py",
    "tests/test_backend_log_analysis.py",
    "tests/test_backend_fc_diagnostics.py",
    "tests/test_frontend_tkinter_usage_popup_window.py",
    "tests/test_frontend_tkinter_file_browser.py",
    "tests/bdd_frontend_tkinter_file_browser.py",
    "tests/test_frontend_tkinter_file_browser_tasks.py",
    "tests/test_frontend_tkinter_parameter_editor_table.py",
    "tests/integration_frontend_tkinter_parameter_editor_table.py",
    "tests/acceptance_bitmask_parameter_editor_usage_popup.py",
    "tests/test_backend_filesystem_json_with_schema.py",
]
pytest_add_cli_args = [
    "-q", "-x", "-p", "tests.plugins.conftest",
    # A signal timeout cannot interrupt a blocked Tk C call.
    "--timeout-method=thread",
    # Lint the original source in normal pytest/CI, not Mutmut's generated variants.
    "--deselect=tests/test_backend_flightcontroller_commands.py::test_command_ack_meets_pylint_statement_and_return_limits",
]
# Plugin tests also verify helicopter guidance and all three frozen-build specifications.
also_copy = [
    "pytest.ini", "TUNING_GUIDE_Heli.md", "tests",
    "ardupilot_methodic_configurator_command_line_completion.psm1",
    "windows", "linux", "macos",
]
process_isolation = "forkserver"
# Tk imports must initialize inside each worker, not the fork server.
forkserver_warmup = "none"

[tool.ruff]
target-version = "py311"
exclude = [
    ".git",
    ".packaging-check",
    "__pycache__",
    "__target__",
    "dist",
    "mutants",
    "scripts/test_gui_environment.py",
    "svg_comparison_demo.py",
    "scripts/show_svg_tk_variants.py",
    "scripts/pycairo_render.py",
    "scripts/cairosvg_test.py",
    "scripts/cairo_svg_tkinter_demo.py",
    "scripts/cairo_svg_renderer.py",
    "post_install.py",
    "param_zip.py",
    "param_filter.py",
    "mavproxy_param.py",
    "mavproxy_ftp.py",
    "mavftp.py",
    "fix_with_statements.py",
    "find_exclusive_parameter_names.py",
    # Synchronized verbatim from ArduPilot by update_flightcontroller_ids.yml.
    "ardupilot_methodic_configurator/decode_devid.py",
    # Maintained MAVProxy adaptation covered by focused MAVFTP tests.
    "ardupilot_methodic_configurator/backend_mavftp.py",
]

# https://docs.astral.sh/ruff/rules/
lint.select = ["ALL"]
lint.ignore = [
    "ERA",     # eradicate
    "BLE",     # flake8-blind-except
    "CPY001",  # Missing copyright notice at top of file
    "PTH",     # flake8-use-pathlib
    "TRY",     # tryceratops
    "ISC001",  # to let formatter run
    "ANN002",  # Missing type annotation for `*args`
    "ANN003",  # Missing type annotation for `**kwargs`
    "D102",    # Missing docstring in public method
    "D103",    # Missing docstring in public function
    "D107",    # Missing docstring in `__init__`
    "D203",    # incorrect-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
    "D212",    # Multi-line docstring summary should start at the first line
    "D401",    # First line of docstring should be in imperative mood
    "COM812",  # Trailing comma missing
    "DTZ005",  # `tz=None` passed to `datetime.datetime.now()`
    "FBT001",  # Boolean-typed positional argument in function definition
    "FBT002",  # Boolean default positional argument in function definition
    "LOG015",  # `error()` call on root logger, Use own logger instead
    "TRY400",  # Use logging.exception instead of logging.error
]

line-length = 127
indent-width = 4

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D101", "UP031", "ARG002", "ANN001", "S101", "SLF001"]
"ardupilot_methodic_configurator/backend_mavftp_example.py" = ["ANN001"]
"ardupilot_methodic_configurator/tempcal_imu.py" = ["ANN001"]

[tool.ruff.lint.mccabe]
max-complexity = 21  # Default is 10

[tool.ruff.lint.pylint]
allow-magic-value-types = ["bytes", "float", "int", "str"]
max-args = 9       # Default is 5
max-branches = 24  # Default is 12

[tool.mypy]
exclude = ['^mutants/']
ignore_missing_imports = true
disallow_any_unimported = false
disallow_any_expr = false
disallow_any_decorated = true
disallow_any_generics = false
disallow_any_explicit = false
disallow_subclassing_any = true

# Disallow untyped definitions and calls
disallow_untyped_calls = true
disallow_untyped_defs = false
disallow_incomplete_defs = false
check_untyped_defs = true
disallow_untyped_decorators = true

# None and optional handling
no_implicit_optional = true

# Configuring warnings
warn_unused_ignores = true
warn_no_return = true
warn_return_any = true
warn_redundant_casts = true

# Misc things
strict_equality = true

# Config file
warn_unused_configs = true

files = ["ardupilot_methodic_configurator/*.py"]

[[tool.mypy.overrides]]
# The maintained MAVProxy adaptation is checked by focused runtime tests.
module = "ardupilot_methodic_configurator.backend_mavftp"
ignore_errors = true

[tool.pyright]
include = [
    "ardupilot_methodic_configurator/*.py",
    "*.py",
]
exclude = [
    ".git",
    ".venv",
    "__pycache__",
    "__target__",
    "dist",
    "mutants",
    "scripts/test_gui_environment.py",
    "svg_comparison_demo.py",
    "scripts/show_svg_tk_variants.py",
    "scripts/pycairo_render.py",
    "scripts/cairosvg_test.py",
    "scripts/cairo_svg_tkinter_demo.py",
    "scripts/cairo_svg_renderer.py",
    "post_install.py",
    "param_zip.py",
    "param_filter.py",
    "mavproxy_param.py",
    "mavproxy_ftp.py",
    "mavftp.py",
    "fix_with_statements.py",
    "find_exclusive_parameter_names.py",
    "ardupilot_methodic_configurator/decode_devid.py",
    "ardupilot_methodic_configurator/tempcal_imu.py",
    "ardupilot_methodic_configurator/backend_mavftp.py",
    "ardupilot_methodic_configurator/mavftp_example.py",
]
typeCheckingMode = "standard"
pythonVersion = "3.11"
pythonPlatform = "All"
deprecateTypingAliases = true
venvPath = "."
venv = ".venv"