Skip to main content

Identify unwanted function calls in your code

Project description

Pyaphid

PyPI version GitHub license GitHub issues PyPI - Downloads Tests Codecov

Description

Pyaphid is a static analysis tool for detecting unwanted function calls in Python code.

Installation and usage

Installation: pip install pyaphid

Usage: python -m pyaphid <files and/or directories to analyze> or pyaphid <files and/or directories to analyze>

Configuration

Forbidden function calls can be configured via the pyproject.toml:

[tool.pyaphid]
forbidden = [
    "print", # forbid print(...)
    "pdb.run", # forbid pdb.run(...)
    "werkzeug.debug.*" # forbid werkzeug.debug.DebuggedApplication(...), werkzeug.debug.get_machine_id(...), ...
]

CLI Options

  • -n / --names: Look-up all func calls and print their identifier

As a pre-commit hook

- repo: https://github.com/jvllmr/pyaphid
  rev: v0.1.4
  hooks:
    - id: pyaphid

Limitations

# Pyaphid cannot work with star imports
from os.path import *
dirname(".") # undetected

# Pyaphid ignores relative imports
from . import something
something() # undetected

# Pyaphid doesn't track assignments
my_print = print
my_print("Hello world") # undetected

Project details


Download files

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

Source Distribution

pyaphid-0.1.4.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

pyaphid-0.1.4-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file pyaphid-0.1.4.tar.gz.

File metadata

  • Download URL: pyaphid-0.1.4.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for pyaphid-0.1.4.tar.gz
Algorithm Hash digest
SHA256 4f0e4c6e81f2b0d76fc9c97bba93948216b19389789833c4a53dde6943935afe
MD5 8a5ef0e8929bd090a4aa8814a23e1957
BLAKE2b-256 7ccbd44c25b5a56b60a42697aa50b9baa0ac9460b4a364e463b022d16b2fb876

See more details on using hashes here.

File details

Details for the file pyaphid-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: pyaphid-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for pyaphid-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 028be1162f6fb3106bc8d06b0d217801fd0a6265e4b70add93b15a8e724097b1
MD5 d1f36d12a67f9c73e7ec9ce3cc5c352d
BLAKE2b-256 57f0ee2a45206474d31ed8964256ebe8daaa72095912661f6d3ec3eeece97f09

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page