Skip to content

Commit 7c5dfc5

Browse files
committed
Merge branch 'main' into patch-1
2 parents 1816e48 + be7ba97 commit 7c5dfc5

File tree

760 files changed

+47782
-1937
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

760 files changed

+47782
-1937
lines changed

.flake8

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[flake8]
22

33
max-line-length = 90
4+
exclude = conformance
45
ignore =
56
# irrelevant plugins
67
B3,

.github/ISSUE_TEMPLATE/documentation-issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Documentation issue
3-
about: Report a problem or suggest changes for the documentation at https://typing.readthedocs.io/
3+
about: Report a problem or suggest changes for the documentation at https://typing.python.org/
44
title: ''
55
labels: 'topic: documentation'
66
assignees: ''

.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: monthly
7+
groups:
8+
actions:
9+
patterns:
10+
- "*"

.github/workflows/build-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ jobs:
1313
runs-on: ubuntu-latest
1414

1515
steps:
16-
- uses: actions/checkout@v2
16+
- uses: actions/checkout@v4
1717
- name: Set up Python
18-
uses: actions/setup-python@v2
18+
uses: actions/setup-python@v5
1919
with:
2020
python-version: 3.9
2121
- name: Install dependencies

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ jobs:
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- uses: actions/checkout@v2
17+
- uses: actions/checkout@v4
1818
- name: Set up Python 3
19-
uses: actions/setup-python@v2
19+
uses: actions/setup-python@v5
2020
with:
2121
python-version: 3
2222
cache: "pip"

.pre-commit-config.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.6.0
4+
hooks:
5+
- id: trailing-whitespace
6+
exclude: conformance/results/.*/.*\.toml
7+
- id: end-of-file-fixer
8+
- id: check-yaml
9+
- id: check-toml
10+
- id: check-merge-conflict
11+
- id: mixed-line-ending
12+
args: [--fix=lf]
13+
exclude: docs/make\.bat
14+
- id: check-case-conflict
15+
- repo: meta
16+
hooks:
17+
- id: check-hooks-apply
18+
19+
ci:
20+
autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
21+
autofix_prs: true
22+
autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
23+
autoupdate_schedule: quarterly
24+
submodules: false

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3"
10+
11+
sphinx:
12+
configuration: docs/conf.py
13+
14+
python:
15+
install:
16+
- requirements: docs/requirements.txt

LICENSE

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@ software.
1313

1414
In May 2000, Guido and the Python core development team moved to
1515
BeOpen.com to form the BeOpen PythonLabs team. In October of the same
16-
year, the PythonLabs team moved to Digital Creations (now Zope
17-
Corporation, see http://www.zope.com). In 2001, the Python Software
18-
Foundation (PSF, see http://www.python.org/psf/) was formed, a
19-
non-profit organization created specifically to own Python-related
20-
Intellectual Property. Zope Corporation is a sponsoring member of
21-
the PSF.
16+
year, the PythonLabs team moved to Digital Creations, which became
17+
Zope Corporation. In 2001, the Python Software Foundation (PSF, see
18+
https://www.python.org/psf/) was formed, a non-profit organization
19+
created specifically to own Python-related Intellectual Property.
20+
Zope Corporation was a sponsoring member of the PSF.
2221

2322
All Python releases are Open Source (see http://www.opensource.org for
2423
the Open Source Definition). Historically, most, but not all, Python
@@ -74,8 +73,9 @@ analyze, test, perform and/or display publicly, prepare derivative works,
7473
distribute, and otherwise use Python alone or in any derivative version,
7574
provided, however, that PSF's License Agreement and PSF's notice of copyright,
7675
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
77-
2011, 2012, 2013, 2014 Python Software Foundation; All Rights Reserved" are
78-
retained in Python alone or in any derivative version prepared by Licensee.
76+
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Python Software Foundation;
77+
All Rights Reserved" are retained in Python alone or in any derivative version
78+
prepared by Licensee.
7979

8080
3. In the event Licensee prepares a derivative work that is based on
8181
or incorporates Python or any part thereof, and wants to make
@@ -180,9 +180,9 @@ version prepared by Licensee. Alternately, in lieu of CNRI's License
180180
Agreement, Licensee may substitute the following text (omitting the
181181
quotes): "Python 1.6.1 is made available subject to the terms and
182182
conditions in CNRI's License Agreement. This Agreement together with
183-
Python 1.6.1 may be located on the Internet using the following
183+
Python 1.6.1 may be located on the internet using the following
184184
unique, persistent identifier (known as a handle): 1895.22/1013. This
185-
Agreement may also be obtained from a proxy server on the Internet
185+
Agreement may also be obtained from a proxy server on the internet
186186
using the following URL: http://hdl.handle.net/1895.22/1013".
187187

188188
3. In the event Licensee prepares a derivative work that is based on

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
1-
[![Chat at https://gitter.im/python/typing](https://badges.gitter.im/python/typing.svg)](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2-
31
# Static Typing for Python
42

53
## Documentation and Support
64

75
The documentation for Python's static typing can be found at
8-
[typing.readthedocs.io](https://typing.readthedocs.io/). You can get
9-
help either in our [support forum](https://github.com/python/typing/discussions) or
10-
chat with us on [Gitter](https://gitter.im/python/typing).
6+
[typing.python.org](https://typing.python.org/). You can get
7+
help in our [support forum](https://github.com/python/typing/discussions).
8+
9+
Improvements to the type system should be discussed on
10+
[Python's Discourse](https://discuss.python.org/c/typing/32), and are
11+
tracked in the [issues](https://github.com/python/typing/issues) in this
12+
repository.
1113

12-
Improvements to the type system should be discussed on the
13-
[typing-sig](https://mail.python.org/mailman3/lists/typing-sig.python.org/)
14-
mailing list, although the [issues](https://github.com/python/typing/issues) in this
15-
repository contain some historic discussions.
14+
For conversations that are more suitable to a chat platform, you can use one of the following:
15+
16+
- [gitter](https://gitter.im/python/typing)
17+
- [discord](https://discord.com/channels/267624335836053506/891788761371906108) `#type-hinting` channel
1618

1719
## Repository Content
1820

1921
This GitHub repository is used for several things:
2022

21-
- The documentation at [typing.readthedocs.io](https://typing.readthedocs.io/)
22-
is maintained in the [docs directory](./docs).
23+
- The documentation at [typing.python.org](https://typing.python.org/)
24+
is maintained in the [docs directory](./docs). This includes the
25+
[specification](https://typing.python.org/en/latest/spec/index.html) for the
26+
type system. See especially [the update procedure](https://typing.python.org/en/latest/spec/meta.html)
27+
for the spec.
2328

2429
- A [discussion forum](https://github.com/python/typing/discussions) for typing-related user
2530
help is hosted here.
2631

32+
- [Conformance test](https://github.com/python/typing/blob/main/conformance/README.md) for Python static type checkers. The [latest conformance test results](https://htmlpreview.github.io/?https://github.com/python/typing/blob/main/conformance/results/results.html) are here.
33+
2734
Historically, this repository also hosted:
2835

2936
- The `typing_extensions` package, which now lives in the

conformance/.gitignore

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# Environments
30+
.env
31+
.venv
32+
33+
# Tools
34+
.mypy_cache
35+
.pyre_configuration
36+
.pyre
37+
.coverage
38+
htmlcov
39+
40+
# General
41+
.DS_Store
42+
43+
# Editor temp files
44+
.*.swp
45+
46+
# Workspace configurations
47+
.vscode

0 commit comments

Comments
 (0)