Rename Red Knot (#17820)

This commit is contained in:
Micha Reiser 2025-05-03 19:49:15 +02:00 committed by GitHub
parent e6a798b962
commit b51c4f82ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1564 changed files with 1598 additions and 1578 deletions

View file

@ -0,0 +1,58 @@
# `sys.platform`
## Explicit selection of `all` platforms
When `python-platform="all"` is specified, we fall back to the type of `sys.platform` declared in
typeshed:
```toml
[environment]
python-platform = "all"
```
```py
import sys
reveal_type(sys.platform) # revealed: LiteralString
```
## Explicit selection of a specific platform
```toml
[environment]
python-platform = "linux"
```
```py
import sys
reveal_type(sys.platform) # revealed: Literal["linux"]
```
## Testing for a specific platform
```toml
[environment]
python-platform = "freebsd8"
```
### Exact comparison
```py
import sys
reveal_type(sys.platform == "freebsd8") # revealed: Literal[True]
reveal_type(sys.platform == "linux") # revealed: Literal[False]
```
### Substring comparison
It is [recommended](https://docs.python.org/3/library/sys.html#sys.platform) to use
`sys.platform.startswith(...)` for platform checks:
```py
import sys
reveal_type(sys.platform.startswith("freebsd")) # revealed: Literal[True]
reveal_type(sys.platform.startswith("linux")) # revealed: Literal[False]
```