qgis-plugin-dev-tools 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

qgis_plugin_dev_tools/__init__.py

@@ -20,7 +20,7 @@
 import logging
 import sys
 
-__version__ = "0.6.1"
+__version__ = "0.7.0"
 
 LOGGER = logging.getLogger(__name__)
 _handler = logging.StreamHandler(sys.stdout)

qgis_plugin_dev_tools/build/packaging.py

@@ -28,9 +28,7 @@ from qgis_plugin_dev_tools.build.rewrite_imports import (
     insert_as_first_import,
 )
 from qgis_plugin_dev_tools.config import DevToolsConfig
-from qgis_plugin_dev_tools.utils.distributions import (
-    get_distribution_top_level_package_names,
-)
+from qgis_plugin_dev_tools.utils.distributions import get_distribution_top_level_names
 
 IGNORED_FILES = shutil.ignore_patterns("__pycache__", "*.pyc", "*.pyi")
 LOGGER = logging.getLogger(__name__)
@@ -61,142 +59,134 @@ def copy_runtime_requirements(
     dev_tools_config: DevToolsConfig,
     build_directory_path: Path,
 ) -> None:
+    if len(dev_tools_config.runtime_distributions) == 0:
+        return
+
     plugin_package_name = dev_tools_config.plugin_package_name
+    vendor_path = build_directory_path / plugin_package_name / "_vendor"
 
-    if len(dev_tools_config.runtime_distributions) > 0:
-        vendor_path = build_directory_path / plugin_package_name / "_vendor"
-        vendor_path.mkdir(parents=True)
-        vendor_init_file = vendor_path / "__init__.py"
-        vendor_init_file.touch()
-        if dev_tools_config.append_distributions_to_path:
-            vendor_init_file.write_text(VENDOR_PATH_APPEND_SCRIPT)
-
-    runtime_package_names = []
-    # copy dist infos (licenses etc.) and all provided top level packages
-    for dist in (
+    vendor_path.mkdir(parents=True)
+    vendor_init_file = vendor_path / "__init__.py"
+    vendor_init_file.touch()
+
+    if dev_tools_config.append_distributions_to_path:
+        vendor_init_file.write_text(VENDOR_PATH_APPEND_SCRIPT)
+        insert_as_first_import(
+            build_directory_path / plugin_package_name / "__init__.py",
+            f"{plugin_package_name}._vendor",
+        )
+
+    vendored_runtime_top_level_names: list[str] = []
+
+    for vendored_distribution in (
         dev_tools_config.runtime_distributions
         + dev_tools_config.extra_runtime_distributions
     ):
-        dist_info_path = Path(dist._path)  # type: ignore
+        # if a recursively found dependency is provided by system packages,
+        # assume it does not have to be bundled (this is possibly dangerous,
+        # if build is made on a different system package set than runtime)
         if (
-            Path(sys.base_prefix) in dist_info_path.parent.parents
-            and dist in dev_tools_config.extra_runtime_distributions
+            vendored_distribution in dev_tools_config.extra_runtime_distributions
+            and Path(
+                vendored_distribution._path,  # type: ignore
+            ).is_relative_to(Path(sys.base_prefix))
         ):
-            # If QGIS Python includes the dependency, it does not have to be bundled
-            LOGGER.debug(
+            LOGGER.warning(
                 "skipping recursively found runtime requirement %s "
-                "because it is included in QGIS",
-                dist.metadata["Name"],
+                "because it is included in system packages",
+                vendored_distribution.name,
             )
             continue
 
-        dist_top_level_packages = get_distribution_top_level_package_names(dist)
-
-        LOGGER.debug(
-            "bundling runtime requirement %s",
-            dist.metadata["Name"],
-        )
-
-        # don't vendor self, but allow to vendor other packages provided
+        # don't vendor plugin package, but allow to vendor other packages provided
         # from plugin distribution. if "-e ." installs "my-plugin-name" distribution
         # containing my_plugin & my_util_package top level packages, bundling is only
         # needed for my_util_package
-        dist_top_level_packages = [
-            name for name in dist_top_level_packages if name != plugin_package_name
-        ]
-
-        runtime_package_names.extend(dist_top_level_packages)
+        dist_top_level_names = get_distribution_top_level_names(vendored_distribution)
+        dist_top_level_names.discard(plugin_package_name)
 
         LOGGER.debug(
-            "copying %s to build directory",
-            dist_info_path.resolve(),
+            "bundling runtime requirement %s with top level names %s",
+            vendored_distribution.name,
+            dist_top_level_names,
         )
-        shutil.copytree(
-            src=dist_info_path,
-            dst=build_directory_path
-            / plugin_package_name
-            / "_vendor"
-            / dist_info_path.name,
-            ignore=IGNORED_FILES,
+        _copy_distribution_files(
+            vendored_distribution,
+            dist_top_level_names,
+            vendor_path,
         )
-        for package_name in dist_top_level_packages:
-            _copy_package(
-                build_directory_path,
-                dist,
-                dist_info_path,
-                package_name,
-                plugin_package_name,
-            )
 
-    if dev_tools_config.append_distributions_to_path:
-        plugin_init_file = (build_directory_path / plugin_package_name) / "__init__.py"
-        insert_as_first_import(plugin_init_file, f"{plugin_package_name}._vendor")
-        return
+        vendored_runtime_top_level_names.extend(dist_top_level_names)
 
-    for package_name in runtime_package_names:
-        LOGGER.debug("rewriting imports for %s", package_name)
+    if not dev_tools_config.append_distributions_to_path:
+        for package_name in vendored_runtime_top_level_names:
+            LOGGER.debug("rewriting imports for %s", package_name)
 
-        py_files = list((build_directory_path / plugin_package_name).rglob("*.py"))
-        ui_files = list((build_directory_path / plugin_package_name).rglob("*.ui"))
+            py_files = list((build_directory_path / plugin_package_name).rglob("*.py"))
+            ui_files = list((build_directory_path / plugin_package_name).rglob("*.ui"))
 
-        for source_file in py_files + ui_files:
-            rewrite_imports_in_source_file(
-                source_file,
-                rewritten_package_name=package_name,
-                container_package_name=f"{plugin_package_name}._vendor",
-            )
+            for source_file in py_files + ui_files:
+                rewrite_imports_in_source_file(
+                    source_file,
+                    rewritten_package_name=package_name,
+                    container_package_name=f"{plugin_package_name}._vendor",
+                )
 
 
-def _copy_package(
-    build_directory_path: Path,
-    dist: Distribution,
-    dist_info_path: Path,
-    package_name: str,
-    plugin_package_name: str,
+def _copy_distribution_files(
+    distribution: Distribution,
+    top_level_names: set[str],
+    target_root_path: Path,
 ) -> None:
-    LOGGER.debug(
-        "bundling runtime requirement %s package %s",
-        dist.metadata["Name"],
-        package_name,
-    )
+    if (file_paths := distribution.files) is None:
+        LOGGER.warning("could not resolve %s contents to bundle", distribution.name)
+        return
+
+    # bundle metadata directory first
+    distribution_metadata_path = Path(distribution._path)  # type: ignore
     LOGGER.debug(
         "copying %s to build directory",
-        (dist_info_path.parent / package_name).resolve(),
+        distribution_metadata_path.resolve(),
+    )
+    shutil.copytree(
+        src=distribution_metadata_path,
+        dst=target_root_path / distribution_metadata_path.name,
+        ignore=IGNORED_FILES,
     )
 
-    # Full package
-    dist_src = dist_info_path.parent / package_name
-    if dist_src.exists():
+    directories_to_bundle = {
+        top_directory_name
+        for file_path in file_paths
+        if len(file_path.parts) > 1
+        and (top_directory_name := file_path.parts[0]) in top_level_names
+    }
+    files_to_bundle = {
+        file_path
+        for file_path in file_paths
+        if len(file_path.parts) == 1 and file_path.stem in top_level_names
+    }
+
+    record_root_path = distribution_metadata_path.parent
+
+    for directory_path in directories_to_bundle:
+        original_path = record_root_path / directory_path
+        new_path = target_root_path / directory_path
+
+        LOGGER.debug("copying %s to build directory", original_path.resolve())
+
         shutil.copytree(
-            src=dist_src,
-            dst=build_directory_path / plugin_package_name / "_vendor" / package_name,
+            src=original_path,
+            dst=new_path,
             ignore=IGNORED_FILES,
         )
-        return
 
-    # Single module
-    dist_src = dist_info_path.parent / f"{package_name}.py"
-    if dist_src.exists():
-        shutil.copy(
-            src=dist_src, dst=build_directory_path / plugin_package_name / "_vendor"
-        )
-        return
+    for file_path in files_to_bundle:
+        original_path = record_root_path / file_path
+        new_path = target_root_path / file_path
 
-    # pyd file
-    pyd_files = list(dist_info_path.parent.glob(f"{package_name}*.pyd"))
-    if pyd_files:
-        for dist_src in pyd_files:
-            shutil.copy(
-                src=dist_src, dst=build_directory_path / plugin_package_name / "_vendor"
-            )
-        return
-    if not package_name.startswith("_"):
-        raise ValueError(
-            f"Sources for runtime requirement {dist.metadata['Name']} "
-            f"cannot be found in {dist_info_path.parent}"
-        )
+        LOGGER.debug("copying %s to build directory", original_path.resolve())
 
-    LOGGER.warning(
-        "Could not find path %s",
-        (dist_info_path.parent / package_name).resolve(),
-    )
+        shutil.copy(
+            src=original_path,
+            dst=new_path,
+        )

qgis_plugin_dev_tools/build/rewrite_imports.py

@@ -19,7 +19,7 @@ class SpecialImportRewriter(ast.NodeTransformer):
     _replaced_imported_names: Dict[str, str] = field(default_factory=dict, init=False)
 
     # collect the found imported names to replace the references also
-    def visit_Import(self, node: ast.Import) -> Any:  # noqa N802
+    def visit_Import(self, node: ast.Import) -> Any:  # noqa: N802
         for alias in node.names:
             if alias.name.startswith(f"{self.from_module}.") and alias.asname is None:
                 old_module_name = alias.name
@@ -33,7 +33,7 @@ class SpecialImportRewriter(ast.NodeTransformer):
         return node
 
     # check the attributes for an imported module name reference
-    def visit_Attribute(self, node: ast.Attribute) -> Any:  # noqa N802
+    def visit_Attribute(self, node: ast.Attribute) -> Any:  # noqa: N802
         attribute_name = ast.unparse(node)
         if attribute_name in self._replaced_imported_names:
             replaced_name = self._replaced_imported_names[attribute_name]
@@ -42,7 +42,7 @@ class SpecialImportRewriter(ast.NodeTransformer):
         return self.generic_visit(node)
 
     # this will only handle sys.modules['something'] replace
-    def visit_Subscript(self, node: ast.Subscript) -> Any:  # noqa N802
+    def visit_Subscript(self, node: ast.Subscript) -> Any:  # noqa: N802
         if (
             ast.unparse(node.value) == "sys.modules"
             and isinstance(node.slice, ast.Constant)
@@ -69,7 +69,6 @@ def rewrite_imports_in_source_file(
         f'sys.modules["{rewritten_package_name}.',
     ]
     if any(special in contents for special in specials):
-
         # hold on to the original for license comments
         # since comments are lost with ast parse+unparse
         orig_file = source_file.with_name(source_file.name + "_original")

qgis_plugin_dev_tools/cli/__init__.py

@@ -21,7 +21,7 @@ import argparse
 import logging
 import sys
 from pathlib import Path
-from typing import List, Optional
+from typing import Optional
 
 from importlib_metadata import entry_points
 
@@ -32,14 +32,12 @@ from qgis_plugin_dev_tools.config.dotenv import read_dotenv_configs
 from qgis_plugin_dev_tools.publish import publish_plugin_zip_file
 from qgis_plugin_dev_tools.start import launch_development_qgis
 from qgis_plugin_dev_tools.start.config import DevelopmentModeConfig
-from qgis_plugin_dev_tools.utils.distributions import (
-    get_distribution_top_level_package_names,
-)
+from qgis_plugin_dev_tools.utils.distributions import get_distribution_top_level_names
 
 LOGGER = logging.getLogger(__name__)
 
 
-def start(dotenv_file_paths: List[Path]) -> None:
+def start(dotenv_file_paths: list[Path]) -> None:
     # TODO: allow choosing pyproject file from cli?
     dev_tools_config = DevToolsConfig.from_pyproject_config(Path("pyproject.toml"))
     # TODO: allow setting debugger flag from cli?
@@ -63,13 +61,16 @@ def start(dotenv_file_paths: List[Path]) -> None:
             plugin_dependency_package_names=[
                 name
                 for dist in dev_tools_config.runtime_distributions
-                for name in get_distribution_top_level_package_names(dist)
+                for name in get_distribution_top_level_names(dist)
             ],
             debugger_library=dotenv_config.DEBUGGER_LIBRARY,
             extra_plugin_package_names=[
                 entry_point.name
                 for entry_point in entry_points_found_from_python_env
-                if entry_point.name != dev_tools_config.plugin_package_name
+                if (
+                    entry_point.name != dev_tools_config.plugin_package_name
+                    and entry_point.name not in dev_tools_config.disabled_extra_plugins
+                )
             ],
         )
     )

qgis_plugin_dev_tools/config/__init__.py

@@ -21,7 +21,6 @@ from collections import ChainMap
 from enum import Enum, auto
 from importlib.util import find_spec
 from pathlib import Path
-from typing import List
 
 from importlib_metadata import Distribution, distribution
 from packaging.requirements import Requirement
@@ -39,25 +38,27 @@ class VersionNumberSource(Enum):
         try:
             return VersionNumberSource[config_value.upper()]
         except KeyError:
-            raise ValueError(f"{config_value=} is not a valid value")
+            raise ValueError(f"{config_value=} is not a valid value") from None
 
 
 class DevToolsConfig:
     plugin_package_name: str
     plugin_package_path: Path
-    runtime_distributions: List[Distribution]
+    runtime_distributions: list[Distribution]
     changelog_file_path: Path
     append_distributions_to_path: bool
     version_number_source: VersionNumberSource
+    disabled_extra_plugins: list[str]
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         plugin_package_name: str,
-        runtime_requires: List[str],
+        runtime_requires: list[str],
         changelog_file_path: Path,
         append_distributions_to_path: bool,
         auto_add_recursive_runtime_dependencies: bool,
-        version_number_source: VersionNumberSource = VersionNumberSource.CHANGELOG,
+        version_number_source: VersionNumberSource,
+        disabled_extra_plugins: list[str],
     ) -> None:
         plugin_package_spec = find_spec(plugin_package_name)
         if plugin_package_spec is None or plugin_package_spec.origin is None:
@@ -75,17 +76,23 @@ class DevToolsConfig:
         self.append_distributions_to_path = append_distributions_to_path
         self.version_number_source = version_number_source
         self.extra_runtime_distributions = []
+        self.disabled_extra_plugins = disabled_extra_plugins
 
         if auto_add_recursive_runtime_dependencies:
             # Add the requirements of the distributions as well
-            self.extra_runtime_distributions = list(
-                ChainMap(
+            distributions_versions = {
+                dist.name: dist.version for dist in self.runtime_distributions
+            }
+            self.extra_runtime_distributions = [
+                dist
+                for dist in ChainMap(
                     *(
                         get_distribution_requirements(dist)
                         for dist in self.runtime_distributions
                     )
                 ).values()
-            )
+                if distributions_versions.get(dist.name) != dist.version
+            ]
 
     @staticmethod
     def from_pyproject_config(pyproject_file_path: Path) -> "DevToolsConfig":
@@ -104,4 +111,5 @@ class DevToolsConfig:
             version_number_source=VersionNumberSource.from_config_value(
                 pyproject_config.version_number_source
             ),
+            disabled_extra_plugins=pyproject_config.disabled_extra_plugins,
         )

qgis_plugin_dev_tools/config/dotenv.py

@@ -19,14 +19,14 @@
 
 import logging
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Optional
 
 from dotenv import dotenv_values
 
 LOGGER = logging.getLogger(__name__)
 
 
-class DotenvConfig:  # noqa SIM119
+class DotenvConfig:
     """
     Expected structure for the config keys in the .env.
     """
@@ -34,14 +34,14 @@ class DotenvConfig:  # noqa SIM119
     QGIS_EXECUTABLE_PATH: Path
     DEBUGGER_LIBRARY: Optional[str]
     DEVELOPMENT_PROFILE_NAME: Optional[str]
-    runtime_environment: Dict[str, str]
+    runtime_environment: dict[str, str]
 
     def __init__(
         self,
         *,
-        QGIS_EXECUTABLE_PATH: str,  # noqa N803
-        DEBUGGER_LIBRARY: Optional[str] = None,  # noqa N803
-        DEVELOPMENT_PROFILE_NAME: Optional[str] = None,  # noqa N803
+        QGIS_EXECUTABLE_PATH: str,  # noqa: N803
+        DEBUGGER_LIBRARY: Optional[str] = None,  # noqa: N803
+        DEVELOPMENT_PROFILE_NAME: Optional[str] = None,  # noqa: N803
         **other_vars: str,
     ) -> None:
         self.QGIS_EXECUTABLE_PATH = Path(QGIS_EXECUTABLE_PATH)
@@ -54,7 +54,7 @@ class DotenvConfig:  # noqa SIM119
         self.runtime_environment = other_vars
 
 
-def read_dotenv_configs(dotenv_file_paths: List[Path]) -> DotenvConfig:
+def read_dotenv_configs(dotenv_file_paths: list[Path]) -> DotenvConfig:
     config = {}
     for dotenv_file_path in dotenv_file_paths:
         LOGGER.debug("reading config from %s", dotenv_file_path.resolve())
@@ -62,4 +62,4 @@ def read_dotenv_configs(dotenv_file_paths: List[Path]) -> DotenvConfig:
     try:
         return DotenvConfig(**{k: v for k, v in config.items() if v})
     except (KeyError, TypeError) as e:
-        raise ValueError(f"dev tools config invalid in .env: {e}")
+        raise ValueError(f"dev tools config invalid in .env: {e}") from e

qgis_plugin_dev_tools/config/pyproject.py

@@ -20,7 +20,7 @@
 import logging
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List, Literal, Union
+from typing import Literal, Union
 
 import tomli
 
@@ -36,12 +36,13 @@ class PyprojectConfig:
     DEV_TOOLS_SECTION_LOCATOR = "qgis_plugin_dev_tools"
 
     plugin_package_name: str
-    runtime_requires: List[str] = field(default_factory=list)
+    runtime_requires: list[str] = field(default_factory=list)
     use_dangerous_vendor_sys_path_append: bool = False
     auto_add_recursive_runtime_dependencies: bool = False
     version_number_source: Union[
         Literal["changelog"], Literal["distribution"]
     ] = "changelog"
+    disabled_extra_plugins: list[str] = field(default_factory=list)
 
     def __post_init__(self) -> None:
         if self.version_number_source not in ["changelog", "distribution"]:
@@ -60,4 +61,4 @@ def read_pyproject_config(pyproject_file_path: Path) -> PyprojectConfig:
             ]
             return PyprojectConfig(**dev_tools_configuration)
         except (KeyError, TypeError) as e:
-            raise ValueError(f"dev tools config invalid in pyproject.toml: {e}")
+            raise ValueError(f"dev tools config invalid in pyproject.toml: {e}") from e

qgis_plugin_dev_tools/publish/__init__.py

@@ -4,13 +4,15 @@ import logging
 import os
 from base64 import b64encode
 from pathlib import Path
-from typing import Dict, Tuple, cast
+from typing import cast
 from uuid import uuid4
 
 import requests
 
 LOGGER = logging.getLogger(__name__)
 
+HTTP_STATUS_CODE_OK = 200
+
 
 def publish_plugin_zip_file(plugin_zip_file_path: Path) -> None:
     username = os.environ.get("QPDT_PUBLISH_USERNAME")
@@ -51,7 +53,7 @@ def publish_plugin_zip_file(plugin_zip_file_path: Path) -> None:
         response.text,
     )
 
-    if response.status_code != 200:
+    if response.status_code != HTTP_STATUS_CODE_OK:
         raise Exception(
             "QGIS plugin repository plugin upload "
             f"HTTP request failed with status {response.status_code}"
@@ -62,7 +64,7 @@ def publish_plugin_zip_file(plugin_zip_file_path: Path) -> None:
             f"request returned error response {response.json().get('error')}"
         )
 
-    plugin_id, version_id = cast(Dict[str, Tuple[int, int]], response.json()).get(
+    plugin_id, version_id = cast(dict[str, tuple[int, int]], response.json()).get(
         "result", (None, None)
     )
 

qgis_plugin_dev_tools/start/__init__.py

@@ -32,13 +32,11 @@ def launch_development_qgis(
 ) -> None:
     LOGGER.info("starting daemon server")
     with start_daemon_server() as (port, handle_single_request):
-
         LOGGER.info("creating a bootstrap file")
         with create_bootstrap_file(
             development_mode_config,
             port,
         ) as bootstrap_file_path:
-
             LOGGER.info("launching qgis")
             launch_qgis_with_bootstrap_script(
                 development_mode_config.qgis_executable_path,

qgis_plugin_dev_tools/start/bootstrap/__init__.py

@@ -21,11 +21,11 @@ import dataclasses
 import logging
 import pickle
 import sys
+from collections.abc import Generator
 from contextlib import contextmanager
 from importlib import resources
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Generator
 
 from qgis_plugin_dev_tools.start.bootstrap.template import BootstrapConfig
 from qgis_plugin_dev_tools.start.config import DevelopmentModeConfig
@@ -44,10 +44,10 @@ def create_bootstrap_file(
             runtime_environment=development_mode_configuration.runtime_environment,
             plugin_package_path=development_mode_configuration.plugin_package_path,
             plugin_package_name=development_mode_configuration.plugin_package_name,
-            plugin_dependency_package_names=development_mode_configuration.plugin_dependency_package_names,  # noqa E501
+            plugin_dependency_package_names=development_mode_configuration.plugin_dependency_package_names,
             debugger_library=development_mode_configuration.debugger_library,
             bootstrap_python_executable_path=Path(sys.executable),
-            extra_plugin_package_names=development_mode_configuration.extra_plugin_package_names,  # noqa E501
+            extra_plugin_package_names=development_mode_configuration.extra_plugin_package_names,
         )
 
         LOGGER.debug("using bootstrap config:\n%s", bootstrap_config)

qgis_plugin_dev_tools/start/bootstrap/template.py

@@ -26,14 +26,14 @@ import sys
 from dataclasses import asdict, dataclass
 from importlib.util import find_spec
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Optional
 
 # defer qgis.* imports until necessary to avoid loading those
 # for the interpreter that launches the bootstrapping, since it
 # will import the config class from this module
 
 
-def _unload_package_modules(package_names: List[str]) -> None:
+def _unload_package_modules(package_names: list[str]) -> None:
     to_clean_names = [
         module_name
         for module_name in sys.modules
@@ -43,19 +43,17 @@ def _unload_package_modules(package_names: List[str]) -> None:
         )
     ]
     for module_name in to_clean_names:
-        try:  # noqa SIM105
+        try:
             if hasattr(sys.modules[module_name], "qCleanupResources"):
                 sys.modules[module_name].qCleanupResources()
-        except Exception:  # noqa PIE786
+        except Exception:
             pass
-        try:  # noqa SIM105
+        with contextlib.suppress(Exception):
             del sys.modules[module_name]
-        except Exception:  # noqa PIE786
-            pass
 
 
 def _monkeypatch_plugin_module_unload_to_unload_dependencies(
-    plugin_package_name: str, plugin_dependency_package_names: List[str]
+    plugin_package_name: str, plugin_dependency_package_names: list[str]
 ) -> None:
     from qgis.core import Qgis, QgsMessageLog
 
@@ -67,7 +65,7 @@ def _monkeypatch_plugin_module_unload_to_unload_dependencies(
             level=Qgis.Info,
         )
 
-        from qgis.utils import (  # noqa N813 (qgis naming)
+        from qgis.utils import (  # (qgis naming)
             _unloadPluginModules as _original_unload,
         )
 
@@ -75,7 +73,7 @@ def _monkeypatch_plugin_module_unload_to_unload_dependencies(
             _unload_package_modules, plugin_dependency_package_names
         )
 
-        def _custom_unload(packageName: str) -> bool:  # noqa N803 (qgis naming)
+        def _custom_unload(packageName: str) -> bool:  # noqa: N803 (qgis naming)
             original_return = _original_unload(packageName)
             if packageName == plugin_package_name:
                 unload_plugin_dependency_modules()
@@ -87,14 +85,14 @@ def _monkeypatch_plugin_module_unload_to_unload_dependencies(
 
 
 def _monkeypatch_plugin_reload_to_reload_extra_plugins(
-    main_plugin_package_name: str, extra_plugin_package_names: List[str]
+    main_plugin_package_name: str, extra_plugin_package_names: list[str]
 ) -> None:
     from qgis.core import Qgis, QgsMessageLog
-    from qgis.utils import loadPlugin as _original_load  # noqa N813 (qgis naming)
+    from qgis.utils import loadPlugin as _original_load  # noqa: N813 (qgis naming)
     from qgis.utils import startPlugin
-    from qgis.utils import unloadPlugin as _original_unload  # noqa N813 (qgis naming)
+    from qgis.utils import unloadPlugin as _original_unload  # noqa: N813 (qgis naming)
 
-    def _custom_unload(packageName: str) -> bool:  # noqa N803 (qgis naming)
+    def _custom_unload(packageName: str) -> bool:  # noqa: N803 (qgis naming)
         original_return = _original_unload(packageName)
 
         if packageName == main_plugin_package_name:
@@ -104,7 +102,7 @@ def _monkeypatch_plugin_reload_to_reload_extra_plugins(
 
         return original_return
 
-    def _custom_load(packageName: str) -> bool:  # noqa N803 (qgis naming)
+    def _custom_load(packageName: str) -> bool:  # noqa: N803 (qgis naming)
         if packageName == main_plugin_package_name:
             for plugin_package_name in extra_plugin_package_names:
                 with contextlib.suppress(Exception):
@@ -124,7 +122,7 @@ def _monkeypatch_plugin_reload_to_reload_extra_plugins(
     qgis_utils_module.loadPlugin = _custom_load
 
 
-def _setup_runtime_library_paths(runtime_library_paths: List[Path]) -> None:
+def _setup_runtime_library_paths(runtime_library_paths: list[Path]) -> None:
     from qgis.core import Qgis, QgsMessageLog
 
     QgsMessageLog.logMessage(
@@ -133,7 +131,7 @@ def _setup_runtime_library_paths(runtime_library_paths: List[Path]) -> None:
     sys.path.extend(str(p) for p in runtime_library_paths)
 
 
-def _setup_runtime_environment(runtime_environment: Dict[str, str]) -> None:
+def _setup_runtime_environment(runtime_environment: dict[str, str]) -> None:
     from qgis.core import Qgis, QgsMessageLog
 
     QgsMessageLog.logMessage("setting dev env variables", "Bootstrap", level=Qgis.Info)
@@ -141,7 +139,7 @@ def _setup_runtime_environment(runtime_environment: Dict[str, str]) -> None:
 
 
 def _enable_extra_plugins(
-    main_plugin_package_name: str, extra_plugin_package_names: List[str]
+    main_plugin_package_name: str, extra_plugin_package_names: list[str]
 ) -> None:
     from qgis.PyQt.QtCore import QSettings
     from qgis.utils import plugin_paths, unloadPlugin
@@ -162,7 +160,7 @@ def _enable_extra_plugins(
 def _enable_plugin(
     plugin_package_name: str,
     plugin_package_path: Path,
-    plugin_dependency_package_names: List[str],
+    plugin_dependency_package_names: list[str],
 ) -> None:
     from pyplugin_installer.installer_data import plugins as installer_plugins
     from qgis.core import Qgis, QgsMessageLog
@@ -240,24 +238,24 @@ def _start_debugger(library_name: Optional[str], python_executable_path: Path) -
 
     try:
         if library_name == "debugpy":
-            import debugpy  # noqa SC200
+            import debugpy  # noqa: SC200
 
             # at least on windows qgis resets the env and sys.executable points
             # to the qgis executable, hold on to the original python to use here
-            debugpy.configure(python=str(python_executable_path))  # noqa SC200
-            debugpy.listen(("localhost", 5678))  # noqa SC200
+            debugpy.configure(python=str(python_executable_path))  # noqa: SC200
+            debugpy.listen(("localhost", 5678))  # noqa: SC200
 
         elif library_name == "pydevd":
-            import pydevd  # noqa SC200
+            import pydevd  # noqa: SC200
 
-            pydevd.settrace(  # noqa SC200
+            pydevd.settrace(  # noqa: SC200
                 "localhost", port=5678, stdoutToServer=True, stderrToServer=True
             )
 
         else:
             return
 
-    except Exception as e:  # noqa PIE786
+    except Exception as e:
         QgsMessageLog.logMessage(
             f"failed to start {library_name} debugger: {e}",
             "Bootstrap",
@@ -274,14 +272,14 @@ def _start_debugger(library_name: Optional[str], python_executable_path: Path) -
 @dataclass
 class BootstrapConfig:
     daemon_socket_port: int
-    runtime_library_paths: List[Path]
-    runtime_environment: Dict[str, str]
+    runtime_library_paths: list[Path]
+    runtime_environment: dict[str, str]
     plugin_package_path: Path
     plugin_package_name: str
-    plugin_dependency_package_names: List[str]
+    plugin_dependency_package_names: list[str]
     debugger_library: Optional[str]
     bootstrap_python_executable_path: Path
-    extra_plugin_package_names: List[str]
+    extra_plugin_package_names: list[str]
 
     def __str__(self) -> str:
         result = ""

qgis_plugin_dev_tools/start/config.py

@@ -19,17 +19,17 @@
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Optional
 
 
 @dataclass
 class DevelopmentModeConfig:
     qgis_executable_path: Path
     profile_name: Optional[str]
-    runtime_environment: Dict[str, str]
-    runtime_library_paths: List[Path]
+    runtime_environment: dict[str, str]
+    runtime_library_paths: list[Path]
     plugin_package_path: Path
     plugin_package_name: str
-    plugin_dependency_package_names: List[str]
+    plugin_dependency_package_names: list[str]
     debugger_library: Optional[str]
-    extra_plugin_package_names: List[str]
+    extra_plugin_package_names: list[str]

qgis_plugin_dev_tools/start/daemon_server.py

@@ -17,9 +17,10 @@
 #  You should have received a copy of the GNU General Public License
 #  along with qgis-plugin-dev-tools. If not, see <https://www.gnu.org/licenses/>.
 
+from collections.abc import Generator
 from contextlib import contextmanager
 from socketserver import BaseRequestHandler, TCPServer
-from typing import Callable, Generator, Tuple
+from typing import Callable
 
 DAEMON_SERVER_TIMEOUT = 60
 
@@ -34,7 +35,7 @@ class SingleRequestHandlingTCPServer(TCPServer):
 
 
 @contextmanager
-def start_daemon_server() -> Generator[Tuple[int, Callable[[], bool]], None, None]:
+def start_daemon_server() -> Generator[tuple[int, Callable[[], bool]], None, None]:
     # TODO: add hot reload instead of closing the daemon?
     # watcher = QFileSystemWatcher([str(p) for p in Path(plugin_path).rglob('*.py')])
     # watcher.fileChanged.connect(send_something_to_socket)

qgis_plugin_dev_tools/utils/distributions.py

@@ -16,28 +16,69 @@
 #
 #  You should have received a copy of the GNU General Public License
 #  along with qgis-plugin-dev-tools. If not, see <https://www.gnu.org/licenses/>.
+import importlib.util
+import logging
+from importlib.machinery import SourceFileLoader
+from typing import Optional, cast
 
-from typing import Dict, List
-
+import importlib_metadata
 from importlib_metadata import Distribution, distribution
 from packaging.requirements import Requirement
 
+LOGGER = logging.getLogger(__name__)
+
+
+def get_distribution_top_level_names(dist: Distribution) -> set[str]:
+    if (file_paths := dist.files) is None:
+        LOGGER.warning("could not resolve %s top level names", dist.name)
+        return set()
+
+    return {
+        top_level_directory_name
+        for path in file_paths
+        if (
+            len(path.parts) > 1
+            and not (top_level_directory_name := path.parts[0]).endswith(
+                (".dist-info", ".egg-info")
+            )
+            and top_level_directory_name not in ("..", "__pycache__")
+        )
+    } | {
+        path.stem
+        for path in file_paths
+        if len(path.parts) == 1 and path.suffix in (".py", ".pyd")
+    }
 
-def get_distribution_top_level_package_names(dist: Distribution) -> List[str]:
-    return (dist.read_text("top_level.txt") or "").split()
 
+def get_distribution_requirements(dist: Distribution) -> dict[str, Distribution]:
+    requirement_distributions: dict[str, Distribution] = {}
 
-def get_distribution_requirements(dist: Distribution) -> Dict[str, Distribution]:
     requirements = [
         Requirement(requirement.split(" ")[0])
         for requirement in dist.requires or []
         if "extra ==" not in requirement
     ]
-    distributions = {
-        requirement.name: distribution(requirement.name) for requirement in requirements
-    }
-    sub_requirements = {}
-    for requirement in distributions.values():
-        sub_requirements.update(get_distribution_requirements(requirement))
-    distributions.update(sub_requirements)
-    return distributions
+    for requirement in requirements:
+        try:
+            requirement_distributions[requirement.name] = distribution(requirement.name)
+        except importlib_metadata.PackageNotFoundError:
+            LOGGER.warning(
+                "Getting distribution for %s failed. "
+                "This may be caused by including builtin "
+                "packages as requirements.",
+                requirement.name,
+            )
+            spec = importlib.util.find_spec(requirement.name)
+            loader = cast(Optional[SourceFileLoader], spec.loader) if spec else None
+            if spec and loader and loader.is_package(requirement.name):
+                LOGGER.error("Could not find package %s", requirement.name)
+            continue
+
+    nested_requirement_distributions: dict[str, Distribution] = {}
+    for requirement_distribution in requirement_distributions.values():
+        nested_requirement_distributions.update(
+            get_distribution_requirements(requirement_distribution)
+        )
+    requirement_distributions.update(nested_requirement_distributions)
+
+    return requirement_distributions

{qgis_plugin_dev_tools-0.6.1.dist-info → qgis_plugin_dev_tools-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qgis-plugin-dev-tools
-Version: 0.6.1
+Version: 0.7.0
 Summary: QGIS plugin development and packaging tools, which make managing runtime dependencies easy.
 Home-page: https://github.com/nlsfi/qgis-plugin-dev-tools
 Author: National Land Survey of Finland
@@ -135,6 +135,15 @@ Development mode also enables using and developing multiple plugins easily if ce
 
 Extra plugins are loaded on launch and reloaded together with the main plugin if [Plugin Reloader] is used.
 
+You can disable plugin auto-load by using `pyproject.toml` configuration (for example when using a dependency, that also provides a plugin entrypoint):
+
+```toml
+[tool.qgis_plugin_dev_tools]
+disabled_extra_plugins = [
+  "unwanted_plugin_package_name",
+]
+```
+
 ## Development of qgis-plugin-dev-tools
 
 See [development readme](./DEVELOPMENT.md).
@@ -156,6 +165,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2024-05-21
+
+- Fix: Bundle contents by parsing pep-compliant distribution file catalog instead of possibly missing tool-specific top-level.txt
+- Feat: Allow disabling auto-loaded entrypoint plugins
+
+## [0.6.2] - 2023-09-27
+
+- Fix: Fix issues with bundling requirements of the requirements recursively
+
 ## [0.6.1] - 2023-09-06
 
 - update author email
@@ -213,3 +231,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [0.5.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.5.0
 [0.6.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.0
 [0.6.1]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.1
+[0.6.2]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.2
+[0.7.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.7.0

qgis_plugin_dev_tools-0.7.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+qgis_plugin_dev_tools/__init__.py,sha256=3mpZORDnC1ScS0CWLrneAkXL6sWo8WJ34AxblGmNXqc,1064
+qgis_plugin_dev_tools/__main__.py,sha256=EqC7agwIoIKbMeOPrcpDWGAQmsaO_oFc0OkIxlowzmA,900
+qgis_plugin_dev_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qgis_plugin_dev_tools/build/__init__.py,sha256=RbPVZeH29y8efqZRO0dmnH1ArzRvhcpOj9Ka60plX8c,3514
+qgis_plugin_dev_tools/build/changelog_parser.py,sha256=t9u30K2DyWXBOW47r2dMXzP-nbW7oIFCkYeBzsL8r_A,2212
+qgis_plugin_dev_tools/build/distribution.py,sha256=ST2h-YeVh8HWeDURhXoG_Rba9Zha167tdBlVJbXEdQQ,835
+qgis_plugin_dev_tools/build/metadata.py,sha256=rDKRDmvgJxsrlEWKnHNfq3gqOQxClgtNUeeKIIYyMos,1429
+qgis_plugin_dev_tools/build/packaging.py,sha256=ShLrWY_tGlf9orj865MzuET8VRJTpODgb1CPNvISosc,6714
+qgis_plugin_dev_tools/build/rewrite_imports.py,sha256=YZ3ORvm_7Gf6tBKqjqzp-BR-Q_CoIbIh7MlxRZIfPQA,5945
+qgis_plugin_dev_tools/cli/__init__.py,sha256=_LfVofPZDwIZA9OoDs_cU5d3qptnOzpbljf_s_9s9f0,6137
+qgis_plugin_dev_tools/config/__init__.py,sha256=7l7Iyjst-pqLobiAO2bKLvkQFLVWoq4O_rny9lQvHp8,4678
+qgis_plugin_dev_tools/config/dotenv.py,sha256=WMEcp8Qnt-Vh0XaP8ieQ868U9tH4_pYXTeZ5ZMraJVw,2372
+qgis_plugin_dev_tools/config/pyproject.py,sha256=QvhZIk4QQezKSmTm28IG_lHBIO59CUQmAUQNB78Gxa4,2383
+qgis_plugin_dev_tools/publish/__init__.py,sha256=PB0bUWl6vjDSlqPm92hw2Vtn1A3sqymm3pWgkWsPCOI,2081
+qgis_plugin_dev_tools/start/__init__.py,sha256=f1It2zeTzomxKHm2mbXTBoe3v7MoZ5aXbEkPrL9IrC8,2085
+qgis_plugin_dev_tools/start/config.py,sha256=kkTuPu-TSKeK1MHDZOcoTTw2LZz4psxJamJTfbAY7aQ,1274
+qgis_plugin_dev_tools/start/daemon_server.py,sha256=1i0MWQ0NnbBKZzV6OdT2BZaDEqcIx29ABCIJPorECkg,1845
+qgis_plugin_dev_tools/start/launch.py,sha256=koF0wfT8t8R0_ofy7dN_LSKGM_g9BjHfCKz5DRxc8IE,1612
+qgis_plugin_dev_tools/start/bootstrap/__init__.py,sha256=4FoIYBxXM7zgyaTM4gz5fGD99kYaaqEm-LwBj3Fbuks,2750
+qgis_plugin_dev_tools/start/bootstrap/template.py,sha256=KV2EgHSMxKzA7wbKaxYwPnn6c1f7D2Yrd1Qq_Huh6y0,12432
+qgis_plugin_dev_tools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qgis_plugin_dev_tools/utils/distributions.py,sha256=Q2jZT44Iw8LIBNrf1X2thfCLiKu9yiu7joj0Pdxk-Oc,3215
+qgis_plugin_dev_tools-0.7.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+qgis_plugin_dev_tools-0.7.0.dist-info/METADATA,sha256=rl7tvnGaGFnWWPZj3Ij7eOxIaiSDHCcENv6g-mYhL_Q,10457
+qgis_plugin_dev_tools-0.7.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qgis_plugin_dev_tools-0.7.0.dist-info/entry_points.txt,sha256=RwM8y7cN8cRk003jpw-psB4DvifC5foZKSi04IDRBVw,109
+qgis_plugin_dev_tools-0.7.0.dist-info/top_level.txt,sha256=JjwWwRniudLz30UtQJgmIQDeS3HgU5VBgDlKYJhz-nQ,22
+qgis_plugin_dev_tools-0.7.0.dist-info/RECORD,,

{qgis_plugin_dev_tools-0.6.1.dist-info → qgis_plugin_dev_tools-0.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

qgis_plugin_dev_tools-0.6.1.dist-info/RECORD

@@ -1,28 +0,0 @@
-qgis_plugin_dev_tools/__init__.py,sha256=WLzrOZJP6WOaC66FgMUxO0p-qckd3X6c33f51sWH8wM,1064
-qgis_plugin_dev_tools/__main__.py,sha256=EqC7agwIoIKbMeOPrcpDWGAQmsaO_oFc0OkIxlowzmA,900
-qgis_plugin_dev_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qgis_plugin_dev_tools/build/__init__.py,sha256=RbPVZeH29y8efqZRO0dmnH1ArzRvhcpOj9Ka60plX8c,3514
-qgis_plugin_dev_tools/build/changelog_parser.py,sha256=t9u30K2DyWXBOW47r2dMXzP-nbW7oIFCkYeBzsL8r_A,2212
-qgis_plugin_dev_tools/build/distribution.py,sha256=ST2h-YeVh8HWeDURhXoG_Rba9Zha167tdBlVJbXEdQQ,835
-qgis_plugin_dev_tools/build/metadata.py,sha256=rDKRDmvgJxsrlEWKnHNfq3gqOQxClgtNUeeKIIYyMos,1429
-qgis_plugin_dev_tools/build/packaging.py,sha256=ZoS_H6kcMvZOm8JaEsBz7jotLbh6rulZaxJcDb3MkWA,6798
-qgis_plugin_dev_tools/build/rewrite_imports.py,sha256=LNqIgoKCjc6H0BCYq2APGuB44aJ9QdmroTp6y-HzRPc,5943
-qgis_plugin_dev_tools/cli/__init__.py,sha256=L2kTsaxXk27OMPufHf2wlBQOPJv-YUyvQ3ttH1drVQ0,6040
-qgis_plugin_dev_tools/config/__init__.py,sha256=Xx-Xf3psUcSd0FqAgRG9CQFxabkRcNp2NgDIt3yyNoM,4255
-qgis_plugin_dev_tools/config/dotenv.py,sha256=b0Vt-OHwML9rFHAJTxlgnU2rSzIgcZIgIfJF_wSmSpg,2389
-qgis_plugin_dev_tools/config/pyproject.py,sha256=rsiavq377mNuYtLPX9wk65TDskwxTTG0cnEGt3UWsUg,2314
-qgis_plugin_dev_tools/publish/__init__.py,sha256=XRxYfWzHBROqEBPu2k-HxZNDbTVoPOuVRF5qd9F1XpU,2051
-qgis_plugin_dev_tools/start/__init__.py,sha256=yDlvaA5smjimK31EcwhmLndjNdzK_m8sJlrM-DlUI0Q,2087
-qgis_plugin_dev_tools/start/config.py,sha256=SCHjvcjPIw2jeI8RFCijOaQBYmkUDU0hFDC9ctChpnc,1286
-qgis_plugin_dev_tools/start/daemon_server.py,sha256=lyD40pVz5C1cPxmWVgbPobAwynKLBo-hddqntWXITRA,1825
-qgis_plugin_dev_tools/start/launch.py,sha256=koF0wfT8t8R0_ofy7dN_LSKGM_g9BjHfCKz5DRxc8IE,1612
-qgis_plugin_dev_tools/start/bootstrap/__init__.py,sha256=qahrpF95vufP-M_lA6uDoLk84FSKpl2EOytRiMHjdZ0,2767
-qgis_plugin_dev_tools/start/bootstrap/template.py,sha256=Qlh88TkZ4Gx53WW8ouZEZUJFL6xzAtvMJ_NRwcVy6Yk,12530
-qgis_plugin_dev_tools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qgis_plugin_dev_tools/utils/distributions.py,sha256=hrNiCbMAuO8rlh8bqminvXfPAkPHXTOjkB_TH1_HuT8,1676
-qgis_plugin_dev_tools-0.6.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-qgis_plugin_dev_tools-0.6.1.dist-info/METADATA,sha256=9NmVvNKFbwW64wgLixSvLZE8v9L3XUIIHn0YpLJu0HM,9733
-qgis_plugin_dev_tools-0.6.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-qgis_plugin_dev_tools-0.6.1.dist-info/entry_points.txt,sha256=RwM8y7cN8cRk003jpw-psB4DvifC5foZKSi04IDRBVw,109
-qgis_plugin_dev_tools-0.6.1.dist-info/top_level.txt,sha256=JjwWwRniudLz30UtQJgmIQDeS3HgU5VBgDlKYJhz-nQ,22
-qgis_plugin_dev_tools-0.6.1.dist-info/RECORD,,