Git Product home page Git Product logo

checka's Introduction

Annotation Checker

mypy now provides type checking in python using annotations on types, and there are several packages now that enforce the types are correct at runtime. However this only works if types are applied throughout the project.

This project aims to check your project and notify you when you forget to add an annotation.

If type annotations are successfully provided throughout the project then mypy and other analysis tools can become very powerful additions to your project.

Install

git clone https://github.com/takac/checka
cd checka
pip install -e .

Usage

checka mymodule/mydir

Output:

madeup/path.py:1 Missing annotation from function: "mocked.fn_def_args" for argument "y"
madeup/path.py:5 Missing annotation from function: "mocked.missing_return_annotation" for return
madeup/path.py:12 Missing annotation from function: "mocked.annotated_fun" for argument "x"
madeup/path.py:12 Missing annotation from function: "mocked.annotated_fun" for argument "y"
madeup/path.py:12 Missing annotation from function: "mocked.annotated_fun" for argument "w"

Development

  • Only supports checking functions for annotations
  • Must pass direct module path

checka's People

Contributors

takac avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.