workers-py 1.3.0__tar.gz → 1.5.0__tar.gz

{workers_py-1.3.0 → workers_py-1.5.0}/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 <!-- version list -->
 
+## v1.5.0 (2025-10-10)
+
+### Features
+
+- Implement pywrangler types to generate Python type stubs
+  ([#38](https://github.com/cloudflare/workers-py/pull/38),
+  [`39b67bd`](https://github.com/cloudflare/workers-py/commit/39b67bd24ed3916de12aa9025703ed18fe4a73cd))
+
+
+## v1.4.0 (2025-10-10)
+
+### Features
+
+- Adds wrangler version check
+  ([`ed41bcc`](https://github.com/cloudflare/workers-py/commit/ed41bccf24d5130b2c628edc7c3ece48edf14253))
+
+
 ## v1.3.0 (2025-10-08)
 
 ### Features

{workers_py-1.3.0 → workers_py-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: workers-py
-Version: 1.3.0
+Version: 1.5.0
 Summary: A set of libraries and tools for Python Workers
 Project-URL: Homepage, https://github.com/cloudflare/workers-py
 Project-URL: Bug Tracker, https://github.com/cloudflare/workers-py/issues
@@ -11,6 +11,7 @@ Requires-Python: >=3.10
 Requires-Dist: click<9.0.0,>=8.0.0
 Requires-Dist: pyjson5>=1.6.0
 Requires-Dist: pyodide-cli
+Requires-Dist: pyodide-py
 Requires-Dist: rich>=13.0.0
 Provides-Extra: build
 Requires-Dist: uv~=0.5.23; extra == 'build'

{workers_py-1.3.0 → workers_py-1.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "workers-py"
-version = "1.3.0"
+version = "1.5.0"
 description = "A set of libraries and tools for Python Workers"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -18,6 +18,7 @@ dependencies = [
     "rich>=13.0.0",
     "pyodide-cli",
     "pyjson5>=1.6.0",
+    "pyodide-py",
 ]
 
 [dependency-groups]

{workers_py-1.3.0 → workers_py-1.5.0}/src/pywrangler/cli.py

@@ -4,13 +4,11 @@ import sys
 import textwrap
 import click
 
-from pywrangler.utils import setup_logging, write_success
+from .utils import setup_logging, write_success, WRANGLER_COMMAND
 
 setup_logging()
 logger = logging.getLogger("pywrangler")
 
-WRANGLER_COMMAND = ["npx", "--yes", "wrangler"]
-
 
 class ProxyToWranglerGroup(click.Group):
     def get_help(self, ctx):
@@ -57,6 +55,11 @@ class ProxyToWranglerGroup(click.Group):
             if cmd_name in ["dev", "publish", "deploy", "versions"]:
                 ctx.invoke(sync_command, force=False, directly_requested=False)
 
+            if cmd_name == "dev":
+                from pywrangler.sync import check_wrangler_version
+
+                check_wrangler_version()
+
             _proxy_to_wrangler(cmd_name, remaining_args)
             sys.exit(0)
 
@@ -90,6 +93,26 @@ def app(ctx, debug=False):
         logger.setLevel(logging.DEBUG)
 
 
+@app.command("types")
+@click.option(
+    "-o",
+    "--outdir",
+    type=click.Path(writable=True),
+    help="The output directory to write the generated types. Default: .venv/lib/python3.vv/site-packages/js-stubs",
+)
+@click.option(
+    "-c",
+    "--config",
+    type=click.Path(exists=True, dir_okay=False, readable=True),
+    help="Path to Wrangler configuration file",
+)
+def types_command(outdir=None, config=None):
+    from .types import wrangler_types
+
+    wrangler_types(outdir, config)
+    raise click.exceptions.Exit(code=0)
+
+
 @app.command("sync")
 @click.option("--force", is_flag=True, help="Force sync even if no changes detected")
 def sync_command(force=False, directly_requested=True):

{workers_py-1.3.0 → workers_py-1.5.0}/src/pywrangler/sync.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import re
 import shutil
 import tempfile
 from contextlib import contextmanager
@@ -229,6 +230,7 @@ def create_workers_venv():
 
 
 MIN_UV_VERSION = (0, 8, 10)
+MIN_WRANGLER_VERSION = (4, 42, 1)
 
 
 def check_uv_version():
@@ -243,6 +245,48 @@ def check_uv_version():
     raise click.exceptions.Exit(code=1)
 
 
+def check_wrangler_version():
+    """
+    Check that the installed wrangler version is at least 4.42.1.
+
+    Raises:
+        click.exceptions.Exit: If wrangler is not installed or version is too old.
+    """
+    result = run_command(
+        ["npx", "--yes", "wrangler", "--version"], capture_output=True, check=False
+    )
+    if result.returncode != 0:
+        logger.error("Failed to get wrangler version. Is wrangler installed?")
+        logger.error("Install wrangler with: npm install wrangler@latest")
+        raise click.exceptions.Exit(code=1)
+
+    # Parse version from output like "wrangler 4.42.1" or " ⛅️ wrangler 4.42.1"
+    version_line = result.stdout.strip()
+    # Extract version number using regex
+    version_match = re.search(r"wrangler\s+(\d+)\.(\d+)\.(\d+)", version_line)
+
+    if not version_match:
+        logger.error(f"Could not parse wrangler version from: {version_line}")
+        logger.error("Install wrangler with: npm install wrangler@latest")
+        raise click.exceptions.Exit(code=1)
+
+    major, minor, patch = map(int, version_match.groups())
+    current_version = (major, minor, patch)
+
+    if current_version < MIN_WRANGLER_VERSION:
+        min_version_str = ".".join(str(x) for x in MIN_WRANGLER_VERSION)
+        current_version_str = ".".join(str(x) for x in current_version)
+        logger.error(
+            f"wrangler version at least {min_version_str} required, have {current_version_str}."
+        )
+        logger.error("Update wrangler with: npm install wrangler@latest")
+        raise click.exceptions.Exit(code=1)
+
+    logger.debug(
+        f"wrangler version {'.'.join(str(x) for x in current_version)} is sufficient"
+    )
+
+
 def create_pyodide_venv():
     if PYODIDE_VENV_PATH.is_dir():
         logger.debug(
@@ -333,10 +377,9 @@ def _install_requirements_to_vendor(requirements: list[str]):
 
 
 def _install_requirements_to_venv(requirements: list[str]):
-    # Create a requirements file for .venv-workers that includes webtypy and pyodide-py
+    # Create a requirements file for .venv-workers that includes pyodide-py
     relative_venv_workers_path = VENV_WORKERS_PATH.relative_to(PROJECT_ROOT)
     requirements = requirements.copy()
-    requirements.append("webtypy")
     requirements.append("pyodide-py")
 
     logger.info(

workers_py-1.5.0/src/pywrangler/types.py

@@ -0,0 +1,45 @@
+from .utils import WRANGLER_COMMAND, run_command
+from tempfile import TemporaryDirectory
+from pathlib import Path
+import logging
+
+logger = logging.getLogger(__name__)
+
+TSCONFIG = """
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "nodenext",
+    "lib": ["esnext"]
+  },
+  "include": ["worker-configuration.d.ts"]
+}
+"""
+
+PACKAGE_JSON = """
+{
+  "dependencies": {
+    "typescript": "^5.3.2"
+  }
+}
+"""
+
+
+def wrangler_types(outdir_arg: str | None, config: str | None, /):
+    args = ["types"]
+    if config:
+        args += ["--config", config]
+    if outdir_arg is None:
+        outdir = Path("src")
+    else:
+        outdir = Path(outdir_arg)
+    stubs_dir = outdir / "js-stubs"
+    stubs_dir.mkdir(parents=True, exist_ok=True)
+    with TemporaryDirectory() as tmp_str:
+        tmp = Path(tmp_str)
+        run_command(WRANGLER_COMMAND + args + [tmp / "worker-configuration.d.ts"])
+        (tmp / "tsconfig.json").write_text(TSCONFIG)
+        (tmp / "package.json").write_text(PACKAGE_JSON)
+        run_command(["npm", "-C", tmp, "install"])
+        run_command(["npx", "@pyodide/ts-to-python", tmp, stubs_dir / "__init__.pyi"])

{workers_py-1.3.0 → workers_py-1.5.0}/src/pywrangler/utils.py

@@ -6,6 +6,8 @@ import click
 from rich.logging import Console, RichHandler
 from rich.theme import Theme
 
+WRANGLER_COMMAND = ["npx", "--yes", "wrangler"]
+
 logger = logging.getLogger(__name__)
 
 SUCCESS_LEVEL = 100

{workers_py-1.3.0 → workers_py-1.5.0}/tests/test_cli.py

@@ -3,7 +3,7 @@ import os
 import shutil
 import subprocess
 from pathlib import Path
-from unittest.mock import patch
+from unittest.mock import patch, Mock
 from textwrap import dedent
 
 import pytest
@@ -213,10 +213,7 @@ def test_sync_command_integration(dependencies, clean_test_dir):
         "site-packages directory does not exist in .venv-workers"
     )
 
-    # Check that webtypy and pyodide-py are installed (should always be installed, even if no deps are specified)
-    assert is_package_installed(site_packages_path, "webtypy"), (
-        "webtypy package was not installed in .venv-workers"
-    )
+    # Check that pyodide-py is installed (should always be installed, even if no deps are specified)
     assert is_package_installed(site_packages_path, "pyodide-py"), (
         "pyodide-py package was not installed in .venv-workers"
     )
@@ -406,10 +403,13 @@ def test_proxy_to_wrangler_unknown_command(mock_proxy_to_wrangler):
     )
 
 
+@patch("pywrangler.sync.check_wrangler_version")
 @patch("pywrangler.cli._proxy_to_wrangler")
 @patch("pywrangler.cli.sync_command")
 @patch("sys.argv", ["pywrangler", "dev", "--local"])
-def test_proxy_auto_sync_commands(mock_sync_command, mock_proxy_to_wrangler):
+def test_proxy_auto_sync_commands(
+    mock_sync_command, mock_proxy_to_wrangler, mock_check_wrangler_version
+):
     """Test that dev, publish, and deploy commands automatically run sync first."""
     runner = CliRunner()
 
@@ -530,3 +530,42 @@ def test_sync_recreates_venv_on_python_version_mismatch(clean_test_dir):
     assert "3.13" in version_result.stdout, (
         f"Python version is not 3.13: {version_result.stdout}"
     )
+
+
+# Wrangler version check tests
+@patch("pywrangler.sync.run_command")
+def test_check_wrangler_version_sufficient(mock_run_command):
+    """Test that check_wrangler_version passes with sufficient version."""
+    from pywrangler.sync import check_wrangler_version
+
+    # Mock successful wrangler version output
+    mock_result = Mock()
+    mock_result.returncode = 0
+    mock_result.stdout = "wrangler 4.42.1"
+    mock_run_command.return_value = mock_result
+
+    # Should not raise an exception
+    check_wrangler_version()
+
+    # Verify the command was called correctly
+    mock_run_command.assert_called_once_with(
+        ["npx", "--yes", "wrangler", "--version"], capture_output=True, check=False
+    )
+
+
+@patch("pywrangler.sync.run_command")
+def test_check_wrangler_version_insufficient(mock_run_command):
+    """Test that check_wrangler_version fails with insufficient version."""
+    from pywrangler.sync import check_wrangler_version
+
+    # Mock wrangler version output with old version
+    mock_result = Mock()
+    mock_result.returncode = 0
+    mock_result.stdout = "⛅️ wrangler 4.40.0"
+    mock_run_command.return_value = mock_result
+
+    # Should raise SystemExit
+    import click
+
+    with pytest.raises(click.exceptions.Exit):
+        check_wrangler_version()

workers_py-1.5.0/tests/test_types.py

@@ -0,0 +1,61 @@
+from contextlib import chdir
+from subprocess import run
+
+
+# Import the full module so we can patch constants
+from pywrangler.types import wrangler_types
+
+
+WRANGLER_TOML = """
+compatibility_date = "2025-08-14"
+
+kv_namespaces = [
+    { binding = "FOO", id = "<YOUR_KV_NAMESPACE_ID>" }
+]
+"""
+
+PYPROJECT_TOML = """
+[dependency-groups]
+dev = [
+    "mypy>=1.17.1",
+    "pyodide-py",
+]
+
+[tool.mypy]
+files = [
+    "src",
+]
+"""
+
+WORKER = """
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from js import Env
+
+class Default:
+    env: "Env"
+    async def fetch(self) -> None:
+        reveal_type(self.env.FOO) # Revealed type is "js.KVNamespace_iface"
+        bar = await self.env.FOO.get("bar")
+        reveal_type(bar) # Revealed type is "builtins.str | None"
+"""
+
+
+def test_types(tmp_path):
+    config_path = tmp_path / "wrangler.toml"
+    pyproject_path = tmp_path / "pyproject.toml"
+    worker_dir = tmp_path / "src/worker"
+    worker_path = worker_dir / "entry.py"
+
+    worker_dir.mkdir(parents=True)
+    worker_path.write_text(WORKER)
+    config_path.write_text(WRANGLER_TOML)
+    pyproject_path.write_text(PYPROJECT_TOML)
+
+    with chdir(tmp_path):
+        wrangler_types(None, None)
+        result = run(["uv", "run", "mypy"], capture_output=True, text=True)
+
+        assert 'Revealed type is "js.KVNamespace_iface"' in result.stdout
+        assert 'Revealed type is "builtins.str | None"' in result.stdout
+        assert "Success: no issues found" in result.stdout

{workers_py-1.3.0 → workers_py-1.5.0}/uv.lock

@@ -1,7 +1,8 @@
 version = 1
 requires-python = ">=3.10"
 resolution-markers = [
-    "python_full_version >= '3.12'",
+    "python_full_version >= '3.13'",
+    "python_full_version == '3.12.*'",
     "python_full_version < '3.12'",
 ]
 
@@ -54,7 +55,8 @@ name = "click"
 version = "8.1.8"
 source = { registry = "https://pypi.org/simple" }
 resolution-markers = [
-    "python_full_version >= '3.12'",
+    "python_full_version >= '3.13'",
+    "python_full_version == '3.12.*'",
 ]
 dependencies = [
     { name = "colorama", marker = "python_full_version >= '3.12' and sys_platform == 'win32'" },
@@ -424,7 +426,8 @@ name = "pyodide-cli"
 version = "0.3.0"
 source = { registry = "https://pypi.org/simple" }
 resolution-markers = [
-    "python_full_version >= '3.12'",
+    "python_full_version >= '3.13'",
+    "python_full_version == '3.12.*'",
 ]
 dependencies = [
     { name = "rich", marker = "python_full_version >= '3.12'" },
@@ -435,6 +438,42 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/b4/93/b9815f6f4ef30dd8490bea2a82aa664e5aa9162fa38986b35a0898522d22/pyodide_cli-0.3.0-py3-none-any.whl", hash = "sha256:9d2736e04ddb380fd7eac664e5e4ba23d2c1dd29ed38a98b6246ec529ffc834a", size = 11630 },
 ]
 
+[[package]]
+name = "pyodide-py"
+version = "0.25.1"
+source = { registry = "https://pypi.org/simple" }
+resolution-markers = [
+    "python_full_version < '3.12'",
+]
+sdist = { url = "https://files.pythonhosted.org/packages/06/b5/bd547175f2f91ff9afb79d5fcd8604c8b59295ae2161985a782194f220e6/pyodide-py-0.25.1.tar.gz", hash = "sha256:844fc310585118efbc1daeb4390bb7aecdf1d9fb508c4aa9f21588842c1c8a4e", size = 43322 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/1c/e6/f16847dae08ce4e1d544c66336561c38b883613e1bb6fa61491bae7a1b5c/pyodide_py-0.25.1-py3-none-any.whl", hash = "sha256:bfd93301ee0ee022e6cbcee5a3a9a28b34a2f7348ebb06186df1514be79e5499", size = 48290 },
+]
+
+[[package]]
+name = "pyodide-py"
+version = "0.27.7"
+source = { registry = "https://pypi.org/simple" }
+resolution-markers = [
+    "python_full_version == '3.12.*'",
+]
+sdist = { url = "https://files.pythonhosted.org/packages/9d/99/d7b3c9137de5a76a63f2ef89d43c878dcb4dce8118866fb58d26290698f9/pyodide_py-0.27.7.tar.gz", hash = "sha256:afb68f8abf503f691a4ab5d2ffdbf6dd05117920508e1161e04a34737c649d36", size = 52051 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/24/c5/825f73fb815a17838bef3342999247bea1100a0b2e576e5c17b2bdd68766/pyodide_py-0.27.7-py3-none-any.whl", hash = "sha256:2fa7db63a14720e548eb6174d492643424f8b5f21d43b7c9fecb6d712187fe6a", size = 57930 },
+]
+
+[[package]]
+name = "pyodide-py"
+version = "0.28.3"
+source = { registry = "https://pypi.org/simple" }
+resolution-markers = [
+    "python_full_version >= '3.13'",
+]
+sdist = { url = "https://files.pythonhosted.org/packages/2d/59/95d573e0d967af70d8823552c1efee19eb2dfbca23de9ca139516c98c5d1/pyodide_py-0.28.3.tar.gz", hash = "sha256:e521d9714eb57b163e0aadca40b85870a8ea949cb03443c0e5f3ed7d45cd3a98", size = 52898 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/4a/2a/2cca0a4e52a9495f21cab634b58dc413fddf72faf5baed9d2c8741544631/pyodide_py-0.28.3-py3-none-any.whl", hash = "sha256:de6ba9db35ed1ef75b80a70cf11dafa373ad786f95f72e9dbe46ffaf8cdea23c", size = 58853 },
+]
+
 [[package]]
 name = "pytest"
 version = "8.3.5"
@@ -650,7 +689,7 @@ wheels = [
 
 [[package]]
 name = "workers-py"
-version = "1.3.0"
+version = "1.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
@@ -658,6 +697,9 @@ dependencies = [
     { name = "pyjson5" },
     { name = "pyodide-cli", version = "0.2.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
     { name = "pyodide-cli", version = "0.3.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
+    { name = "pyodide-py", version = "0.25.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "pyodide-py", version = "0.27.7", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version == '3.12.*'" },
+    { name = "pyodide-py", version = "0.28.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.13'" },
     { name = "rich" },
 ]
 
@@ -682,6 +724,7 @@ requires-dist = [
     { name = "click", specifier = ">=8.0.0,<9.0.0" },
     { name = "pyjson5", specifier = ">=1.6.0" },
     { name = "pyodide-cli" },
+    { name = "pyodide-py" },
     { name = "rich", specifier = ">=13.0.0" },
     { name = "uv", marker = "extra == 'build'", specifier = "~=0.5.23" },
 ]