pyproject.toml

[build-system]
requires = ["setuptools>=64", "setuptools_scm[toml]>=8"]
build-backend = "setuptools.build_meta"

[tool.uv]
# Restrict lockfile to a sane subset of platforms
environments = ["sys_platform == 'linux' and platform_machine == 'x86_64'"]

[project]
name = "mx-bluesky"
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: OSI Approved :: Apache Software License",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
]
description = "Bluesky tools for MX Beamlines at DLS"
dependencies = [
    #
    # If a constraint is not set here or if the dependency is pinned to a hash
    # it will be auto-pinned to the latest release version by the pre-release workflow
    #
    "annotated_types",
    "caproto",
    "fastapi[all]",
    "flask-restful",
    "jupyterlab",
    "matplotlib",
    "nexgen >= 0.11.0",
    "numpy >= 2.3.5",
    "opencv-python",                   # Needed for I24 ssx moveonclick. To be changed to headless once this is moved to separate ui.
    "opentelemetry-distro",
    "opentelemetry-exporter-otlp",
    "pydantic",
    "pydantic-extra-types >= 2.10.1",
    "pyepics",
    "pyzmq",
    "requests",
    "scanspec",
    "scipy",
    "semver",
    "deepdiff",
    "matplotlib",
    "cachetools",
    "bluesky-stomp >= 0.2.0",
    "mysql-connector-python == 9.5.0", # Can unpin once https://github.com/DiamondLightSource/ispyb-api/pull/244 is merged and released

    #
    # These dependencies may be issued as pre-release versions and should have a pin constraint
    # as by default pip-install will not upgrade to a pre-release.
    #
    "daq-config-server >= 1.3.0",
    "blueapi >= 1.12.0",
    "ophyd >= 1.10.5",
    "ophyd-async >= 0.16.0",
    "bluesky >= 1.14.6",
    "dls-dodal @ git+https://github.com/DiamondLightSource/dodal.git@main",
]


dynamic = ["version"]
license.file = "LICENSE"
readme = "README.rst"
requires-python = ">=3.11"

[dependency-groups]
dev = [
    "black",
    "build",
    # Commented out due to dependency version conflict with pydantic 1.x
    # "copier",
    "diff-cover",
    "GitPython",
    "import-linter",
    "ispyb",
    "ipython",
    "mypy",
    "myst-parser",
    "plantweb",
    "pre-commit",
    "pydata-sphinx-theme>=0.12",
    "pyright>=1.1.408",
    "pytest-asyncio",
    "pytest-cov",
    "pytest-random-order",
    "pytest-timeout",
    "pytest",
    "responses",
    "ruff",
    "sphinx-autobuild",
    "sphinx-copybutton",
    "sphinx-design",
    "tox-uv",
    "types-mock",
    "types-requests",
    "sphinxcontrib.mermaid", # To build dodal docs
]

[project.scripts]
mx-bluesky = "mx_bluesky.__main__:main"
run_extruder = "mx_bluesky.beamlines.i24.serial.run_serial:run_extruder"
run_fixed_target = "mx_bluesky.beamlines.i24.serial.run_serial:run_fixed_target"
hyperion = "mx_bluesky.hyperion.__main__:main"
hyperion-callbacks = "mx_bluesky.hyperion.external_interaction.callbacks.__main__:main"
redis_to_murko = "mx_bluesky.beamlines.i04.redis_to_murko_forwarder:main"

[project.urls]
GitHub = "https://github.com/DiamondLightSource/mx-bluesky"

[[project.authors]] # Further authors may be added by duplicating this section
email = "dominic.oram@diamond.ac.uk"
name = "Dominic Oram"

[tool.setuptools_scm]
version_file = "src/mx_bluesky/_version.py"

[tool.pyright]
typeCheckingMode = "strict"
reportMissingTypeStubs = false
reportUnknownMemberType = false
reportUnknownLambdaType = false
reportUnknownParameterType = false
reportUnknownArgumentType = false
reportMissingParameterType = false
reportMissingTypeArgument = false
reportPrivateUsage = false
reportUnknownVariableType = false
reportUnusedVariable = false
reportMatchNotExhaustive = false


[tool.pytest.ini_options]
# Run pytest with all our checkers, and don't spam us with massive tracebacks on error
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
timeout = 1
markers = [
    "dlstbx: marks tests as requiring dlstbx (deselect with '-m \"not dlstbx\"')",
    "skip_log_setup: marks tests so that loggers are not setup before the test.",
    "skip_in_pycharm: marks test as not working in pycharm testrunner",
    "system_test: marks tests as a system test",
    "requires: marks a test as having an external dependency such as a service or hardware",
]
addopts = """
    --tb=native -vv --doctest-modules --doctest-glob="*.rst" --durations=10
    """
# https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
filterwarnings = [
    "error",
    # Ophyd status objects in tests
    "ignore:.*The 'done' and 'success' parameters will be removed.*:DeprecationWarning",
    # Ignore nondeterministic closing of log, run_engine, etc. before test end
    "ignore:(.*)unclosed file(.*)name='(.*)dodal.log'(.*):ResourceWarning",
    "ignore:(.*)unclosed <socket(.*):ResourceWarning",
    "ignore:(.*)unclosed event loop(.*):ResourceWarning",
    # Ignore warning about deprecated throw() call https://github.com/bluesky/bluesky/issues/1817
    "ignore:.*signature of throw\\(\\) is deprecated.*:DeprecationWarning",
    #Remove when we drop python 3.11
    "ignore:.*__contains__ will no longer raise TypeError.*:DeprecationWarning",
    # epicscorelibs requires setuptools >= 70.1
    "ignore:.*The 'wheel' package is no longer the canonical location of the 'bdist_wheel' command.*:DeprecationWarning",
]
# Doctest python code in docs, python code in src docstrings, test functions in tests
testpaths = "docs src tests/unit_tests"

[tool.coverage.run]
patch = ["subprocess"]
data_file = "/tmp/mx_bluesky.coverage"

[tool.coverage.paths]
# Tests are run from installed location, map back to the src directory
source = ["src", "**/site-packages/"]

[tool.tox]
skipsdist = true
# envs to runs automatically with tox -p
env_list = ["pre-commit", "type-checking", "tests", "docs"]

[tool.tox.env_run_base]
# Pass all environment variables to the test environments
passenv = ["*"]

[tool.tox.env.pre-commit]
description = "Run pre-commit on all files"
commands = [
    [
        "pre-commit",
        "run",
        "--all-files",
        "--show-diff-on-failure",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]

[tool.tox.env.type-checking]
description = "Run pyright"
commands = [
    [
        "pyright",
        "--pythonpath",
        "{env:VIRTUAL_ENV}/bin/python",
        "src",
        "tests",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]

[tool.tox.env.tests]
description = "Run tests with coverage"
commands = [
    [
        "pytest",
        "--cov=mx_bluesky",
        "--cov-report",
        "term",
        "--cov-report",
        "xml:cov.xml",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]


[tool.tox.env.systemtests]
description = "Run tests with coverage"
commands = [
    [
        "pytest",
        "--junit-xml=systemtests_output.xml",
        "-m",
        "system_test",
        "tests/system_tests",
        "--timeout=60",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]
set_env = { DODAL_TEST_MODE = "true", BEAMLINE = "test" }


# Runs the system tests locally
[tool.tox.env.localsystemtests]
commands = [
    [
        "pytest",
        "-m",
        "system_test",
        "--timeout=60",
        "tests/system_tests",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]

[tool.tox.env.localsystemtests.set_env]
DOCKER = "podman"
DODAL_TEST_MODE = "true"
ISPYB_CONFIG_PATH = "{toxinidir}/tests/test_data/ispyb-test-credentials.cfg"
ZOCALO_CONFIG = "{toxinidir}/tests/test_data/zocalo-test-configuration.yaml"
BEAMLINE = "test"

[tool.tox.env.docs]
description = "Run docs build with clean environment"
env_dir = ".venv"
skip_install = true
commands_pre = [
    [
        "python",
        "{toxinidir}/utility_scripts/generate_plantuml.py",
        "docs/developer/hyperion/reference/param_hierarchy.puml",
    ],
]
commands = [
    [
        "sphinx-build",
        "--fresh-env",
        "--show-traceback",
        "--fail-on-warning",
        "--keep-going",
        "docs",
        "build/html",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]

[tool.tox.env.docs-autobuild]
description = "Run docs with autobuild on change"
commands = [
    [
        "sphinx-autobuild",
        "--show-traceback",
        "--watch",
        "README.rst",
        "docs",
        "build/html",
        { replace = "posargs", default = [
        ], extend = true },
    ],
]

[tool.ruff]
src = ["src", "tests"]
line-length = 88
lint.select = [
    "B",      # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
    "C4",     # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
    "E",      # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
    "F",      # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
    "N",      # pep8-naming - https://docs.astral.sh/ruff/rules/#pep8-naming-n
    "W",      # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
    "I",      # isort - https://docs.astral.sh/ruff/rules/#isort-i
    "UP",     # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
    "SLF",    # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
    "PT012",  # flake8-pytest-style rules - https://docs.astral.sh/ruff/rules/pytest-raises-with-multiple-statements/#pytest-raises-with-multiple-statements-pt012
    "RUF018", # walrus operators in asserts - https://docs.astral.sh/ruff/rules/assignment-in-assert/
    "TID251", # banned api - https://docs.astral.sh/ruff/rules/banned-api/
    "INP001", # missing __init__.py - https://docs.astral.sh/ruff/rules/implicit-namespace-package/
]
lint.extend-ignore = [
    "E501", # Line too long
    "B008", # Allow inject("device")
]
[tool.ruff.lint.per-file-ignores]
# By default, private member access is allowed in tests
# See https://github.com/DiamondLightSource/python-copier-template/issues/154
# Remove this line to forbid private member access, walrys operators in asserts, banned api in tests
"tests/**/*" = ["SLF001", "B023", "RUF018", "TID251"]
".github/**/*" = ["INP001"]
"docs/**/*" = ["INP001"]
"utility_scripts/**/*" = ["INP001"]

[tool.ruff.lint.flake8-tidy-imports.banned-api]
"time.sleep".msg = "Use bps.sleep instead. # noqa will disable this rule for that line. See https://github.com/DiamondLightSource/mx-bluesky/issues/925"

[tool.mypy]
plugins = ["pydantic.mypy"]

[tool.importlinter]
root_package = "mx_bluesky"

[[tool.importlinter.contracts]]
name = "Common does not import from apps"
type = "forbidden"
source_modules = "mx_bluesky.common"
forbidden_modules = ["mx_bluesky.beamlines", "mx_bluesky.hyperion"]

[[tool.importlinter.contracts]]
name = "Beamlines do not import from each other"
type = "independence"
modules = "mx_bluesky.beamlines.*"

[[tool.importlinter.contracts]]
name = "Beamlines do not import from hyperion"
type = "forbidden"
source_modules = "mx_bluesky.beamlines.**"
forbidden_modules = "mx_bluesky.hyperion.**"