Skip to main content

Modern python code review tool / framework

Project description

InspectorTiger

CI codecov PyPI version black Python 3.7+ Dependency Free

IT, Inspector Tiger, is a modern python code review tool / framework. It comes with bunch of pre-defined handlers which warns you about improvements and possible bugs. Beside these handlers, you can write your own or use community ones.

ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"


class Foo(SomeObjects):
    def bar(self, x=[], y: Union[int, None] = None):
        x.append(1)
        for _ in range(3):
            try:
                super(bla, bla).foo_baz()
            except Exception:
                print("An exception")
            except AttributeError:
                print("An attribute error")
            finally:
                continue

        my_iterable = list(token[0] for token in tokens)
        for a in my_iterable:
            yield a

        my_other_iterable = list(map(itemgetter(0), tokens))
        for a in range(len(my_other_iterable)):
            print(a, "=>", my_other_iterable[a])

Think about this piece of code, you see some bugs or improvements, don't you? But what if there were hundreds of lines code in this form inside your big codebase. How would you find these patterns? By writing regex queries? LOL, of course not.

$ it example.py
[Inspector Tiger] INFO - InspectorTiger inspected 🔎 and found these problems;
[Inspector Tiger] INFO - 
[upgrade]
  - example.py:1:0     => ALPHABET_CONSTANT
  - example.py:5:27    => OPTIONAL
  - example.py:9:16    => SUPER_ARGS
  - example.py:17:22   => USE_COMPREHENSION
  - example.py:18:8    => YIELD_FROM
  - example.py:21:28   => MAP_USE_COMPREHENSION
  - example.py:22:8    => BUILTIN_ENUMERATE
[general]
  - example.py:5:4     => DEFAULT_MUTABLE_ARG
  - example.py:8:12    => CONTROL_FLOW_INSIDE_FINALLY
  - example.py:8:12    => UNREACHABLE_EXCEPT

Tutorials

API

Also Inspector Tiger comes with a builtin server (it.server) which offers a basic REST API. If you want to try it without downloading, you can use our heroku instance.

(.venv) [  6:02PM  ]  [  isidentical@x200  ]
$ curl -s https://inspector.herokuapp.com -d '{"source": "Union[MyType, None]"}' | jq
{
  "status": "success",
  "result": {
    "upgradeable": [
      {
        "code": "OPTIONAL",
        "column": 0,
        "lineno": 1,
        "filename": "<unknown>"
      }
    ]
  }
}

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

it-1.0.0.tar.gz (15.0 kB view hashes)

Uploaded Source

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