Skip to content

Commit 2c73e69

Browse files
committed
docs: readme update for upcoming release
1 parent 0fc43a3 commit 2c73e69

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55

66
## Important note
77

8-
![image showing deprecation warning](https://github.com/user-attachments/assets/6ab30a54-60e7-4e34-932a-2ac2e253c669)
9-
10-
- Upcoming release:
11-
`BeautifulSoup4` package is added as dependency to utilise its inline annotation, while `types-beautifulsoup4` would be dropped.
8+
- Since `2025.03.04`:
9+
- `BeautifulSoup4` package is added as dependency to utilise its inline annotation, thus dropping `types-beautifulsoup4` dependency.
10+
- Fixes compatibility with older versions of type checkers, as well as `mypy` 1.14+.
1211

1312
- Since `2025.02.24`:
1413
- Incorporates [`basedpyright`](https://github.com/DetachHead/basedpyright) type checker support (an enhanced fork of `pyright`)
1514

15+
![image showing deprecation warning](https://github.com/user-attachments/assets/6ab30a54-60e7-4e34-932a-2ac2e253c669)
16+
1617
- Since `2024.11.08`:
1718
- `pyright` users will see warning if a single string is supplied where collection of string is expected (`tuple`, `set`, `list` etc). In terms of typing, a single `str` itself is valid as a `Sequence`, so type checkers normally would not raise alarm when using `str` in such function parameters, but can induce unexpected runtime behavior. See [#64](https://github.com/abelcheung/types-lxml/issues/64) for more info. `mypy` does not support this feature (which (ab)uses `@deprecated` warning).
1819
- It is possible to verify release files indeed come from GitHub and not maliciously altered. See [Release file attestation](#release-file-attestation) for detail.
@@ -54,9 +55,9 @@ Check out [project page](https://github.com/abelcheung/types-lxml/projects) for
5455

5556
Currently the annotations are validated for following type checkers:
5657

57-
- [`basedpyright`](https://github.com/DetachHead/basedpyright)
58-
- [`pyright`](https://github.com/microsoft/pyright)
59-
- [`mypy`](https://github.com/python/mypy)
58+
- [`basedpyright`](https://github.com/DetachHead/basedpyright), version 1.4.0 or above
59+
- [`pyright`](https://github.com/microsoft/pyright), version 1.1.351 or above
60+
- [`mypy`](https://github.com/python/mypy), version 1.10.0 or above
6061

6162
`pyright` and `basedpyright` are recommended for their greater flexibility and early adoption of newer type checking features. In the future, there is plan to bring even more type checker support.
6263

0 commit comments

Comments
 (0)