use from packaging.requirements import Requirement instead of pkg_resources.Requirement

Author: jensens

.github/workflows/tests.yaml

@@ -14,6 +14,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
       - uses: pre-commit/action@v3.0.0
   build:
     strategy:

.pre-commit-config.yaml

@@ -1,19 +1,19 @@
 ---
 repos:
   - repo: https://github.com/psf/black.git
-    rev: 22.3.0
+    rev: 24.2.0
     hooks:
       - id: black
         language_version: python3
         exclude: ^(tests\/hooks-abort-render\/hooks|docs\/HelloCookieCutter1)
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v0.960'  # Use the sha / tag you want to point at
+    rev: 'v1.9.0'  # Use the sha / tag you want to point at
     hooks:
       - id: mypy
         additional_dependencies: [types-setuptools]
   - repo: https://github.com/PyCQA/doc8
-    rev: 0.8.1
+    rev: v1.1.1
     hooks:
       - id: doc8
         name: doc8
@@ -28,13 +28,8 @@ repos:
   #     - id: flake8
   #       additional_dependencies:
   #         - flake8-docstrings
-  # - repo: https://github.com/PyCQA/bandit
-  #   rev: 1.6.0
-  #   hooks:
-  #     - id: bandit
-  #       args: [--ini, .bandit]
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.48"
+    rev: "0.49"
     hooks:
     -   id: check-manifest
   # - repo: https://github.com/Lucas-C/pre-commit-hooks-safety

CHANGES.md

@@ -2,9 +2,9 @@
 
 ## 4.0.2 (unreleased)
 
-
-- Nothing changed yet.
-
+- Fix #42: deprecated use of `pkg_resoures` to load entry points and parse requirements.
+  This enables mxdev to work on Python 3.12, where `pkg_resources` is no longer installed by default in virtual_envs.
+  [jensens]
 
 ## 4.0.1 (2024-03-01)
 

Makefile

@@ -81,8 +81,8 @@ VENV_CREATE?=true
 # target folder for the virtual environment. If `VENV_ENABLED` is `true` and
 # `VENV_CREATE` is false it is expected to point to an existing virtual
 # environment. If `VENV_ENABLED` is `false` it is ignored.
-# Default: venv
-VENV_FOLDER?=venv
+# Default: .venv
+VENV_FOLDER?=.venv
 
 # mxdev to install in virtual environment.
 # Default: mxdev
@@ -222,8 +222,13 @@ endif
 
 # Determine the executable path
 ifeq ("$(VENV_ENABLED)", "true")
-export PATH:=$(abspath $(VENV_FOLDER))/bin:$(PATH)
 export VIRTUAL_ENV=$(abspath $(VENV_FOLDER))
+ifeq ("$(OS)", "Windows_NT")
+VENV_EXECUTABLE_FOLDER=$(VIRTUAL_ENV)/Scripts
+else
+VENV_EXECUTABLE_FOLDER=$(VIRTUAL_ENV)/bin
+endif
+export PATH:=$(VENV_EXECUTABLE_FOLDER):$(PATH)
 MXENV_PYTHON=python
 else
 MXENV_PYTHON=$(PRIMARY_PYTHON)

pyproject.toml

@@ -21,7 +21,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-dependencies = []
+dependencies = ["packaging"]
 dynamic = ["readme"]
 
 [project.optional-dependencies]

src/mxdev/config.py

@@ -1,8 +1,8 @@
 from .including import read_with_included
 from .logging import logger
+from packaging.requirements import Requirement
 
 import os
-import pkg_resources
 import typing
 
 
@@ -55,11 +55,11 @@ def __init__(
         self.overrides = {}
         for line in raw_overrides.split("\n"):
             try:
-                parsed = pkg_resources.Requirement.parse(line)
+                parsed = Requirement(line)
             except Exception:
                 logger.error(f"Can not parse override: {line}")
                 continue
-            self.overrides[parsed.key] = line
+            self.overrides[parsed.name] = line
 
         raw_ignores = settings.get("ignores", "").strip()
         self.ignore_keys = []

src/mxdev/entry_points.py

@@ -20,8 +20,8 @@ def load_eps_by_group(group: str) -> list:
         eps_base = entry_points()
         if group not in eps_base:
             return []
-        eps = eps_base[group]
+        eps = eps_base[group]  # type: ignore
     # XXX: for some reasons entry points are loaded twice. not sure if this
     #      is a glitch when installing with uv or something related to
     #      importlib.metadata.entry_points
-    return list(eps)  # type: ignore
+    return list(set(eps))  # type: ignore

src/mxdev/hooks.py

@@ -32,7 +32,6 @@ def load_hooks() -> list:
 
 def read_hooks(state: State, hooks: typing.List[Hook]) -> None:
     for hook in hooks:
-        breakpoint()
         hook.read(state)
 
 

src/mxdev/processing.py

@@ -1,11 +1,11 @@
 from .logging import logger
 from .state import State
 from .vcs.common import WorkingCopies
+from packaging.requirements import Requirement
 from pathlib import Path
 from urllib import parse
 from urllib import request
 
-import pkg_resources
 import typing
 
 
@@ -49,15 +49,15 @@ def process_line(
             variety="r",
         )
     try:
-        parsed = pkg_resources.Requirement.parse(line)
+        parsed = Requirement(line)
     except Exception:
         pass
     else:
-        if parsed.key in package_keys:
+        if parsed.name in package_keys:
             line = f"# {line.strip()} -> mxdev disabled (source)\n"
-        if variety == "c" and parsed.key in override_keys:
+        if variety == "c" and parsed.name in override_keys:
             line = f"# {line.strip()} -> mxdev disabled (override)\n"
-        if variety == "c" and parsed.key in ignore_keys:
+        if variety == "c" and parsed.name in ignore_keys:
             line = f"# {line.strip()} -> mxdev disabled (ignore)\n"
     if variety == "c":
         return [], [line]

src/mxdev/vcs/common.py

@@ -147,23 +147,16 @@ def get_workingcopytypes() -> typing.Dict[str, typing.Type[BaseWorkingCopy]]:
     if _workingcopytypes:
         return _workingcopytypes
     group = "mxdev.workingcopytypes"
-    addons = {}
+    addons: dict[str, typing.Type[BaseWorkingCopy]] = {}
     for entrypoint in load_eps_by_group(group):
         key = entrypoint.name
         workingcopytype = entrypoint.load()
-        if not entrypoint.dist:
-            continue
-        if entrypoint.dist.name == "mxdev":
-            _workingcopytypes[key] = workingcopytype
-            continue
         if key in addons:
             logger.error(
-                f"There already is a working copy type addon registered for '{key}'."
+                f"Duplicate workingcopy types registration '{key}' at "
+                f"{entrypoint.value} can not override {addons[key]}"
             )
             sys.exit(1)
-        logger.info(
-            f"Overwriting '{key}' with addon from '{entrypoint.dist.project_name}'."
-        )
         addons[key] = workingcopytype
     _workingcopytypes.update(addons)
     return _workingcopytypes