This repository was archived by the owner on Apr 1, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 68
Expand file tree
/
Copy pathdocs.py
More file actions
39 lines (32 loc) · 1.43 KB
/
docs.py
File metadata and controls
39 lines (32 loc) · 1.43 KB
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
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
def inherit_docs(source_class):
"""
A class decorator that copies docstrings from source_class to the
decorated class for any methods or attributes that match names.
"""
def decorator(target_class):
if not target_class.__doc__ and source_class.__doc__:
target_class.__doc__ = source_class.__doc__
for name, source_item in vars(source_class).items():
if name in vars(target_class):
target_item = getattr(target_class, name)
if hasattr(target_item, "__doc__") and not target_item.__doc__:
if hasattr(source_item, "__doc__") and source_item.__doc__:
try:
target_item.__doc__ = source_item.__doc__
except AttributeError:
pass
return target_class
return decorator