qtextra 0.1.4__tar.gz

qtextra-0.1.4/.gitignore

@@ -0,0 +1,111 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# IDE settings
+.vscode/
+
+_version.py
+*.iml
+.idea/
+
+docs/_auto_images/

qtextra-0.1.4/LICENSE

@@ -0,0 +1,29 @@
+BSD License
+
+Copyright (c) 2023, Lukasz G. Migas
+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.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDER OR 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.

qtextra-0.1.4/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: qtextra
+Version: 0.1.4
+Summary: Extra widgets for Qt
+Project-URL: homepage, https://github.com/illumion-io/qtextra
+Project-URL: repository, https://github.com/illumion-io/qtextra
+Author-email: "Lukasz G. Migas" <lukas.migas@yahoo.com>
+License: BSD 3-Clause License
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: appdirs
+Requires-Dist: koyo
+Requires-Dist: numpy
+Requires-Dist: psygnal
+Requires-Dist: pydantic-extra-types
+Requires-Dist: pydantic>2
+Requires-Dist: qtawesome
+Requires-Dist: qtpy
+Requires-Dist: superqt>=0.7.1
+Provides-Extra: all
+Requires-Dist: console; extra == 'all'
+Requires-Dist: pyqt6; extra == 'all'
+Requires-Dist: sentry; extra == 'all'
+Provides-Extra: console
+Requires-Dist: ipykernel>=5.2.0; extra == 'console'
+Requires-Dist: qtconsole!=4.7.6,!=5.4.2,>=4.5.1; extra == 'console'
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == 'dev'
+Requires-Dist: ipython; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pdbpp; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-pretty; extra == 'dev'
+Requires-Dist: pytest-qt; extra == 'dev'
+Requires-Dist: pytest>=8.1; extra == 'dev'
+Requires-Dist: qtreload; extra == 'dev'
+Requires-Dist: rich; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: ipykernel>=5.2.0; extra == 'docs'
+Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == 'docs'
+Requires-Dist: mkdocs-material==9.6.12; extra == 'docs'
+Requires-Dist: mkdocstrings-python==1.16.10; extra == 'docs'
+Requires-Dist: mkdocstrings==0.27.0; extra == 'docs'
+Requires-Dist: qtconsole!=4.7.6,!=5.4.2,>=4.5.1; extra == 'docs'
+Requires-Dist: sentry-sdk>2; extra == 'docs'
+Provides-Extra: palette
+Requires-Dist: qt-command-palette; extra == 'palette'
+Provides-Extra: pyqt5
+Requires-Dist: pyqt5; extra == 'pyqt5'
+Provides-Extra: pyqt6
+Requires-Dist: pyqt6; extra == 'pyqt6'
+Provides-Extra: pyside2
+Requires-Dist: pyside2; extra == 'pyside2'
+Provides-Extra: pyside6
+Requires-Dist: pyside6; extra == 'pyside6'
+Provides-Extra: reload
+Requires-Dist: qtreload; extra == 'reload'
+Provides-Extra: sentry
+Requires-Dist: sentry-sdk>2; extra == 'sentry'
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-pretty; extra == 'test'
+Requires-Dist: pytest-qt; extra == 'test'
+Requires-Dist: pytest>=8.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+# qtextra
+
+[![License](https://img.shields.io/pypi/l/qtextra.svg?color=green)](https://github.com/lukasz-migas/qtextra/raw/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/qtextra.svg?color=green)](https://pypi.org/project/qtextra)
+[![Python Version](https://img.shields.io/pypi/pyversions/qtextra.svg?color=green)](https://python.org)
+[![Test](https://github.com/lukasz-migas/qtextra/actions/workflows/test_and_deploy.yml/badge.svg?branch=main)](https://github.com/lukasz-migas/qtextra/actions/workflows/test_and_deploy.yml)
+[![codecov](https://codecov.io/gh/lukasz-migas/qtextra/branch/main/graph/badge.svg)](https://codecov.io/gh/lukasz-migas/qtextra)
+
+### A bunch of *extra* widgets and components for PyQt/PySide
+
+Here, you will find a bunch of extra widgets and components that you can use in your PySide/PyQt (using qtpy) applications.
+The goal is to provide a set of widgets that are not available in the standard PyQt/PySide libraries, or that are not easy to use.
+
+Components are tested on:
+
+- macOS, Windows & Linux
+- Python 3.9 and above
+- PyQt5 (5.11 and above) & PyQt6
+- Pyside2 (5.11 and above) & PySide6
+
+
+This repository is fairly similar in scope to [superqt](https://github.com/pyapp-kit/superqt) which aims to provide a number of useful 
+widgets (in fact we use a couple of them in this library). The main difference is that we aimed to provide a more opinionated 
+style (with stylesheets available in the [assets](src/qtextra/assets/stylesheets) directory) and focus on providing a wider
+range of widgets.
+
+## Contributing
+
+Contributions are always welcome. Please feel free to submit PRs with new features, bug fixes, or documentation improvements.
+
+```bash
+git clone https://github.com/illumion-io/qtextra.git
+
+pip install -e .[dev]
+```
+
+
+## Release information
+
+1. Test code and make sure it works.
+2. Reinstall all dependencies and build app and test that it works.
+3. Update git tag and push it.
+4. Reinstall and build app.
+5. Upload to Dropbox.
+6. Update the latest.json file in Dropbox.
+7. Create release with changelog on GitHub (autoims-docs).

qtextra-0.1.4/README.md

@@ -0,0 +1,46 @@
+# qtextra
+
+[![License](https://img.shields.io/pypi/l/qtextra.svg?color=green)](https://github.com/lukasz-migas/qtextra/raw/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/qtextra.svg?color=green)](https://pypi.org/project/qtextra)
+[![Python Version](https://img.shields.io/pypi/pyversions/qtextra.svg?color=green)](https://python.org)
+[![Test](https://github.com/lukasz-migas/qtextra/actions/workflows/test_and_deploy.yml/badge.svg?branch=main)](https://github.com/lukasz-migas/qtextra/actions/workflows/test_and_deploy.yml)
+[![codecov](https://codecov.io/gh/lukasz-migas/qtextra/branch/main/graph/badge.svg)](https://codecov.io/gh/lukasz-migas/qtextra)
+
+### A bunch of *extra* widgets and components for PyQt/PySide
+
+Here, you will find a bunch of extra widgets and components that you can use in your PySide/PyQt (using qtpy) applications.
+The goal is to provide a set of widgets that are not available in the standard PyQt/PySide libraries, or that are not easy to use.
+
+Components are tested on:
+
+- macOS, Windows & Linux
+- Python 3.9 and above
+- PyQt5 (5.11 and above) & PyQt6
+- Pyside2 (5.11 and above) & PySide6
+
+
+This repository is fairly similar in scope to [superqt](https://github.com/pyapp-kit/superqt) which aims to provide a number of useful 
+widgets (in fact we use a couple of them in this library). The main difference is that we aimed to provide a more opinionated 
+style (with stylesheets available in the [assets](src/qtextra/assets/stylesheets) directory) and focus on providing a wider
+range of widgets.
+
+## Contributing
+
+Contributions are always welcome. Please feel free to submit PRs with new features, bug fixes, or documentation improvements.
+
+```bash
+git clone https://github.com/illumion-io/qtextra.git
+
+pip install -e .[dev]
+```
+
+
+## Release information
+
+1. Test code and make sure it works.
+2. Reinstall all dependencies and build app and test that it works.
+3. Update git tag and push it.
+4. Reinstall and build app.
+5. Upload to Dropbox.
+6. Update the latest.json file in Dropbox.
+7. Create release with changelog on GitHub (autoims-docs).

qtextra-0.1.4/pyproject.toml

@@ -0,0 +1,236 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "tests", "CHANGELOG.md"]
+
+# https://peps.python.org/pep-0621/
+[project]
+name = "qtextra"
+description = "Extra widgets for Qt"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "BSD 3-Clause License" }
+authors = [
+    { email = "lukas.migas@yahoo.com", name = "Lukasz G. Migas" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Typing :: Typed",
+]
+dynamic = ["version"]
+dependencies = [
+    "qtpy",
+    "superqt>=0.7.1",
+    "qtawesome",
+    "koyo",
+    "numpy",
+    "appdirs",
+    "psygnal",
+    "pydantic>2",
+    "pydantic-extra-types"
+]
+
+# extras
+# https://peps.python.org/pep-0621/#dependencies-optional-dependencies
+[project.optional-dependencies]
+all = ["console", "sentry", "pyqt6"]
+#notify = ["pyqt-toast-notification"]
+sentry = ["sentry-sdk>2"]
+console = [
+    "qtconsole>=4.5.1,!=4.7.6,!=5.4.2",
+    "ipykernel>=5.2.0",
+]
+palette = ["qt-command-palette"]
+reload = ["qtreload"]
+pyside2 = ["pyside2"]
+pyside6 = ["pyside6"]
+pyqt5 = ["pyqt5"]
+pyqt6 = ["pyqt6"]
+test = [
+    "pytest>=8.1",
+    "pytest-cov",
+    "pytest-qt",
+    "pytest-pretty",
+]
+dev = [
+    "ipython",
+    "mypy",
+    "pdbpp",
+    "pre-commit",
+    "rich",
+    "ruff",
+    "check-manifest",
+    "qtextra[test,reload]",
+]
+docs = [
+    "mkdocs-macros-plugin ==1.3.7",
+    "mkdocs-material ==9.6.12",
+    "mkdocstrings ==0.27.0",
+    "mkdocstrings-python ==1.16.10",
+    "qtextra[console,sentry]",
+]
+
+[project.urls]
+homepage = "https://github.com/illumion-io/qtextra"
+repository = "https://github.com/illumion-io/qtextra"
+
+# same as console_scripts entry point
+# [project.scripts]
+# spam-cli = "spam:main_cli"
+
+# Entry points
+# https://peps.python.org/pep-0621/#entry-points
+# [project.entry-points."spam.magical"]
+# tomatoes = "spam:main_tomatoes"
+
+# https://github.com/charliermarsh/ruff
+[tool.ruff]
+line-length = 120
+target-version = "py39"
+src = ["src", "tests"]
+
+# https://beta.ruff.rs/docs/rules/
+[tool.ruff.lint]
+extend-select = [
+    "E",    # style errors
+    "W",    # style warnings
+    "F",    # flakes
+    "D",    # pydocstyle
+    "I",    # isort
+    "U",    # pyupgrade
+    # "S",    # bandit
+    "C",    # flake8-comprehensions
+    "B",    # flake8-bugbear
+    "A001", # flake8-builtins
+    "RUF",  # ruff-specific rules
+]
+# I do this to get numpy-style docstrings AND retain
+# D417 (Missing argument descriptions in the docstring)
+# otherwise, see:
+# https://beta.ruff.rs/docs/faq/#does-ruff-support-numpy-or-google-style-docstrings
+# https://github.com/charliermarsh/ruff/issues/2606
+extend-ignore = [
+    "D100", # Missing docstring in public module
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in __init__
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D213", # Multi-line docstring summary should start at the second line
+    "D401", # First line should be in imperative mood
+    "D404", # First word of the docstring should not be This
+    "D413", # Missing blank line after last section
+    "D416", # Section name should end with a colon
+    "E501",
+    "UP006",
+    "UP007",
+    "TC001",
+    "TC002",
+    "TC003",
+    "S101",  # Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
+    "B019",
+    "S311",
+    "C901", # too complex
+    "S603",
+    # temporary
+    "D205", # 1 blank line required between summary line and description
+    "S606",
+    "S607",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = ["D", "S"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+# Disallow all relative imports.
+ban-relative-imports = "all"
+
+# https://docs.astral.sh/ruff/formatter/
+[tool.ruff.format]
+docstring-code-format = true
+
+# https://docs.pytest.org/en/6.2.x/customize.html
+[tool.pytest.ini_options]
+minversion = "8"
+console_output_style = "count"
+testpaths = ["qtextra", "tests"]
+xfail_strict = true
+# options so that we can see the stdout and loguru logs
+addopts = [
+    "-ras",
+    "-vv",
+    "--maxfail=10",
+    "--durations=10",
+    "--log-cli-level=DEBUG",
+    "--log-cli-format=%(asctime)s - %(levelname)s - %(message)s",
+]
+filterwarnings = [
+  "error:::qtextra", # turn warnings from qtextra into errors
+  "error:::test_.*", # turn warnings in our own tests into errors
+  "ignore::DeprecationWarning:shibokensupport",
+  "ignore::DeprecationWarning:ipykernel",
+  "ignore:numpy.ufunc size changed:RuntimeWarning",
+  "ignore:There is no current event loop:DeprecationWarning:",
+]
+
+# https://mypy.readthedocs.io/en/stable/config_file.html
+[tool.mypy]
+files = "src/**/"
+strict = true
+disallow_any_generics = false
+disallow_subclassing_any = false
+show_error_codes = true
+pretty = true
+
+# # module specific overrides
+# [[tool.mypy.overrides]]
+# module = ["numpy.*",]
+# ignore_errors = true
+
+# https://coverage.readthedocs.io/en/6.4/config.html
+[tool.coverage.run]
+source = ["src"]
+omit = [
+    "**/*_version.py"
+]
+
+# https://coverage.readthedocs.io/en/6.4/config.html
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "@overload",
+    "except ImportError",
+    "\\.\\.\\.",
+    "raise NotImplementedError()",
+]
+
+# https://github.com/mgedmin/check-manifest#configuration
+[tool.check-manifest]
+ignore = [
+    ".github_changelog_generator",
+    ".pre-commit-config.yaml",
+    ".ruff_cache/**/*",
+    "setup.py",
+    "tests/**/*",
+    ".idea/**/*",
+    "_version.py",
+    "venv*/**/*",
+    "tox.ini",
+    "codecov.yml",
+    "mkdocs.yml",
+    "renovate.json",
+    "docs/**/*",
+    "examples/**/*",
+    "MANIFEST.in",
+]

qtextra-0.1.4/src/qtextra/__init__.py

@@ -0,0 +1,10 @@
+"""Extra widgets for Qt."""
+
+from loguru import logger
+
+__version__ = "0.1.2"
+__author__ = "Lukasz G. Migas"
+__email__ = "lukas.migas@yahoo.com"
+__issue_url__ = "https://github.com/illumion-io/qtextra-issues/issues"
+__project_url__ = "https://ionglow.io/qtextra"
+logger.disable("qtextra")

qtextra-0.1.4/src/qtextra/_pydantic_compat.py

@@ -0,0 +1,115 @@
+"""
+This module provides compatibility between pydantic v1 and v2.
+
+Keep using this compatibility module until we stop using any pydantic v1 API functionality.
+This can be removed when everything has been migrated to pydantic v2.
+"""
+
+from functools import partial
+
+try:
+    # The Pydantic V2 package can access the Pydantic V1 API by importing through `pydantic.v1`.
+    # See https://docs.pydantic.dev/latest/migration/#continue-using-pydantic-v1-features
+    from pydantic.v1 import (
+        BaseModel,
+        BaseSettings,
+        EmailStr,
+        Extra,
+        Field,
+        PositiveInt,
+        PrivateAttr,
+        ValidationError,
+        color,
+        conlist,
+        constr,
+        errors,
+        main,
+        parse_obj_as,
+        root_validator,
+        types,
+        utils,
+        validator,
+    )
+    from pydantic.v1.env_settings import (
+        EnvSettingsSource,
+        SettingsError,
+        SettingsSourceCallable,
+    )
+    from pydantic.v1.error_wrappers import ErrorWrapper, display_errors
+    from pydantic.v1.fields import SHAPE_LIST, ModelField
+    from pydantic.v1.generics import GenericModel
+    from pydantic.v1.main import ClassAttribute, ModelMetaclass
+    from pydantic.v1.utils import ROOT_KEY, sequence_like
+
+except (AttributeError, ImportError):
+    from pydantic import (
+        BaseModel,
+        BaseSettings,
+        EmailStr,
+        Extra,
+        Field,
+        PositiveInt,
+        PrivateAttr,
+        ValidationError,
+        color,
+        conlist,
+        constr,
+        errors,
+        main,
+        parse_obj_as,
+        root_validator,
+        types,
+        utils,
+        validator,
+    )
+    from pydantic.env_settings import (
+        EnvSettingsSource,
+        SettingsError,
+        SettingsSourceCallable,
+    )
+    from pydantic.error_wrappers import ErrorWrapper, display_errors
+    from pydantic.fields import SHAPE_LIST, ModelField
+    from pydantic.generics import GenericModel
+    from pydantic.main import ModelMetaclass
+    from pydantic.utils import ROOT_KEY, ClassAttribute, sequence_like
+
+Color = color.Color
+validator_reuse = partial(validator, allow_reuse=True, pre=True)
+validator_reuse_opt = partial(validator, allow_reuse=True, pre=True, check_fields=False)
+
+
+__all__ = (
+    "ROOT_KEY",
+    "SHAPE_LIST",
+    "BaseModel",
+    "BaseSettings",
+    "ClassAttribute",
+    "Color",
+    "EmailStr",
+    "EnvSettingsSource",
+    "ErrorWrapper",
+    "Extra",
+    "Field",
+    "GenericModel",
+    "ModelField",
+    "ModelMetaclass",
+    "PositiveInt",
+    "PrivateAttr",
+    "SettingsError",
+    "SettingsSourceCallable",
+    "ValidationError",
+    "color",
+    "conlist",
+    "constr",
+    "display_errors",
+    "errors",
+    "main",
+    "parse_obj_as",
+    "root_validator",
+    "sequence_like",
+    "types",
+    "utils",
+    "validator",
+    "validator_reuse",
+    "validator_reuse_opt",
+)