summaryrefslogtreecommitdiff
path: root/docs/plugins_api.rst
blob: 99f8094c129f1db24cfce11587d06539042c19f1 (plain)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
API
===

tox objects
~~~~~~~~~~~

register
--------

.. automodule:: tox.tox_env.register
   :members:
   :exclude-members: REGISTER

.. autodata:: REGISTER
   :no-value:

config
------
.. autoclass:: tox.config.cli.parser.ArgumentParserWithEnvAndConfig
   :members:

.. autoclass:: tox.config.cli.parser.ToxParser
   :members:

.. autoclass:: tox.config.cli.parser.Parsed
   :members:

.. autoclass:: tox.config.main.Config
   :members:
   :exclude-members: __init__, make

.. autoclass:: tox.config.loader.section.Section
   :members:

.. autoclass:: tox.config.loader.api.ConfigLoadArgs
   :members:

.. autoclass:: tox.config.sets.ConfigSet
   :members:
   :special-members: __iter__, __contains__

.. autoclass:: tox.config.sets.CoreConfigSet
   :members:

.. autoclass:: tox.config.sets.EnvConfigSet
   :members:

.. autoclass:: tox.config.of_type.ConfigDefinition
   :members:

.. autoclass:: tox.config.of_type.ConfigDynamicDefinition
   :members:

.. autoclass:: tox.config.of_type.ConfigConstantDefinition
   :members:

.. autoclass:: tox.config.source.api.Source
   :members:

.. autoclass:: tox.config.loader.api.Override
   :members:

.. autoclass:: tox.config.loader.api.Loader
   :members:

.. autoclass:: tox.config.loader.convert.Convert
   :members:

.. autoclass:: tox.config.types.EnvList
   :members:
   :special-members: __bool__, __iter__

.. autoclass:: tox.config.types.Command
   :members:

.. autoclass:: tox.config.loader.convert.Factory
   :members:

environments
------------
.. autoclass:: tox.tox_env.api.ToxEnv
   :members:

.. autoclass:: tox.tox_env.runner.RunToxEnv
   :members:

.. autoclass:: tox.tox_env.package.PackageToxEnv
   :members:

.. autoclass:: tox.tox_env.package.Package
   :members:

journal
-------
.. autoclass:: tox.journal.env.EnvJournal
   :members:
   :exclude-members: __init__
   :special-members: __bool__, __setitem__

report
------
.. autoclass:: tox.report.ToxHandler
   :members:
   :exclude-members: stream, format, patch_thread, write_out_err, suspend_out_err

execute
-------
.. autoclass:: tox.execute.request.ExecuteRequest
   :members:

.. autoclass:: tox.execute.request.StdinSource
   :members:

.. autoclass:: tox.execute.api.Outcome
   :members:

.. autoclass:: tox.execute.api.Execute
   :members:

.. autoclass:: tox.execute.api.ExecuteStatus
   :members:

.. autoclass:: tox.execute.api.ExecuteInstance
   :members:

.. autoclass:: tox.execute.stream.SyncWrite
   :members:

installer
---------

.. autoclass:: tox.tox_env.installer.Installer
   :members:

session
-------
.. autoclass:: tox.session.state.State
   :members:

.. autoclass:: tox.session.env_select.EnvSelector
   :members:

.. autoclass:: tox.tox_env.info.Info
   :members: