Skip to main content

pyVBAanalysis

Static analysis for Excel VBA. It reads your macros and reports likely bugs and the errors the VBA compiler would catch, without opening Excel or running any code.

Point it at a workbook or a set of exported module files, and it returns the problems it finds, each with the exact line and a plain explanation.

What it checks

It looks for more than a hundred kinds of problem, including:

  • Type errors, such as assigning a string to a Long or passing the wrong type to a procedure.
  • Undeclared variables and calls to procedures or members that do not exist.
  • Code the VBA compiler rejects: duplicate declarations, malformed statements, or a Declare that lacks PtrSafe on 64-bit Office.
  • Likely run-time failures, such as dividing by a constant zero or a type mismatch from a bad conversion.

It only reports a problem when it can prove one, and stays quiet otherwise, so the output does not bury you in false alarms.

Install

pip install pyvbaanalysis

Python 3.10 or later. Nothing else to set up.

Use it from Python

Analyze a workbook:

from pyvbaanalysis import analyze_workbook

for module, problems in analyze_workbook("Budget.xlsm").items():
    for p in problems:
        print(module, p.severity.value, p.code, p.message)

Analyze a single module's source:

from pyvbaanalysis import analyze_module

source = "Sub Test()\n    Dim n As Long\n    n = \"oops\"\nEnd Sub\n"
for p in analyze_module(source):
    print(p.code, p.message)

Each result has a code, a message, a severity (error, warning, or information), and a span giving the character offsets in the source.

Analyze several exported files together, so references between them resolve:

from pyvbaanalysis import analyze_loose_files

analyze_loose_files(["Module1.bas", "Sheet1.cls", "UserForm1.frm"])

Use it from the command line

pyvbaanalysis Budget.xlsm
pyvbaanalysis ./exported_modules --format json
pyvbaanalysis Budget.xlsm --only Sheet1

A path can be a workbook, a folder of exported .bas / .cls / .frm files, or a single file. The command exits 1 when it finds problems and 0 when the code is clean, so it drops into a CI check.

Scope

This analyzes Excel VBA. It does not run macros and does not need Excel installed. Word and PowerPoint are not supported.

Documentation

License

MIT. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvbaanalysis-1.3.0.tar.gz (591.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyvbaanalysis-1.3.0-py3-none-any.whl (524.1 kB view details)

Uploaded Python 3

File details

Details for the file pyvbaanalysis-1.3.0.tar.gz.

File metadata

  • Download URL: pyvbaanalysis-1.3.0.tar.gz
  • Upload date:
  • Size: 591.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyvbaanalysis-1.3.0.tar.gz
Algorithm Hash digest
SHA256 694dafc7e0742c769abed4388eef97313ed6ca649b511d3144d6c49ab95ac8a4
MD5 bd2b7d9626724f127932a03c419d394e
BLAKE2b-256 aee9930671c3afc8c190154f58a9bd5325afd693297e09050b387bac36c251db

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvbaanalysis-1.3.0.tar.gz:

Publisher: publish.yml on WilliamSmithEdward/pyVBAanalysis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyvbaanalysis-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: pyvbaanalysis-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 524.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyvbaanalysis-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 beb748d210f7fd2ccb477c99ea542996309ff68c067fc2cbeaa8c6c8d808de92
MD5 6eac324a90c2be28e39dbe8f2847afe6
BLAKE2b-256 d3cc3bc07d24f1e8e966fe6e213bac60ab41ae478b2d3795abef52f46c5b4556

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvbaanalysis-1.3.0-py3-none-any.whl:

Publisher: publish.yml on WilliamSmithEdward/pyVBAanalysis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page