diff --git a/README.md b/README.md index 77c5322..4692fc7 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,13 @@ or download the binary from [the releases page](https://github.com/mtshiba/pylyz * Performance -pylyzer can inspect Python scripts on average __100 times faster__ than pytype and pyright. This is largely due to the fact that pylyzer is implemented in Rust, whereas pytype is implemented in Python. +On average, pylyzer can inspect Python scripts more than __100 times faster__ than pytype and pyright [1](#1). This is largely due to the fact that pylyzer is implemented in Rust. ![performance](https://raw.githubusercontent.com/mtshiba/pylyzer/main/images/performance.png) * Detailed analysis -pylyzer can do more than the usual type testing. For example, it can detect out-of-bounds accesses to lists and accesses to nonexistent keys in dicts. +pylyzer can do more than the type checking. For example, it can detect out-of-bounds accesses to lists and accesses to nonexistent keys in dicts. ![analysis](https://raw.githubusercontent.com/mtshiba/pylyzer/main/images/analysis.png) @@ -50,13 +50,13 @@ This language is a transpiled language that targets Python, and has a static typ pylyzer converts Python ASTs to Erg ASTs and passes them to Erg's type checker. It then displays the results with appropriate modifications. -## Limitation +## Limitations * pylyzer's type inspector only assumes (potentially) statically typed code, so you cannot check any code uses reflections, such as `exec`, `setattr`, etc. * Type checking of compound types such as Union types is not supported yet (will be implemented soon). -* pylyzer has its own type declarations for the Python standard APIs. Typing of all APIs is not complete and may result in an error that such an API does not exist. +* pylyzer (= Erg's type system) has its own type declarations for the Python standard APIs. Typing of all APIs is not complete and may result in an error that such an API does not exist. ## TODOs @@ -74,3 +74,5 @@ pylyzer converts Python ASTs to Erg ASTs and passes them to Erg's type checker. * [x] local scripts resolving * [ ] local packages resolving * [ ] compound type checking + +1 The performance test was conducted on MacBook (Early 2016) with 1.1 GHz Intel Core m3 processor and 8 GB 1867 MHz LPDDR3 memory.[↩](#f1) diff --git a/images/performance.png b/images/performance.png index 5df9c45..9ef316a 100644 Binary files a/images/performance.png and b/images/performance.png differ