Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

# This file is part of utils. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

 

def inheritDoc(klass): 

"""Extends existing documentation for a method that exists in another 

class and extend it with any additional documentation defined. 

 

This decorator takes a class from which to draw documentation from as an 

argument. This is so that any class may be used as a source of documentation 

and not just the immediate parent of a class. This is useful when there may 

be a long inheritance chain, or in the case of mixins. 

 

Parameters 

---------- 

klass : object 

The class to inherit documentation from. 

 

Returns 

------- 

decorator : callable 

Intermediate decorator used in the documentation process. 

""" 

def tmpDecorator(method): 

"""Decorator to update the documentation from a class with the same method 

""" 

methodName = method.__name__ 

if not hasattr(klass, methodName): 

raise AttributeError(f"{klass} has no method named {methodName} to inherit from") 

appendText = method.__doc__ or "" 

method.__doc__ = getattr(klass, methodName).__doc__ + appendText 

return method 

return tmpDecorator