Skip to content

Commit a254693

Browse files
committed
doc: document PythonVersionSupportStatus
1 parent 706518c commit a254693

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

google/api_core/_python_version_support.py

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,32 @@
2323

2424

2525
class PythonVersionStatus(enum.Enum):
26-
"""Represent the support status of a Python version."""
26+
"""Support status of a Python version in this client library artifact release.
27+
28+
"Support", in this context, means that this release of a client library
29+
artifact is configured to run on the currently configured version of
30+
Python.
31+
"""
2732

2833
PYTHON_VERSION_STATUS_UNSPECIFIED = "PYTHON_VERSION_STATUS_UNSPECIFIED"
29-
PYTHON_VERSION_UNSUPPORTED = "PYTHON_VERSION_UNSUPPORTED"
30-
PYTHON_VERSION_EOL = "PYTHON_VERSION_EOL"
31-
PYTHON_VERSION_DEPRECATED = "PYTHON_VERSION_DEPRECATED"
34+
3235
PYTHON_VERSION_SUPPORTED = "PYTHON_VERSION_SUPPORTED"
36+
"""This Python version is fully supported, so the artifact running on this
37+
version will have all features and bug fixes."""
38+
39+
PYTHON_VERSION_DEPRECATED = "PYTHON_VERSION_DEPRECATED"
40+
"""This Python version is still supported, but support will end within a
41+
year. At that time, there will be no more releases for this artifact
42+
running under this Python version."""
43+
44+
PYTHON_VERSION_EOL = "PYTHON_VERSION_EOL"
45+
"""This Python version has reached its end of life in the Python community
46+
(see https://devguide.python.org/versions/), and this artifact will cease
47+
supporting this Python version within the next few releases."""
48+
49+
PYTHON_VERSION_UNSUPPORTED = "PYTHON_VERSION_UNSUPPORTED"
50+
"""This release of the client library artifact may not be the latest, since
51+
current releases no longer support this Python version."""
3352

3453

3554
class VersionInfo(NamedTuple):

0 commit comments

Comments
 (0)