chore(lib): warn about non-preferred-qt-version (#373)

Closes #371
This commit is contained in:
Jérome Eertmans
2024-02-16 13:57:54 +01:00
committed by GitHub
parent d586dab102
commit 07fd2bdcf1
2 changed files with 24 additions and 3 deletions

View File

@ -11,6 +11,23 @@ from ..commons import config_path_option, folder_path_option, verbosity_option
from ..config import Config, PresentationConfig from ..config import Config, PresentationConfig
from ..logger import logger 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() @click.command()
@folder_path_option @folder_path_option
@ -276,6 +293,8 @@ def present(
if start_at[1]: if start_at[1]:
start_at_slide_number = start_at[1] start_at_slide_number = start_at[1]
warn_if_non_desirable_pyside6_version()
from ..qt_utils import qapp from ..qt_utils import qapp
app = qapp() app = qapp()

View File

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