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.4.0.tar.gz (602.2 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.4.0-py3-none-any.whl (529.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyvbaanalysis-1.4.0.tar.gz
Algorithm Hash digest
SHA256 8a31e73bc0819fc4ba3406040a2c2c02a4faa1e69474fc4608037baecd2b0908
MD5 2d0bcbd9622ae3b5687108be1a6292c5
BLAKE2b-256 973c9378240cca2da8f3b5bec00fcf13b252b4e6ee9633fc66bd0652691c61bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvbaanalysis-1.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyvbaanalysis-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 529.6 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c5d052276525efb5dbe03a7bd884dd63c62432bd59f140f516cf7a1963a84c0
MD5 c3adc98f175e08af292464adc58cd2f4
BLAKE2b-256 97a0ce7d8b632c57534923eb84b3a750a38bb06088378d813cf735e7209663e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvbaanalysis-1.4.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