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

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

# This file is part of pipe_base. 

# 

# 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/>. 

 

"""Module defining TaskFactory interface. 

""" 

 

__all__ = ["TaskFactory"] 

 

from abc import ABCMeta, abstractmethod 

 

 

class TaskFactory(metaclass=ABCMeta): 

"""Abstract base class for task factory. 

 

Task factory is responsible for creating instances of PipelineTask 

subclasses. 

""" 

 

@abstractmethod 

def makeTask(self, taskClass, config, overrides, butler): 

"""Create new PipelineTask instance from its class. 

 

Parameters 

---------- 

taskClass : `type` 

`PipelineTask` sub-class. 

config : `pex.Config` or `None` 

Configuration object, if `None` then use task-defined 

configuration class (``taskClass.ConfigClass``) to create new 

instance. 

overrides : `ConfigOverrides` or `None` 

Configuration overrides, this should contain all overrides to be 

applied to a default task config, including instrument-specific, 

obs-package specific, and possibly command-line overrides. This 

parameter is exclusive with ``config``, only one of the two can be 

specified as not-`None`. 

butler : `~lsst.daf.butler.Butler` or None 

Butler instance used to obtain initialization inputs for 

PipelineTasks. If `None`, some PipelineTasks will not be usable 

 

Returns 

------- 

task : `PipelineTask` 

Instance of a `PipelineTask` class or `None` on errors. 

 

Raises 

------ 

Any exceptions that are raised by PipelineTask constructor or its 

configuration class are propagated back to caller. 

"""