Coverage for src/abcd_graph/callbacks/abstract.py: 100%

19 statements  

« prev     ^ index     » next       coverage.py v7.5.3, created at 2024-11-16 15:48 +0100

1# Copyright (c) 2024 Jordan Barrett & Aleksander Wojnarowicz 

2# 

3# Permission is hereby granted, free of charge, to any person obtaining a copy 

4# of this software and associated documentation files (the "Software"), to deal 

5# in the Software without restriction, including without limitation the rights 

6# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 

7# copies of the Software, and to permit persons to whom the Software is 

8# furnished to do so, subject to the following conditions: 

9# 

10# The above copyright notice and this permission notice shall be included in all 

11# copies or substantial portions of the Software. 

12# 

13# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 

14# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

15# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 

16# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 

17# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 

18# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 

19# SOFTWARE. 

20 

21import datetime 

22from abc import ABC 

23from dataclasses import dataclass 

24from typing import Optional 

25 

26from abcd_graph.exporter import GraphExporter 

27from abcd_graph.graph.core.abcd_objects import GraphImpl 

28from abcd_graph.models import Model 

29from abcd_graph.params import ABCDParams 

30 

31 

32@dataclass 

33class BuildContext: 

34 model_used: Model 

35 start_time: datetime.datetime 

36 params: ABCDParams 

37 number_of_nodes: int 

38 end_time: Optional[datetime.datetime] = None 

39 raw_build_time: Optional[float] = None 

40 

41 

42class ABCDCallback(ABC): 

43 def before_build(self, context: BuildContext) -> None: ... 

44 

45 def after_build(self, graph: GraphImpl, context: BuildContext, exporter: GraphExporter) -> None: ...