Skip to main content

'Simple projects are all alike; each complexproject is complex in its own way.' - (adapted from Tolstoy's Anna Karenina)

Project description

What is PyASTrX?

Philosophy

“Simple projects are all alike; each complex project is complex in its own way.”

(adapted from Tolstoy’s Anna Karenina)

The PyASTrX philosophy is to provide a simple, easy-to-use, and extensible framework for code quality analysis, refactoring and codebase analysis.

The main point that I’ve developed is that sometimes a necessary practice in one project can be a bad practice in another project. In other words, we should walk a **mile in **someone’s shoes** before judging the code quality of someone else code.

PyASTrX allows you to define new code analysis patterns using just XPATH expressions. No need to write a parser, create a python file and ship to use in flake8 or pylint!

pip install pyastrx

Features

PyASTrX provides the following features:

An easy customizable code quality analysis tool.

Type pyastrx -h to see all the options.

You can also use a pyastrx.yaml file to configure the tool.

Human-friendly

Search and Linter outputs

If your codebase or pull request is huge, looking for possible mistakes, bad practices or code smells can be a pain, so PyASTrX provides a human-friendly output as default.

Human-friendly outputs

Friendly interface

  • autocomplete the previous queries

  • combo box to select the files

  • colorized syntax highlighting

Human friendly outputs

pre-commit

Copy the main.py available at pyastrx/.pre-commit-hook in your folder and add the following entry in your .pre-commit-config.yaml.

- repo: local
    hooks:
    - id: pyastrx
        name: PyASTrX linter
        entry: ./<LOCATION>/main.py
        language: script
        args: ["-q"]
        types: ["python"]
        description: Check for any violations using the pyastrx.yaml config
    - id: pyastrx-yaml
        name: PyASTrX linter
        entry: ./<LOCATION>/main.py
        language: script
        args: ["-q"]
        types: ["yaml"]
        description: Check for any violations using the pyastrx.yaml config

Later on, I will ship this to be used in the pre-commit channels.

VsCode extension

Soon, I will ship a VS Code extension.

Explore the AST and XML

Using the :code: -i arg or adding a :code: interactive: true in your pyastrx.yaml you can explore the AST and XML parsed AST of your code. This can be useful to understand your code base and helps you to write you custom XPATH queries to be used in your project.

Folder exploration

Start the interactive interface

$ pyastrx -i -d path_to_folder (or just save that in yaml)

Press f and choose a file

Interactive interface

Choose the ast (t), xml (x) or code exploration (o)

Interactive interface

Learn!

Interactive interface Interactive interface

File exploration (one key-press distance)

Open the interactive with the python file

$ pyastrx -i -f path_to_file (or just save that in yaml)

Choose the ast (t), xml (x) or code exploration (o)

On the shoulders of giants

This project is possible only because of the work of several developers across the following projects:

lxml

One of the greatest Python libraries, downloaded over millions of time. Please, consider doing a donation to the lxml developers.

astpath

The PyASTrX started with the idea of using the astpath as a dependency, but I’ve decided to rewrite and redesign it to improve the maintainability and the usability features of PyASTrX. astpath is a great and simple tool developed by H. Chase Stevens.

GAST

GAST it’s a remarkable tool developed by Serge Sans Paille. GAST allows you to use the same XPATH expressions to analyze different code bases written in different python versions.

prompt_toolkit

A project created by Jonathan Slenders that

provides a powerful and reliable way to construct command-line interfaces.

This project has a lot of features, good documentation and the maintainers keep it well updated.

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

pyastrx-0.6.1.tar.gz (35.2 kB view details)

Uploaded Source

Built Distribution

pyastrx-0.6.1-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file pyastrx-0.6.1.tar.gz.

File metadata

  • Download URL: pyastrx-0.6.1.tar.gz
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pyastrx-0.6.1.tar.gz
Algorithm Hash digest
SHA256 56aab0117fc93e1ea3388a94ec53c645ffedf8dee80822ca0ab8484656b58a20
MD5 142079dbf22a8f046f3ee9d75448aa97
BLAKE2b-256 017b36f6be622d4f1bc8de59873cfb10729ebb10e0a04afcb28cb9e9e12ea548

See more details on using hashes here.

File details

Details for the file pyastrx-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: pyastrx-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pyastrx-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 902e3361495348022a53dc47b54bf3a28526f30900990edf917de8121a7e6c5f
MD5 92fa158f88ace4fb3a7f8ec5590e6eb2
BLAKE2b-256 6f1680e00e7e71362451efc6e3e9246b18dc44deec244cbc3ad7d32603f1b2b7

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