Skip to content

Comments

[playground] New default program#17277

Merged
sharkdp merged 1 commit intomainfrom
david/new-default-program
Apr 7, 2025
Merged

[playground] New default program#17277
sharkdp merged 1 commit intomainfrom
david/new-default-program

Conversation

@sharkdp
Copy link
Contributor

@sharkdp sharkdp commented Apr 7, 2025

Summary

This PR proposes to change the default example program in the playground. I realize that this is somewhat underwhelming, but I found it rather difficult to come up with something that circumvented missing support for overloads/generics/self-type, while still looking like (easy!) code that someone might actually write, and demonstrating some Red Knot features. One thing that I wanted to capture was the experience of adding type constraints to an untyped program. And I wanted something that could be executed in the Playground once all errors are fixed.

Happy for any suggestions on what we could do instead. I had a lot of different ideas, but always ran into one or another limitation. So I guess we can also iterate on this as we add more features to Red Knot.

Try it here: https://playknot.ruff.rs/8e3a96af-f35d-4488-840a-2abee6c0512d

from typing import Literal

type Style = Literal["italic", "bold", "underline"]

# Add parameter annotations `line: str, word: str, style: Style` and a return
# type annotation `-> str` to see if you can find the mistakes in this program.

def with_style(line, word, style):
    if style == "italic":
        return line.replace(word, f"*{word}*")
    elif style == "bold":
        return line.replace(word, f"__{word}__")

    position = line.find(word)
    output = line + "\n"
    output += " " * position
    output += "-" * len(word)


print(with_style("Red Knot is a fast type checker for Python.", "fast", "underlined"))

closes #17267

Test Plan

@sharkdp sharkdp added playground A playground-specific issue ty Multi-file analysis & type inference labels Apr 7, 2025
@InSyncWithFoo
Copy link
Contributor

InSyncWithFoo commented Apr 7, 2025 •
edited
Loading

I think there should be a little bit more than that.

Currently, Red Knot has multiple language features. It also understands code flows. The example should demonstrate those:

class User: ...

def create_user(preferred_name: str | None = None) -> User:
	if preferred_name is None:       # Hover over `preferred_name` on this line to see its type.
		print(preferred_name)        # Do that again for this line. The type is now `None`.

		preferred_name = 'Red Knot'
		print(preferred_name)        # Do that a third time. The type is now `Literal['Red Knot']`.

	return User(preferred_name)      # At this point, the type is `str`.

# Red Knot knows where types are defined as well.
# Try it out by right clicking `create_user`, then choose "Go to Type Definition".
user = create_user()

MichaReiser
MichaReiser approved these changes Apr 7, 2025
View reviewed changes
Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do like the example. I could see us have a readme / documentation page where we list some interesting playground that could demonstrate other important features (as @InSyncWithFoo is suggesting)

@sharkdp
Copy link
Contributor Author

sharkdp commented Apr 7, 2025

@InSyncWithFoo Thank you for the example, it demonstrates the LSP features well, but that's not all there is. I don't want to make the code too long, i.e. I don't want to have a collection of unrelated functions. But I like what @MichaReiser suggests, so let's keep this in mind.

As I said, I'm also happy to change this again, but for now, I like it more than ..

import os

.. so I'm merging this for now 😄.

@sharkdp sharkdp merged commit 761749c into main Apr 7, 2025
22 checks passed
@sharkdp sharkdp deleted the david/new-default-program branch April 7, 2025 19:52
@carljm
Copy link
Contributor

carljm commented Apr 7, 2025

Using hover on this example shows some issues that we probably want to fix if this will be our default playground sample:

  1. We infer @Todo for str + Literal["\n"]
  2. We show Never as the hover type of output in output += ...
  3. We infer @Todo for Literal["*"] * int

dcreager added a commit that referenced this pull request Apr 7, 2025
@dcreager
Merge branch 'main' into dcreager/special-class
968e637 
* main: (42 commits)
  [playground] New default program (#17277)
  [red-knot] Add `--python-platform` CLI option (#17284)
  [red-knot] Allow ellipsis default params in stub functions (#17243)
  [red-knot] Fix stale syntax errors in playground (#17280)
  Update Rust crate clap to v4.5.35 (#17273)
  Fix RUF100 to detect unused file-level noqa directives with specific codes (#17042) (#17061)
  [ci] Fix pattern for code changes (#17275)
  [`airflow`] Update oudated `AIR301`, `AIR302` rules (#17123)
  [docs] fix formatting of "See Style Guide" link (#17272)
  [red-knot] Support stub packages (#17204)
  ruff_annotate_snippets: address unused code warnings
  [red-knot] Add a couple more tests for `*` imports (#17270)
  [red-knot] Add 'Format document' to playground (#17217)
  Update actions/setup-node action to v4.3.0 (#17259)
  Update actions/upload-artifact action to v4.6.2 (#17261)
  Update actions/download-artifact action to v4.2.1 (#17258)
  Update actions/setup-python action to v5.5.0 (#17260)
  Update actions/cache action to v4.2.3 (#17256)
  Update Swatinem/rust-cache action to v2.7.8 (#17255)
  Update actions/checkout action to v4.2.2 (#17257)
  ...
@sharkdp
Copy link
Contributor Author

sharkdp commented Apr 7, 2025

Using hover on this example shows some issues that we probably want to fix if this will be our default playground sample:

Yes, I should have mentioned this. I did realize that and accepted it because it "only" requires support for overloads. There are no generics in str.__add__ and str.__mul__.

2. We show Never as the hover type of output in output += ...

This part I missed. Should we open a ticket for it?

@MichaReiser
Copy link
Member

MichaReiser commented Apr 7, 2025 •
edited
Loading

Using hover on this example shows some issues that we probably want to fix if this will be our default playground sample:

Yes, I should have mentioned this. I did realize that and accepted it because it "only" requires support for overloads. There are no generics in str.__add__ and str.__mul__.

2. We show Never as the hover type of output in output += ...

This part I missed. Should we open a ticket for it?

There's a ticket for 2. That I opened last week

Edit: #17122

dcreager added a commit that referenced this pull request Apr 8, 2025
@dcreager
Merge branch 'main' into dcreager/legacy-typevar-instance
6284357 
* main: (222 commits)
  [playground] New default program (#17277)
  [red-knot] Add `--python-platform` CLI option (#17284)
  [red-knot] Allow ellipsis default params in stub functions (#17243)
  [red-knot] Fix stale syntax errors in playground (#17280)
  Update Rust crate clap to v4.5.35 (#17273)
  Fix RUF100 to detect unused file-level noqa directives with specific codes (#17042) (#17061)
  [ci] Fix pattern for code changes (#17275)
  [`airflow`] Update oudated `AIR301`, `AIR302` rules (#17123)
  [docs] fix formatting of "See Style Guide" link (#17272)
  [red-knot] Support stub packages (#17204)
  ruff_annotate_snippets: address unused code warnings
  [red-knot] Add a couple more tests for `*` imports (#17270)
  [red-knot] Add 'Format document' to playground (#17217)
  Update actions/setup-node action to v4.3.0 (#17259)
  Update actions/upload-artifact action to v4.6.2 (#17261)
  Update actions/download-artifact action to v4.2.1 (#17258)
  Update actions/setup-python action to v5.5.0 (#17260)
  Update actions/cache action to v4.2.3 (#17256)
  Update Swatinem/rust-cache action to v2.7.8 (#17255)
  Update actions/checkout action to v4.2.2 (#17257)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MichaReiser MichaReiser MichaReiser approved these changes

Assignees

No one assigned

Labels

playground A playground-specific issue ty Multi-file analysis & type inference

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[playground] Better default example

4 participants

@sharkdp @InSyncWithFoo @carljm @MichaReiser