vyupgrade 0.1.0__tar.gz

vyupgrade-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 banteg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vyupgrade-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.3
+Name: vyupgrade
+Version: 0.1.0
+Summary: Compiler-backed tool for upgrading Vyper contracts.
+Keywords: codemod,migration,smart-contracts,vyper
+Author: banteg
+License: MIT License
+         
+         Copyright (c) 2026 banteg
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Dist: rich>=13.0.0
+Requires-Dist: uv>=0.8.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/banteg/vyupgrade
+Project-URL: Repository, https://github.com/banteg/vyupgrade
+Project-URL: Issues, https://github.com/banteg/vyupgrade/issues
+Project-URL: Changelog, https://github.com/banteg/vyupgrade/blob/master/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# vyupgrade
+
+A compiler-backed tool for upgrading Vyper contracts across language
+versions. It rewrites legacy syntax to a chosen target compiler, then proves the
+rewrite is safe by compiling the source and the result and comparing their ABI,
+method identifiers, and storage layout.
+
+It covers the syntax changes from Vyper `0.2.1` through `0.4.3`. Rules are
+version-gated: a given rewrite only fires when the migration from the source
+version to the target version actually crosses the compiler release that
+introduced the change.
+
+## Install
+
+Run it once without installing:
+
+```bash
+uvx vyupgrade contracts/
+```
+
+Or install it as a tool:
+
+```bash
+uv tool install vyupgrade
+vyupgrade contracts/
+```
+
+## Usage
+
+Preview the changes as a unified diff:
+
+```bash
+vyupgrade contracts/ --diff
+```
+
+Apply them in place and write a machine-readable report:
+
+```bash
+vyupgrade contracts/ --write --report-json vyupgrade-report.json
+```
+
+Fail without writing when files would change, for use in CI:
+
+```bash
+vyupgrade contracts/ --check
+```
+
+The target defaults to `0.4.3`; pass `--target-version` to migrate to a
+different release.
+
+Paths may be files or directories; directories are searched recursively for
+`.vy` and `.vyi` sources. The source version is inferred per file from its
+`#pragma version` (or legacy `# @version`) line. Pass `--source-version` to
+override the inference for files that have no pragma.
+
+### How it validates
+
+For each file, `vyupgrade` compiles the original under its source compiler and
+the rewritten output under the target compiler, then compares the two
+artifacts. A migration is only written back when every file still compiles
+under the target. Differences in ABI, method identifiers, or storage layout are
+surfaced as diagnostics rather than silently accepted.
+
+Compiler subprocesses run through the bundled `uv`, using
+`uv run --no-project --with vyper==<version>` so each side gets the exact
+compiler it needs instead of inheriting an incompatible interpreter. When a file
+belongs to another project, the nearest `pyproject.toml` is read and any
+declared packages matching its Vyper imports (such as `snekmate`) are added to
+the compiler environment.
+
+Dependency inference is intentionally conservative. Exact requirements,
+ordinary version ranges, and Git dependencies are supported. Project-specific
+specifier syntaxes that cannot be translated to a compiler environment, such as
+Poetry caret requirements, are skipped; use `--compiler-search-paths`,
+`--source-vyper`, or `--target-vyper` for unusual layouts.
+
+## Options
+
+- `--target-version` — target Vyper version or spec (default `0.4.3`).
+- `--source-version` — override the per-file inferred source version.
+- `--diff` — print a unified diff instead of the report.
+- `--write` — apply changes in place (only when every file compiles).
+- `--check` — exit non-zero if any file would change; write nothing.
+- `--bump-pragma` — rewrite the pragma to the target so output compiles against the target compiler instead of preserving the original range.
+- `--aggressive` — enable rewrites that change behavior or are not provably safe (e.g. `enum` → `flag`).
+- `--select` / `--ignore` — comma-separated rule codes to include or exclude.
+- `--report-json PATH` — write a JSON report of fixes, diagnostics, and validation results.
+- `--format mamushi` — run `mamushi` over written files to reformat them.
+- `--test-command CMD` — run a test command after a successful write and record its result.
+- `--enable-decimals` — treat decimals as enabled when reasoning about `0.4.x` rules.
+- `--source-vyper` / `--target-vyper` — pin the exact compiler version for each side.
+- `--source-python` / `--target-python` — pin the Python interpreter for each compiler subprocess.
+- `--compiler-search-paths` — extra import search paths for the compiler.
+- `--config PATH` — read configuration from a specific `pyproject.toml`.
+
+### Configuration
+
+Defaults can live in `pyproject.toml` under `[tool.vyupgrade]`. Command-line
+flags take precedence.
+
+```toml
+[tool.vyupgrade]
+paths = ["contracts/"]
+target-version = "0.4.3"
+source-version = "infer"
+report-json = "vyupgrade-report.json"
+aggressive = false
+format = "none"
+```
+
+### Exit codes
+
+- `0` — success.
+- `1` — `--check` found files that would change.
+- `2` — a file failed to compile under the target compiler.
+- `3` — a file failed to compile under the source compiler.
+- `4` — usage error (no paths, or conflicting flags).
+- `5` — an error-severity diagnostic was raised.
+
+## Coverage
+
+Rewrites carry a `VY###` code and diagnostics a `VYD###` code. Where the source
+intent cannot be proven safe, the change is reported as a manual-review
+diagnostic instead of being applied.
+
+- [docs/migration-coverage.md](docs/migration-coverage.md) — every syntax change
+  mapped to a rule, diagnostic, or explicit no-op.
+- [docs/vyper-syntax-history.md](docs/vyper-syntax-history.md) — the versioned
+  Vyper syntax history from `0.4.3` back to `0.2.1`, with PR links and
+  before/after examples.
+- [CHANGELOG.md](CHANGELOG.md) — release notes.
+- [DEVELOPMENT.md](DEVELOPMENT.md) — maintainer validation and release workflow.

vyupgrade-0.1.0/README.md

@@ -0,0 +1,132 @@
+# vyupgrade
+
+A compiler-backed tool for upgrading Vyper contracts across language
+versions. It rewrites legacy syntax to a chosen target compiler, then proves the
+rewrite is safe by compiling the source and the result and comparing their ABI,
+method identifiers, and storage layout.
+
+It covers the syntax changes from Vyper `0.2.1` through `0.4.3`. Rules are
+version-gated: a given rewrite only fires when the migration from the source
+version to the target version actually crosses the compiler release that
+introduced the change.
+
+## Install
+
+Run it once without installing:
+
+```bash
+uvx vyupgrade contracts/
+```
+
+Or install it as a tool:
+
+```bash
+uv tool install vyupgrade
+vyupgrade contracts/
+```
+
+## Usage
+
+Preview the changes as a unified diff:
+
+```bash
+vyupgrade contracts/ --diff
+```
+
+Apply them in place and write a machine-readable report:
+
+```bash
+vyupgrade contracts/ --write --report-json vyupgrade-report.json
+```
+
+Fail without writing when files would change, for use in CI:
+
+```bash
+vyupgrade contracts/ --check
+```
+
+The target defaults to `0.4.3`; pass `--target-version` to migrate to a
+different release.
+
+Paths may be files or directories; directories are searched recursively for
+`.vy` and `.vyi` sources. The source version is inferred per file from its
+`#pragma version` (or legacy `# @version`) line. Pass `--source-version` to
+override the inference for files that have no pragma.
+
+### How it validates
+
+For each file, `vyupgrade` compiles the original under its source compiler and
+the rewritten output under the target compiler, then compares the two
+artifacts. A migration is only written back when every file still compiles
+under the target. Differences in ABI, method identifiers, or storage layout are
+surfaced as diagnostics rather than silently accepted.
+
+Compiler subprocesses run through the bundled `uv`, using
+`uv run --no-project --with vyper==<version>` so each side gets the exact
+compiler it needs instead of inheriting an incompatible interpreter. When a file
+belongs to another project, the nearest `pyproject.toml` is read and any
+declared packages matching its Vyper imports (such as `snekmate`) are added to
+the compiler environment.
+
+Dependency inference is intentionally conservative. Exact requirements,
+ordinary version ranges, and Git dependencies are supported. Project-specific
+specifier syntaxes that cannot be translated to a compiler environment, such as
+Poetry caret requirements, are skipped; use `--compiler-search-paths`,
+`--source-vyper`, or `--target-vyper` for unusual layouts.
+
+## Options
+
+- `--target-version` — target Vyper version or spec (default `0.4.3`).
+- `--source-version` — override the per-file inferred source version.
+- `--diff` — print a unified diff instead of the report.
+- `--write` — apply changes in place (only when every file compiles).
+- `--check` — exit non-zero if any file would change; write nothing.
+- `--bump-pragma` — rewrite the pragma to the target so output compiles against the target compiler instead of preserving the original range.
+- `--aggressive` — enable rewrites that change behavior or are not provably safe (e.g. `enum` → `flag`).
+- `--select` / `--ignore` — comma-separated rule codes to include or exclude.
+- `--report-json PATH` — write a JSON report of fixes, diagnostics, and validation results.
+- `--format mamushi` — run `mamushi` over written files to reformat them.
+- `--test-command CMD` — run a test command after a successful write and record its result.
+- `--enable-decimals` — treat decimals as enabled when reasoning about `0.4.x` rules.
+- `--source-vyper` / `--target-vyper` — pin the exact compiler version for each side.
+- `--source-python` / `--target-python` — pin the Python interpreter for each compiler subprocess.
+- `--compiler-search-paths` — extra import search paths for the compiler.
+- `--config PATH` — read configuration from a specific `pyproject.toml`.
+
+### Configuration
+
+Defaults can live in `pyproject.toml` under `[tool.vyupgrade]`. Command-line
+flags take precedence.
+
+```toml
+[tool.vyupgrade]
+paths = ["contracts/"]
+target-version = "0.4.3"
+source-version = "infer"
+report-json = "vyupgrade-report.json"
+aggressive = false
+format = "none"
+```
+
+### Exit codes
+
+- `0` — success.
+- `1` — `--check` found files that would change.
+- `2` — a file failed to compile under the target compiler.
+- `3` — a file failed to compile under the source compiler.
+- `4` — usage error (no paths, or conflicting flags).
+- `5` — an error-severity diagnostic was raised.
+
+## Coverage
+
+Rewrites carry a `VY###` code and diagnostics a `VYD###` code. Where the source
+intent cannot be proven safe, the change is reported as a manual-review
+diagnostic instead of being applied.
+
+- [docs/migration-coverage.md](docs/migration-coverage.md) — every syntax change
+  mapped to a rule, diagnostic, or explicit no-op.
+- [docs/vyper-syntax-history.md](docs/vyper-syntax-history.md) — the versioned
+  Vyper syntax history from `0.4.3` back to `0.2.1`, with PR links and
+  before/after examples.
+- [CHANGELOG.md](CHANGELOG.md) — release notes.
+- [DEVELOPMENT.md](DEVELOPMENT.md) — maintainer validation and release workflow.

vyupgrade-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["uv_build>=0.11.16,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "vyupgrade"
+version = "0.1.0"
+description = "Compiler-backed tool for upgrading Vyper contracts."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+authors = [{ name = "banteg" }]
+keywords = ["codemod", "migration", "smart-contracts", "vyper"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development :: Compilers",
+    "Topic :: Software Development :: Quality Assurance",
+]
+dependencies = ["rich>=13.0.0", "uv>=0.8.0"]
+
+[project.urls]
+Homepage = "https://github.com/banteg/vyupgrade"
+Repository = "https://github.com/banteg/vyupgrade"
+Issues = "https://github.com/banteg/vyupgrade/issues"
+Changelog = "https://github.com/banteg/vyupgrade/blob/master/CHANGELOG.md"
+
+[project.scripts]
+vyupgrade = "vyupgrade.cli:main"
+
+[dependency-groups]
+dev = [
+    "polars>=1.30",
+    "pytest>=8",
+    "ruff>=0.13.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.uv]
+exclude-newer = "2026-05-27T14:26:03.814034Z"
+
+[tool.uv.build-backend]
+source-exclude = [".DS_Store"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

vyupgrade-0.1.0/src/vyupgrade/__init__.py

@@ -0,0 +1,8 @@
+"""Vyper source upgrader."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("vyupgrade")
+except PackageNotFoundError:
+    __version__ = "0.0.0"