Merge pull request #78 from crytic/use-uv-ruff

Modernize development workflow

Author: elopez

.github/workflows/main.yml

@@ -2,45 +2,53 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-slim
     if: github.event_name == 'pull_request'
     steps:
-    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
-      with:
-        persist-credentials: false
-    - name: Set up Python 3.10
-      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
-      with:
-        python-version: "3.10"
-    - name: Lint
-      run: |
-        pip install black
-        pip install mypy
-        pip install -e .
-        black --version
-        black --check pyevmasm
-        mypy --version
-        mypy pyevmasm
-
-  test310:
-    runs-on: ubuntu-latest
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/ruff-action@57714a7c8a2e59f32539362ba31877a1957dded1  # v3.5.1
+        with:
+          args: check
+      - uses: astral-sh/ruff-action@57714a7c8a2e59f32539362ba31877a1957dded1  # v3.5.1
+        with:
+          args: format --check
+      - uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b  # v7.2.0
+        with:
+          activate-environment: true
+      - name: Install lint dependencies
+        run: uv sync --group lint
+      - name: Type check
+        run: mypy pyevmasm
 
+  test:
+    runs-on: ubuntu-slim
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.14"]
     steps:
-    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
-      with:
-        persist-credentials: false
-
-    - name: Set up Python 3.10
-      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
-      with:
-        python-version: "3.10"
-    - name: Run Tests 3.10
-      run: |
-        pip install -e .
-        python -m unittest discover "tests/"
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b  # v7.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          activate-environment: true
+      - name: Install dependencies
+        run: uv sync --group test
+      - name: Run tests
+        run: pytest

.github/workflows/pip-audit.yml

@@ -2,36 +2,38 @@ name: Scan dependencies for vulnerabilities with pip-audit
 
 on:
   push:
-    branches: [ "master" ]
+    branches: ["master"]
   pull_request:
-    branches: [ "master" ]
+    branches: ["master"]
   schedule:
     - cron: "0 12 * * *"
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
 jobs:
   pip-audit:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-slim
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6
         with:
           persist-credentials: false
 
-      - name: Install Python
-        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b  # v7
         with:
-          python-version: "3.x"
-
-      - name: Install project
-        run: |
-          python -m venv /tmp/pip-audit-env
-          source /tmp/pip-audit-env/bin/activate
+          python-version: "3.10"
 
-          python -m pip install --upgrade pip
-          python -m pip install .
+      - name: Export dependencies
+        run: uv export --format requirements-txt --no-emit-project > requirements.txt
 
       - name: Run pip-audit
         uses: pypa/gh-action-pip-audit@1220774d901786e6f652ae159f7b6bc8fea6d266  # v1.1.0
         with:
-          virtual-environment: /tmp/pip-audit-env
+          inputs: requirements.txt

README.md

@@ -84,15 +84,15 @@ pip install pyevmasm
 
 Or, install the library from source:
 ```sh
-git clone https://github.com/trailofbits/pyevmasm
+git clone https://github.com/crytic/pyevmasm
 cd pyevmasm
-python setup.py install --user
+pip install .
 ```
 
-to run the tests
-
+For development (requires [uv](https://docs.astral.sh/uv/)):
 ```sh
-python -m unittest tests\test_EVMAssembler.py -v
+uv sync --group dev
+uv run pytest
 ```
 
 ## Documentation

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -19,14 +18,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyevmasm'
-copyright = '2018, Trail of Bits'
-author = 'Trail of Bits'
+project = "pyevmasm"
+copyright = "2018, Trail of Bits"
+author = "Trail of Bits"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -38,21 +37,19 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc'
-]
+extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -64,18 +61,18 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -86,7 +83,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -102,7 +99,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pyevmasmdoc'
+htmlhelp_basename = "pyevmasmdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -111,15 +108,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -129,19 +123,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pyevmasm.tex', 'pyevmasm Documentation',
-     'Trail of Bits', 'manual'),
+    (master_doc, "pyevmasm.tex", "pyevmasm Documentation", "Trail of Bits", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pyevmasm', 'pyevmasm Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pyevmasm", "pyevmasm Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -150,7 +140,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pyevmasm', 'pyevmasm Documentation',
-     author, 'pyevmasm', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "pyevmasm",
+        "pyevmasm Documentation",
+        author,
+        "pyevmasm",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

pyevmasm/__init__.py

@@ -1,7 +1,17 @@
-from .evmasm import instruction_tables, Instruction  # noqa: F401
-from .evmasm import block_to_fork, DEFAULT_FORK
-from .evmasm import assemble, assemble_all, assemble_hex, assemble_one
-from .evmasm import disassemble, disassemble_all, disassemble_hex, disassemble_one
+from .evmasm import (  # noqa: F401
+    DEFAULT_FORK,
+    Instruction,
+    assemble,
+    assemble_all,
+    assemble_hex,
+    assemble_one,
+    block_to_fork,
+    disassemble,
+    disassemble_all,
+    disassemble_hex,
+    disassemble_one,
+    instruction_tables,
+)
 
 __all__ = [
     "instruction_tables",

pyevmasm/__main__.py

@@ -1,23 +1,21 @@
 #!/usr/bin/env python
 import argparse
-import sys
 import binascii
+import sys
 
 from .evmasm import (
+    DEFAULT_FORK,
+    accepted_forks,
+    assemble_all,
     assemble_hex,
+    block_to_fork,
     disassemble_all,
     instruction_tables,
-    assemble_all,
-    block_to_fork,
-    DEFAULT_FORK,
-    accepted_forks,
 )
 
 
 def main():
-    parser = argparse.ArgumentParser(
-        description="pyevmasm the EVM assembler and disassembler"
-    )
+    parser = argparse.ArgumentParser(description="pyevmasm the EVM assembler and disassembler")
     group_action = parser.add_mutually_exclusive_group(required=True)
     group_action.add_argument(
         "-a",