Python
/
pylyzer
mirror of https://github.com/mtshiba/pylyzer
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update descriptions

This commit is contained in:
Shunsuke Shibayama 2022-12-23 16:22:37 +09:00
parent b0339cef32
commit b6c789f677
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -27,13 +27,13 @@ or download the binary from [the releases page](https://github.com/mtshiba/pylyz
* Performance * 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 [<sup id="f1">1</sup>](#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) ![performance](https://raw.githubusercontent.com/mtshiba/pylyzer/main/images/performance.png)
* Detailed analysis * 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) ![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. 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. * 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). * 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 ## TODOs
@ -74,3 +74,5 @@ pylyzer converts Python ASTs to Erg ASTs and passes them to Erg's type checker.
* [x] local scripts resolving * [x] local scripts resolving
* [ ] local packages resolving * [ ] local packages resolving
* [ ] compound type checking * [ ] compound type checking
<span id="1" style="font-size:x-small"><sup>1</sup> 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)</span>

BIN
images/performance.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 218 KiB

After

Width:  |  Height:  |  Size: 222 KiB