Merge pull request #32 from waketzheng/main

chore: upgrade deps, improve type hints and add make file for development

Author: frostming

.gitignore

@@ -2,6 +2,7 @@
 *.py[cod]
 __pycache__/
 venv/
+.venv/
 .tox/
 .vscode/
 /build/

.pre-commit-config.yaml

@@ -14,13 +14,13 @@ exclude: >
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.276'
+    rev: 'v0.9.7'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --show-fixes]
 
   - repo: https://github.com/ambv/black
-    rev: 23.3.0
+    rev: 24.8.0
     hooks:
       - id: black
 

Makefile

@@ -0,0 +1,55 @@
+checkfiles = src/ tests/
+
+help:
+	@echo  "FindPython development makefile"
+	@echo
+	@echo  "Usage: make <target>"
+	@echo  "Targets:"
+	@echo  "    up      Updates dev/test dependencies"
+	@echo  "    deps    Ensure dev/test dependencies are installed"
+	@echo  "    check   Checks that build is sane"
+	@echo  "    test    Runs all tests"
+	@echo  "    style   Auto-formats the code"
+	@echo  "    lint    Auto-formats the code and check type hints"
+
+up:
+	pdm update --verbose
+
+deps:
+ifeq ($(wildcard .venv),)
+	pdm install --verbose
+else
+	pdm install
+endif
+
+_check:
+	pdm run ruff format --check $(checkfiles)
+	pdm run ruff check $(checkfiles)
+	pdm run mypy $(checkfiles)
+check: deps _build _check
+
+_style:
+	pdm run ruff format $(checkfiles)
+	pdm run ruff check --fix $(checkfiles)
+style: deps _style
+
+_lint:
+	pdm run ruff format $(checkfiles)
+	pdm run ruff check --fix $(checkfiles)
+	pdm run mypy $(checkfiles)
+lint: deps _build _lint
+
+_test:
+	pdm run pytest -s tests
+test: deps _test
+
+_build:
+	rm -fR dist/
+	pdm build
+build: deps _build
+
+# Usage::
+#   make venv version=3.12
+venv:
+	pdm venv create $(version)
+	pdm run pip install --upgrade pip

pdm.lock

@@ -19,6 +19,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 
 [project.urls]
@@ -61,6 +62,11 @@ exclude = '''
 
 [tool.ruff]
 line-length = 90
+src = ["src"]
+exclude = ["tests/fixtures"]
+target-version = "py38"
+
+[tool.ruff.lint]
 select = [
   "B",    # flake8-bugbear
   "C4",   # flake8-comprehensions
@@ -72,14 +78,13 @@ select = [
   "YTT",  # flake8-2020
 ]
 extend-ignore = ["B018", "B019"]
-src = ["src"]
-exclude = ["tests/fixtures"]
-target-version = "py37"
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 10
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["findpython"]
 
-
+[[tool.mypy.overrides]]
+module = "_winreg"
+ignore_missing_imports = true

pyproject.toml

@@ -1,8 +1,9 @@
 """
-    FindPython
-    ~~~~~~~~~~
-    A utility to find python versions on your system
+FindPython
+~~~~~~~~~~
+A utility to find python versions on your system
 """
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, TypeVar
@@ -59,4 +60,4 @@ def register_provider(provider: P) -> P:
     return provider
 
 
-__all__ = ["Finder", "find", "find_all", "PythonVersion", "register_provider"]
+__all__ = ["Finder", "PythonVersion", "find", "find_all", "register_provider"]

src/findpython/__init__.py

@@ -10,4 +10,4 @@
 
 from findpython.pep514tools.environment import find, findall, findone
 
-__all__ = ["findall", "find", "findone"]
+__all__ = ["find", "findall", "findone"]

src/findpython/pep514tools/__init__.py

@@ -1,3 +1,4 @@
+# mypy: disable-error-code="attr-defined"
 # -------------------------------------------------------------------------
 # Copyright (c) Steve Dower
 # All rights reserved.
@@ -6,10 +7,10 @@
 # -------------------------------------------------------------------------
 
 __all__ = [
-    "open_source",
+    "REGISTRY_SOURCE_CU",
     "REGISTRY_SOURCE_LM",
     "REGISTRY_SOURCE_LM_WOW6432",
-    "REGISTRY_SOURCE_CU",
+    "open_source",
 ]
 
 import re
@@ -18,7 +19,7 @@
 try:
     import winreg
 except ImportError:
-    import _winreg as winreg
+    import _winreg as winreg  # type:ignore[no-redef]
 
 REGISTRY_SOURCE_LM = 1
 REGISTRY_SOURCE_LM_WOW6432 = 2

src/findpython/pep514tools/_registry.py

@@ -5,7 +5,7 @@
 # Distributed under the terms of the MIT License
 # -------------------------------------------------------------------------
 
-__all__ = ["Environment", "findall", "find", "findone"]
+__all__ = ["Environment", "find", "findall", "findone"]
 
 import sys
 

src/findpython/pep514tools/environment.py

@@ -1,6 +1,7 @@
 """
 This package contains all the providers for the pythonfinder module.
 """
+
 from __future__ import annotations
 
 from findpython.providers.asdf import AsdfProvider