basedpyright: init at 1.12.3

[kiike]

Description of changes

This PR introduces a package for basedpyright, a fork of Microsoft's pyright that introduces some changes such as introduction of some improved unreachable code heuristics, banning of types, and adding features that would be only available with Pylance.

Closes #306129

Things done

Since this packages a fork, I used the existing pyright package.nix by @kalekseev (thanks!) and changed the variables accordingly. I changed the executable paths so hopefully both pyright and basedpyright can coexist side-by-side.

I checked the functionality of the binaries using the helix editor. Instructions for testing this kind of setup will be in a comment below.

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[kiike]

To test:

1. I have started a nix-shell with nix shell .#basedpyright
2. included the basedpyright helix config in my home-manager config:

programs.helix.languages."language-server" = {
  basedpyright = {
    command = "basedpyright-langserver";
    args = [ "--stdio" ];
    config = { };
    };
};

3. Included the config in a Python project:

cat .helix/languages.toml
[[language]]
name = "python"
language-servers = ["basedpyright"]

4. Tested whether the configuration is fine:

hx --health python
Configured language servers:
  ✓ basedpyright-langserver: /nix/store/zrlvsrsflb7d8yxww42fgs4g12vcr47n-basedpyright-1.11.0/bin/basedpyright-langserver
Configured debug adapter: python3
Binary for debug adapter: /nix/store/3v2ch16fkl50i85n05h5ckss8pxx6836-python3-3.11.8/bin/python3
Configured formatter: None
Highlight queries: ✓
Textobject queries: ✓
Indent queries: ✓

[getchoo]

Result of nixpkgs-review pr 308503 run on aarch64-linux 1

1 package built:

• basedpyright

[kiike]

Hi @kalekseev! Seeing that you reviewed and developed the pyright package, would you like to review this?

UPDATE: I've updated the package:

 cat << EOF > test.py; basedpyright --version; basedpyright test.py
import sys

if sys.platform == "win32":
    a = "a" + 1
EOF
basedpyright 1.12.1
based on pyright 1.1.362
/home/kiike/projects/nixpkgs/test.py
  /home/kiike/projects/nixpkgs/test.py:4:5 - error: Type of "a" is unknown (reportUnknownVariableType)
  /home/kiike/projects/nixpkgs/test.py:4:9 - error: Operator "+" not supported for types "Literal['a']" and "Literal[1]" (reportOperatorIssue)
2 errors, 0 warnings, 0 notes

[kalekseev]

Hi @kalekseev! Seeing that you reviewed and developed the pyright package, would you like to review this?

Looks good to me but I don't have rights to merge.

[pluiedev]

Result of nixpkgs-review pr 308503 run on x86_64-linux 1

1 package built:

• basedpyright

[kiike]

Thank you both for your approvals!

[kiike]

Updated to latest version released today.

 nix shell .#basedpyright -L
[...]

 cat << EOF > test.py; basedpyright --version; basedpyright test.py
import sys

if sys.platform == "win32":
    a = "a" + 1
EOF
basedpyright 1.12.2
based on pyright 1.1.363
/home/kiike/projects/nixpkgs/test.py
  /home/kiike/projects/nixpkgs/test.py:4:5 - error: Type of "a" is unknown (reportUnknownVariableType)
  /home/kiike/projects/nixpkgs/test.py:4:9 - error: Operator "+" not supported for types "Literal['a']" and "Literal[1]" (reportOperatorIssue)
2 errors, 0 warnings, 0 notes

[pluiedev]

Works great!

[GaetanLepage]

Result of nixpkgs-review pr 308503 run on aarch64-linux 1

1 package built:

• basedpyright

[GaetanLepage]

Result of nixpkgs-review pr 308503 run on aarch64-darwin 1

1 package built:

• basedpyright

[GaetanLepage]

Result of nixpkgs-review pr 308503 run on x86_64-linux 1

1 package built:

• basedpyright

[GaetanLepage]

Result of nixpkgs-review pr 308503 run on x86_64-darwin 1

1 package built:

• basedpyright

[kiike]

Updated to 1.12.3 released yesterday:

Changelog:

update upstream pyright version to 1.1.364 by @DetachHead in DetachHead/basedpyright#375
fix Any being coloured as a variable instead of a type by @DetachHead in DetachHead/basedpyright#373
documentation enhancements
new URL: https://docs.basedpyright.com/
explain how to use the CLI & language server from pypi and make it clear that many of the IDE plugins require them to be installed by @DetachHead in DetachHead/basedpyright#366
Improve Neovim installation instructions by @baco in DetachHead/basedpyright#368

Full Changelog: DetachHead/basedpyright@v1.12.2...v1.12.3

Testing it in a shell with nix shell .#basedpyright -L.

Copy & paste command:

cat << EOF > test.py; basedpyright --version; basedpyright test.py
import sys

if sys.platform == "win32":
    a = "a" + 1
EOF

Output:

basedpyright 1.12.3
based on pyright 1.1.364
/home/kiike/projects/nixpkgs/test.py
  /home/kiike/projects/nixpkgs/test.py:4:5 - error: Type of "a" is unknown (reportUnknownVariableType)
  /home/kiike/projects/nixpkgs/test.py:4:9 - error: Operator "+" not supported for types "Literal['a']" and "Literal[1]" (reportOperatorIssue)
2 errors, 0 warnings, 0 notes

[GaetanLepage]

LGTM !

[GaetanLepage]

I would squash all the commits into one: basedpyright: init at 1.12.3.

[natsukium]

Does this update script work properly?
The original pyright has its own script.

[kiike]

The original script didn't work for me. I tried nix-update-script and it worked.

[kiike]

I would squash all the commits into one: basedpyright: init at 1.12.3.

Done!

[natsukium]

LGTM, thank you!