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# Copyright 2019-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"). You 

4# may not use this file except in compliance with the License. A copy of 

5# the License is located at 

6# 

7# http://aws.amazon.com/apache2.0/ 

8# 

9# or in the "license" file accompanying this file. This file is 

10# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF 

11# ANY KIND, either express or implied. See the License for the specific 

12# language governing permissions and limitations under the License. 

13 

14from abc import ABC, abstractmethod 

15 

16 

17class CircuitDiagram(ABC): 

18 """A class that builds circuit diagrams.""" 

19 

20 @staticmethod 

21 @abstractmethod 

22 def build_diagram(circuit) -> str: 

23 """ 

24 Build a diagram for the specified `circuit`. 

25 

26 Args: 

27 circuit (Circuit): The circuit to build a diagram for. 

28 

29 Returns: 

30 str: String representation for the circuit diagram. 

31 An empty string is returned for an empty circuit. 

32 """