Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cpython/Lib/abc.py at main · devdanzin/cpython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
devdanzin
/
cpython
Public
forked from
python/cpython
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
cpython
/
Lib
/
abc.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
188 lines (143 loc) · 6.38 KB
main
Breadcrumbs
cpython
/
Lib
/
abc.py
Copy path
Top
File metadata and controls
Code
Blame
188 lines (143 loc) · 6.38 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# Copyright 2007 Google, Inc. All Rights Reserved.
# Licensed to PSF under a Contributor Agreement.
"""Abstract Base Classes (ABCs) according to PEP 3119."""
def
abstractmethod
(
funcobj
):
"""A decorator indicating abstract methods.
Requires that the metaclass is ABCMeta or derived from it. A
class that has a metaclass derived from ABCMeta cannot be
instantiated unless all of its abstract methods are overridden.
The abstract methods can be called using any of the normal
'super' call mechanisms. abstractmethod() may be used to declare
abstract methods for properties and descriptors.
Usage:
class C(metaclass=ABCMeta):
@abstractmethod
def my_abstract_method(self, arg1, arg2, argN):
...
"""
funcobj
.
__isabstractmethod__
=
True
return
funcobj
class
abstractclassmethod
(
classmethod
):
"""A decorator indicating abstract classmethods.
Deprecated, use 'classmethod' with 'abstractmethod' instead:
class C(ABC):
@classmethod
@abstractmethod
def my_abstract_classmethod(cls, ...):
...
"""
__isabstractmethod__
=
True
def
__init__
(
self
,
callable
):
callable
.
__isabstractmethod__
=
True
super
().
__init__
(
callable
)
class
abstractstaticmethod
(
staticmethod
):
"""A decorator indicating abstract staticmethods.
Deprecated, use 'staticmethod' with 'abstractmethod' instead:
class C(ABC):
@staticmethod
@abstractmethod
def my_abstract_staticmethod(...):
...
"""
__isabstractmethod__
=
True
def
__init__
(
self
,
callable
):
callable
.
__isabstractmethod__
=
True
super
().
__init__
(
callable
)
class
abstractproperty
(
property
):
"""A decorator indicating abstract properties.
Deprecated, use 'property' with 'abstractmethod' instead:
class C(ABC):
@property
@abstractmethod
def my_abstract_property(self):
...
"""
__isabstractmethod__
=
True
try
:
from
_abc
import
(
get_cache_token
,
_abc_init
,
_abc_register
,
_abc_instancecheck
,
_abc_subclasscheck
,
_get_dump
,
_reset_registry
,
_reset_caches
)
except
ImportError
:
from
_py_abc
import
ABCMeta
,
get_cache_token
ABCMeta
.
__module__
=
'abc'
else
:
class
ABCMeta
(
type
):
"""Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
"""
def
__new__
(
mcls
,
name
,
bases
,
namespace
,
/
,
**
kwargs
):
cls
=
super
().
__new__
(
mcls
,
name
,
bases
,
namespace
,
**
kwargs
)
_abc_init
(
cls
)
return
cls
def
register
(
cls
,
subclass
):
"""Register a virtual subclass of an ABC.
Returns the subclass, to allow usage as a class decorator.
"""
return
_abc_register
(
cls
,
subclass
)
def
__instancecheck__
(
cls
,
instance
):
"""Override for isinstance(instance, cls)."""
return
_abc_instancecheck
(
cls
,
instance
)
def
__subclasscheck__
(
cls
,
subclass
):
"""Override for issubclass(subclass, cls)."""
return
_abc_subclasscheck
(
cls
,
subclass
)
def
_dump_registry
(
cls
,
file
=
None
):
"""Debug helper to print the ABC registry."""
print
(
f"Class:
{
cls
.
__module__
}
.
{
cls
.
__qualname__
}
"
,
file
=
file
)
print
(
f"Inv. counter:
{
get_cache_token
()
}
"
,
file
=
file
)
(
_abc_registry
,
_abc_cache
,
_abc_negative_cache
,
_abc_negative_cache_version
)
=
_get_dump
(
cls
)
print
(
f"_abc_registry:
{
_abc_registry
!r
}
"
,
file
=
file
)
print
(
f"_abc_cache:
{
_abc_cache
!r
}
"
,
file
=
file
)
print
(
f"_abc_negative_cache:
{
_abc_negative_cache
!r
}
"
,
file
=
file
)
print
(
f"_abc_negative_cache_version:
{
_abc_negative_cache_version
!r
}
"
,
file
=
file
)
def
_abc_registry_clear
(
cls
):
"""Clear the registry (for debugging or testing)."""
_reset_registry
(
cls
)
def
_abc_caches_clear
(
cls
):
"""Clear the caches (for debugging or testing)."""
_reset_caches
(
cls
)
def
update_abstractmethods
(
cls
):
"""Recalculate the set of abstract methods of an abstract class.
If a class has had one of its abstract methods implemented after the
class was created, the method will not be considered implemented until
this function is called. Alternatively, if a new abstract method has been
added to the class, it will only be considered an abstract method of the
class after this function is called.
This function should be called before any use is made of the class,
usually in class decorators that add methods to the subject class.
Returns cls, to allow usage as a class decorator.
If cls is not an instance of ABCMeta, does nothing.
"""
if
not
hasattr
(
cls
,
'__abstractmethods__'
):
# We check for __abstractmethods__ here because cls might by a C
# implementation or a python implementation (especially during
# testing), and we want to handle both cases.
return
cls
abstracts
=
set
()
# Check the existing abstract methods of the parents, keep only the ones
# that are not implemented.
for
scls
in
cls
.
__bases__
:
for
name
in
getattr
(
scls
,
'__abstractmethods__'
, ()):
value
=
getattr
(
cls
,
name
,
None
)
if
getattr
(
value
,
"__isabstractmethod__"
,
False
):
abstracts
.
add
(
name
)
# Also add any other newly added abstract methods.
for
name
,
value
in
cls
.
__dict__
.
items
():
if
getattr
(
value
,
"__isabstractmethod__"
,
False
):
abstracts
.
add
(
name
)
cls
.
__abstractmethods__
=
frozenset
(
abstracts
)
return
cls
class
ABC
(
metaclass
=
ABCMeta
):
"""Helper class that provides a standard way to create an ABC using
inheritance.
"""
__slots__
=
()
You can’t perform that action at this time.