python-type-hints-checker

Crates.iopython-type-hints-checker
lib.rspython-type-hints-checker
version0.3.1
sourcesrc
created_at2023-09-04 00:13:29.978452
updated_at2023-09-04 05:23:06.906799
descriptionChecks Python files for missing type hints in function parameters and return values.
homepage
repositoryhttps://github.com/AloizioMacedo/python-type-hints-checker
max_upload_size
id962525
size26,601
Aloizio Macedo (AloizioMacedo)

documentation

README

Introduction

This is a simple app to detect missing type hints in function definitions for Python file(s).

It was primarily done for education purposes to learn more about tree-sitter.

Usage

To run it, you can cargo install the package and then run the following command:

pythcheck {FILE_PATH}

This will check for missing type hints on functions of the given file.

If you pass a directory, it will check for all Python files in that directory recursively. For more information, run pythcheck -h.

$ pythcheck -h
Checks Python files for missing type hints in function parameters and return values.

Usage: pythcheck [OPTIONS] <PATH>

Arguments:
  <PATH>  File or directory to check

Options:
      --ignore-hidden  Ignores hidden subdirectories and files
      --ignore-tests   Ignores tests subdirectories and files
      --ignore-return  Ignores absence of return type hints
  -h, --help           Print help
  -V, --version        Print version
Commit count: 29

cargo fmt