Skip to content

Commit

Permalink
chore(lib): warn about non-preferred-qt-version (#373)
Browse files Browse the repository at this point in the history
Closes #371
  • Loading branch information
jeertmans authored Feb 16, 2024
1 parent d586dab commit 07fd2bd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
19 changes: 19 additions & 0 deletions manim_slides/present/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@
from ..config import Config, PresentationConfig
from ..logger import logger

PREFERRED_QT_VERSIONS = ("6.5.1", "6.5.2")


def warn_if_non_desirable_pyside6_version() -> None:
from qtpy import API, QT_VERSION

if sys.version_info < (3, 12) and (
API != "pyside6" or QT_VERSION not in PREFERRED_QT_VERSIONS
):
logger.warn(
f"You are using {API = }, {QT_VERSION = }, "
"but we recommend installing 'PySide6==6.5.2', mainly to avoid "
"flashing screens between slides, "
"see issue https://github.com/jeertmans/manim-slides/issues/293. "
"You can do so with `pip install 'manim-slides[pyside6]'`."
)


@click.command()
@folder_path_option
Expand Down Expand Up @@ -276,6 +293,8 @@ def present(
if start_at[1]:
start_at_slide_number = start_at[1]

warn_if_non_desirable_pyside6_version()

from ..qt_utils import qapp

app = qapp()
Expand Down
8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ filterwarnings = [

[tool.ruff]
extend-exclude = ["manim_slides/resources.py"]
extend-include = ["*.ipynb"]
line-length = 88
target-version = "py38"

[tool.ruff.lint]
extend-ignore = [
"D100",
"D101",
Expand All @@ -140,8 +145,5 @@ extend-ignore = [
"D212",
"E501",
]
extend-include = ["*.ipynb"]
extend-select = ["B", "C90", "D", "I", "N", "RUF", "UP", "T"]
isort = {known-first-party = ["manim_slides", "tests"]}
line-length = 88
target-version = "py38"

0 comments on commit 07fd2bd

Please sign in to comment.