Skip to content

Commit 141d990

Browse files
dbhatmandbhatman
authored
Expose public API with __all__ (#1046)
This replaces the need for #1016 and more closely follows the Google style guide. In particular https://google.github.io/styleguide/pyguide.html#22-imports. PiperOrigin-RevId: 477311168
1 parent 09bbcf1 commit 141d990

File tree

1 file changed

+101
-32
lines changed

1 file changed

+101
-32
lines changed

‎openhtf/__init__.py‎

Lines changed: 101 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,17 @@
1919
from openhtf import plugs
2020
from openhtf.core import phase_executor
2121
from openhtf.core import test_record
22-
from openhtf.core.base_plugs import BasePlug
23-
from openhtf.core.diagnoses_lib import DiagnosesStore
24-
from openhtf.core.diagnoses_lib import Diagnosis
25-
from openhtf.core.diagnoses_lib import DiagnosisComponent
26-
from openhtf.core.diagnoses_lib import DiagPriority
27-
from openhtf.core.diagnoses_lib import DiagResultEnum
28-
from openhtf.core.diagnoses_lib import PhaseDiagnoser
29-
from openhtf.core.diagnoses_lib import TestDiagnoser
30-
31-
from openhtf.core.measurements import Dimension
32-
from openhtf.core.measurements import Measurement
33-
from openhtf.core.monitors import monitors
34-
from openhtf.core.phase_branches import BranchSequence
35-
from openhtf.core.phase_branches import DiagnosisCheckpoint
36-
from openhtf.core.phase_branches import DiagnosisCondition
37-
from openhtf.core.phase_branches import PhaseFailureCheckpoint
38-
from openhtf.core.phase_collections import PhaseSequence
39-
from openhtf.core.phase_collections import Subtest
40-
from openhtf.core.phase_descriptor import diagnose
41-
from openhtf.core.phase_descriptor import measures
42-
from openhtf.core.phase_descriptor import PhaseDescriptor
43-
from openhtf.core.phase_descriptor import PhaseNameCase
44-
from openhtf.core.phase_descriptor import PhaseOptions
45-
from openhtf.core.phase_descriptor import PhaseResult
46-
from openhtf.core.phase_group import PhaseGroup
47-
from openhtf.core.phase_nodes import PhaseNode
48-
from openhtf.core.test_descriptor import Test
49-
from openhtf.core.test_descriptor import TestApi
50-
from openhtf.core.test_descriptor import TestDescriptor
51-
from openhtf.core.test_record import PhaseRecord
52-
from openhtf.core.test_record import TestRecord
53-
from openhtf.plugs import plug
22+
import openhtf.core.base_plugs
23+
import openhtf.core.diagnoses_lib
24+
import openhtf.core.measurements
25+
import openhtf.core.monitors
26+
import openhtf.core.phase_branches
27+
import openhtf.core.phase_collections
28+
import openhtf.core.phase_descriptor
29+
import openhtf.core.phase_group
30+
import openhtf.core.phase_nodes
31+
import openhtf.core.test_descriptor
32+
import openhtf.util
5433
from openhtf.util import configuration
5534
from openhtf.util import console_output
5635
from openhtf.util import data
@@ -59,6 +38,96 @@
5938
from openhtf.util import units
6039
import pkg_resources
6140

41+
__all__ = ( # Expliclty export certain API components.
42+
# Modules.
43+
'plugs',
44+
'phase_executor',
45+
'test_record',
46+
'configuration',
47+
'console_output',
48+
'data',
49+
'functions',
50+
'logs',
51+
'units',
52+
# Public Functions.
53+
'plug',
54+
'monitors',
55+
'diagnose',
56+
'measures',
57+
# Public Classes.
58+
'BasePlug',
59+
'DiagnosesStore',
60+
'Diagnosis',
61+
'DiagnosisComponent',
62+
'DiagPriority',
63+
'DiagResultEnum',
64+
'PhaseDiagnoser',
65+
'TestDiagnoser',
66+
'Dimension',
67+
'Measurement',
68+
'BranchSequence',
69+
'DiagnosisCheckpoint',
70+
'DiagnosisCondition',
71+
'PhaseFailureCheckpoint',
72+
'PhaseSequence',
73+
'Subtest',
74+
'PhaseDescriptor',
75+
'PhaseNameCase',
76+
'PhaseOptions',
77+
'PhaseResult',
78+
'PhaseGroup',
79+
'PhaseNode',
80+
'Test',
81+
'TestApi',
82+
'TestDescriptor',
83+
'PhaseRecord',
84+
'TestRecord',
85+
# Globals.
86+
'conf',
87+
)
88+
89+
plug = plugs.plug
90+
BasePlug = openhtf.core.base_plugs.BasePlug
91+
92+
DiagnosesStore = openhtf.core.diagnoses_lib.DiagnosesStore
93+
Diagnosis = openhtf.core.diagnoses_lib.Diagnosis
94+
DiagnosisComponent = openhtf.core.diagnoses_lib.DiagnosisComponent
95+
DiagPriority = openhtf.core.diagnoses_lib.DiagPriority
96+
DiagResultEnum = openhtf.core.diagnoses_lib.DiagResultEnum
97+
PhaseDiagnoser = openhtf.core.diagnoses_lib.PhaseDiagnoser
98+
TestDiagnoser = openhtf.core.diagnoses_lib.TestDiagnoser
99+
100+
Dimension = openhtf.core.measurements.Dimension
101+
Measurement = openhtf.core.measurements.Measurement
102+
103+
monitors = openhtf.core.monitors.monitors
104+
105+
BranchSequence = openhtf.core.phase_branches.BranchSequence
106+
DiagnosisCheckpoint = openhtf.core.phase_branches.DiagnosisCheckpoint
107+
DiagnosisCondition = openhtf.core.phase_branches.DiagnosisCondition
108+
PhaseFailureCheckpoint = openhtf.core.phase_branches.PhaseFailureCheckpoint
109+
110+
PhaseSequence = openhtf.core.phase_collections.PhaseSequence
111+
Subtest = openhtf.core.phase_collections.Subtest
112+
113+
diagnose = openhtf.core.phase_descriptor.diagnose
114+
measures = openhtf.core.phase_descriptor.measures
115+
PhaseDescriptor = openhtf.core.phase_descriptor.PhaseDescriptor
116+
PhaseNameCase = openhtf.core.phase_descriptor.PhaseNameCase
117+
PhaseOptions = openhtf.core.phase_descriptor.PhaseOptions
118+
PhaseResult = openhtf.core.phase_descriptor.PhaseResult
119+
120+
PhaseGroup = openhtf.core.phase_group.PhaseGroup
121+
122+
PhaseNode = openhtf.core.phase_nodes.PhaseNode
123+
124+
Test = openhtf.core.test_descriptor.Test
125+
TestApi = openhtf.core.test_descriptor.TestApi
126+
TestDescriptor = openhtf.core.test_descriptor.TestDescriptor
127+
128+
PhaseRecord = test_record.PhaseRecord
129+
TestRecord = test_record.TestRecord
130+
62131
conf = configuration.CONF
63132

64133

0 commit comments

Comments
 (0)