From 8f4375d934b770e1abcfd97a22b473267449a70e Mon Sep 17 00:00:00 2001 From: Shunsuke Shibayama Date: Tue, 20 Aug 2024 22:33:06 +0900 Subject: [PATCH] Deployed e3a9720 with MkDocs version: 1.6.0 --- index.html | 10 ++-------- search/search_index.json | 2 +- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 9d3f9e4..834a5de 100644 --- a/index.html +++ b/index.html @@ -738,21 +738,15 @@ This language is a transpiled language that targets Python, and has a static typ
  • Literal
  • Callable
  • TypedDict
    • -
  • type variable -
  • Protocol
  • Final
  • Annotated
  • TypeAlias
    • -
  • type guard -
    • +
  • type parameter syntax
    • +
  • type narrowing
  • others
  • collections.abc
  • Iterable
    • diff --git a/search/search_index.json b/search/search_index.json index f403d47..ddab5ab 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"pylyzer \u26a1","text":"

    pylyzer is a static code analyzer / language server for Python, written in Rust.

    "},{"location":"#installation","title":"Installation","text":""},{"location":"#pip","title":"pip","text":"
    pip install pylyzer\n
    "},{"location":"#cargo-rust-package-manager","title":"cargo (rust package manager)","text":"
    cargo install pylyzer --locked\n
    "},{"location":"#build-from-source","title":"build from source","text":"
    git clone https://github.com/mtshiba/pylyzer.git\ncargo install --path . --locked\n

    Make sure that cargo/rustc is up-to-date, as pylyzer may be written with the latest language features.

    "},{"location":"#github-releases","title":"GitHub Releases","text":""},{"location":"#what-is-the-advantage-over-pylint-pyright-pytype-etc","title":"What is the advantage over pylint, pyright, pytype, etc.?","text":"

    On average, pylyzer can inspect Python scripts more than 100 times faster than pytype and pyright 1. This is largely due to the fact that pylyzer is implemented in Rust.

    While pytype/pyright's error reports are illegible, pylyzer shows where the error occurred and provides clear error messages.

    "},{"location":"#pyright","title":"pyright","text":""},{"location":"#pylyzer_1","title":"pylyzer \ud83d\ude03","text":"

    pylyzer as a language server supports various features, such as completion and renaming (The language server is an adaptation of the Erg Language Server (ELS). For more information on the implemented features, please see here).

    "},{"location":"#vscode-extension","title":"VSCode extension","text":"

    You can install the VSCode extension from the Marketplace or from the command line:

    code --install-extension pylyzer.pylyzer\n
    "},{"location":"#what-is-the-difference-from-ruff","title":"What is the difference from Ruff?","text":"

    Ruff, like pylyzer, is a static code analysis tool for Python written in Rust, but Ruff is a linter and pylyzer is a type checker & language server. pylyzer does not perform linting, and Ruff does not perform type checking.

    "},{"location":"#how-it-works","title":"How it works","text":"

    pylyzer uses the type checker of the Erg programming language internally. This language is a transpiled language that targets Python, and has a static type system.

    pylyzer converts Python ASTs to Erg ASTs and passes them to Erg's type checker. It then displays the results with appropriate modifications.

    "},{"location":"#limitations","title":"Limitations","text":""},{"location":"#todos","title":"TODOs","text":"

    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.\u21a9

    "},{"location":"editor/","title":"Editor integrations","text":""},{"location":"editor/#vscode","title":"VSCode","text":""},{"location":"editor/#neovim","title":"Neovim","text":"

    If you use LunarVim, no setup is required. Just install pylyzer and you are good to go.

    "},{"location":"errors/errors/","title":"Pylyzer-specific errors","text":""},{"location":"errors/errors/#e0001-reassignment-of-a-function-referenced-by-other-functions","title":"E0001: Reassignment of a function referenced by other functions","text":"
    def g(): return f()\n\ndef f(): return 1\ndef f(): return \"a\" # E0001: Reassignment of a function referenced by other functions\n\nprint(g())\n
    "},{"location":"errors/errors/#e0002-__init__-doesnt-have-a-first-parameter-named-self","title":"E0002: __init__ doesn't have a first parameter named self","text":"
    class C:\n    def __init__(a): pass # E0002\n
    "},{"location":"errors/errors/#e0003-__init__-as-a-member-variable","title":"E0003: __init__ as a member variable","text":"
    class C:\n    __init__ = 1 # E0003\n
    "},{"location":"errors/warns/","title":"Pylyzer-specific warnings","text":""},{"location":"errors/warns/#w0188-used-value","title":"W0188: Used value","text":"
    def f(x): return x\n\nf(1) # W0188: UnusedWarning: the evaluation result of the expression (: {1, }) is not used\n
    "},{"location":"options/options/","title":"command line options","text":""},{"location":"options/options/#-server","title":"--server","text":"

    Launch as a language server.

    "},{"location":"options/options/#-dump-decl","title":"--dump-decl","text":"

    Dump a type declarations file (d.er) after type checking.

    $ pylyzer --dump-decl test.py\nStart checking: test.py\nAll checks OK: test.py\n\n$ ls\ntest.py  test.d.er\n
    "},{"location":"options/options/#-c-code","title":"-c/--code","text":"

    Check code from the command line.

    $ pylyzer -c \"print('hello world')\"\nStart checking: string\nAll checks OK: string\n
    "},{"location":"options/pyproject/","title":"pyproject.toml options","text":""},{"location":"options/pyproject/#toolpylyzerpythonpath","title":"tool.pylyzer.python.path","text":"

    Path to the Python interpreter to use. If not set, the default Python interpreter will be used.

    [tool.pylyzer.python]\npath = \"path/to/python\"\n
    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"pylyzer \u26a1","text":"

    pylyzer is a static code analyzer / language server for Python, written in Rust.

    "},{"location":"#installation","title":"Installation","text":""},{"location":"#pip","title":"pip","text":"
    pip install pylyzer\n
    "},{"location":"#cargo-rust-package-manager","title":"cargo (rust package manager)","text":"
    cargo install pylyzer --locked\n
    "},{"location":"#build-from-source","title":"build from source","text":"
    git clone https://github.com/mtshiba/pylyzer.git\ncargo install --path . --locked\n

    Make sure that cargo/rustc is up-to-date, as pylyzer may be written with the latest language features.

    "},{"location":"#github-releases","title":"GitHub Releases","text":""},{"location":"#what-is-the-advantage-over-pylint-pyright-pytype-etc","title":"What is the advantage over pylint, pyright, pytype, etc.?","text":"

    On average, pylyzer can inspect Python scripts more than 100 times faster than pytype and pyright 1. This is largely due to the fact that pylyzer is implemented in Rust.

    While pytype/pyright's error reports are illegible, pylyzer shows where the error occurred and provides clear error messages.

    "},{"location":"#pyright","title":"pyright","text":""},{"location":"#pylyzer_1","title":"pylyzer \ud83d\ude03","text":"

    pylyzer as a language server supports various features, such as completion and renaming (The language server is an adaptation of the Erg Language Server (ELS). For more information on the implemented features, please see here).

    "},{"location":"#vscode-extension","title":"VSCode extension","text":"

    You can install the VSCode extension from the Marketplace or from the command line:

    code --install-extension pylyzer.pylyzer\n
    "},{"location":"#what-is-the-difference-from-ruff","title":"What is the difference from Ruff?","text":"

    Ruff, like pylyzer, is a static code analysis tool for Python written in Rust, but Ruff is a linter and pylyzer is a type checker & language server. pylyzer does not perform linting, and Ruff does not perform type checking.

    "},{"location":"#how-it-works","title":"How it works","text":"

    pylyzer uses the type checker of the Erg programming language internally. This language is a transpiled language that targets Python, and has a static type system.

    pylyzer converts Python ASTs to Erg ASTs and passes them to Erg's type checker. It then displays the results with appropriate modifications.

    "},{"location":"#limitations","title":"Limitations","text":""},{"location":"#todos","title":"TODOs","text":"

    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.\u21a9

    "},{"location":"editor/","title":"Editor integrations","text":""},{"location":"editor/#vscode","title":"VSCode","text":""},{"location":"editor/#neovim","title":"Neovim","text":"

    If you use LunarVim, no setup is required. Just install pylyzer and you are good to go.

    "},{"location":"errors/errors/","title":"Pylyzer-specific errors","text":""},{"location":"errors/errors/#e0001-reassignment-of-a-function-referenced-by-other-functions","title":"E0001: Reassignment of a function referenced by other functions","text":"
    def g(): return f()\n\ndef f(): return 1\ndef f(): return \"a\" # E0001: Reassignment of a function referenced by other functions\n\nprint(g())\n
    "},{"location":"errors/errors/#e0002-__init__-doesnt-have-a-first-parameter-named-self","title":"E0002: __init__ doesn't have a first parameter named self","text":"
    class C:\n    def __init__(a): pass # E0002\n
    "},{"location":"errors/errors/#e0003-__init__-as-a-member-variable","title":"E0003: __init__ as a member variable","text":"
    class C:\n    __init__ = 1 # E0003\n
    "},{"location":"errors/warns/","title":"Pylyzer-specific warnings","text":""},{"location":"errors/warns/#w0188-used-value","title":"W0188: Used value","text":"
    def f(x): return x\n\nf(1) # W0188: UnusedWarning: the evaluation result of the expression (: {1, }) is not used\n
    "},{"location":"options/options/","title":"command line options","text":""},{"location":"options/options/#-server","title":"--server","text":"

    Launch as a language server.

    "},{"location":"options/options/#-dump-decl","title":"--dump-decl","text":"

    Dump a type declarations file (d.er) after type checking.

    $ pylyzer --dump-decl test.py\nStart checking: test.py\nAll checks OK: test.py\n\n$ ls\ntest.py  test.d.er\n
    "},{"location":"options/options/#-c-code","title":"-c/--code","text":"

    Check code from the command line.

    $ pylyzer -c \"print('hello world')\"\nStart checking: string\nAll checks OK: string\n
    "},{"location":"options/pyproject/","title":"pyproject.toml options","text":""},{"location":"options/pyproject/#toolpylyzerpythonpath","title":"tool.pylyzer.python.path","text":"

    Path to the Python interpreter to use. If not set, the default Python interpreter will be used.

    [tool.pylyzer.python]\npath = \"path/to/python\"\n
    "}]} \ No newline at end of file