| 1 |
###################### |
| 2 |
Plugin API reference |
| 3 |
###################### |
| 4 |
|
| 5 |
************* |
| 6 |
tox objects |
| 7 |
************* |
| 8 |
|
| 9 |
register |
| 10 |
======== |
| 11 |
|
| 12 |
.. automodule:: tox.tox_env.register |
| 13 |
:members: |
| 14 |
:exclude-members: REGISTER |
| 15 |
|
| 16 |
.. autodata:: REGISTER |
| 17 |
:no-value: |
| 18 |
|
| 19 |
config |
| 20 |
====== |
| 21 |
|
| 22 |
.. autoclass:: tox.config.cli.parser.ArgumentParserWithEnvAndConfig |
| 23 |
:members: |
| 24 |
|
| 25 |
.. autoclass:: tox.config.cli.parser.ToxParser |
| 26 |
:members: |
| 27 |
|
| 28 |
.. autoclass:: tox.config.cli.parser.Parsed |
| 29 |
:members: |
| 30 |
|
| 31 |
.. autoclass:: tox.config.main.Config |
| 32 |
:members: |
| 33 |
:exclude-members: __init__, make |
| 34 |
|
| 35 |
.. autoclass:: tox.config.loader.section.Section |
| 36 |
:members: |
| 37 |
|
| 38 |
.. autoclass:: tox.config.loader.api.ConfigLoadArgs |
| 39 |
:members: |
| 40 |
|
| 41 |
.. autoclass:: tox.config.sets.ConfigSet |
| 42 |
:members: |
| 43 |
:special-members: __iter__, __contains__ |
| 44 |
|
| 45 |
.. autoclass:: tox.config.sets.CoreConfigSet |
| 46 |
:members: |
| 47 |
|
| 48 |
.. autoclass:: tox.config.sets.EnvConfigSet |
| 49 |
:members: |
| 50 |
|
| 51 |
.. autoclass:: tox.config.of_type.ConfigDefinition |
| 52 |
:members: |
| 53 |
|
| 54 |
.. autoclass:: tox.config.of_type.ConfigDynamicDefinition |
| 55 |
:members: |
| 56 |
|
| 57 |
.. autoclass:: tox.config.of_type.ConfigConstantDefinition |
| 58 |
:members: |
| 59 |
|
| 60 |
.. autoclass:: tox.config.source.api.Source |
| 61 |
:members: |
| 62 |
|
| 63 |
.. autoclass:: tox.config.loader.api.Override |
| 64 |
:members: |
| 65 |
|
| 66 |
.. autoclass:: tox.config.loader.api.Loader |
| 67 |
:members: |
| 68 |
|
| 69 |
.. autoclass:: tox.config.loader.memory.MemoryLoader |
| 70 |
:members: |
| 71 |
|
| 72 |
.. autoclass:: tox.config.loader.convert.Convert |
| 73 |
:members: |
| 74 |
|
| 75 |
.. autoclass:: tox.config.types.EnvList |
| 76 |
:members: |
| 77 |
:special-members: __bool__, __iter__ |
| 78 |
|
| 79 |
.. autoclass:: tox.config.types.Command |
| 80 |
:members: |
| 81 |
|
| 82 |
.. autoclass:: tox.config.loader.convert.Factory |
| 83 |
:members: |
| 84 |
|
| 85 |
environments |
| 86 |
============ |
| 87 |
|
| 88 |
.. autoclass:: tox.tox_env.api.ToxEnv |
| 89 |
:members: |
| 90 |
|
| 91 |
.. autoclass:: tox.tox_env.runner.RunToxEnv |
| 92 |
:members: |
| 93 |
|
| 94 |
.. autoclass:: tox.tox_env.package.PackageToxEnv |
| 95 |
:members: |
| 96 |
|
| 97 |
.. autoclass:: tox.tox_env.package.Package |
| 98 |
:members: |
| 99 |
|
| 100 |
journal |
| 101 |
======= |
| 102 |
|
| 103 |
.. autoclass:: tox.journal.env.EnvJournal |
| 104 |
:members: |
| 105 |
:exclude-members: __init__ |
| 106 |
:special-members: __bool__, __setitem__ |
| 107 |
|
| 108 |
report |
| 109 |
====== |
| 110 |
|
| 111 |
.. autoclass:: tox.report.ToxHandler |
| 112 |
:members: |
| 113 |
:exclude-members: stream, format, patch_thread, write_out_err, suspend_out_err |
| 114 |
|
| 115 |
execute |
| 116 |
======= |
| 117 |
|
| 118 |
.. autoclass:: tox.execute.request.ExecuteRequest |
| 119 |
:members: |
| 120 |
|
| 121 |
.. autoclass:: tox.execute.request.StdinSource |
| 122 |
:members: |
| 123 |
|
| 124 |
.. autoclass:: tox.execute.api.Outcome |
| 125 |
:members: |
| 126 |
|
| 127 |
.. autoclass:: tox.execute.api.Execute |
| 128 |
:members: |
| 129 |
|
| 130 |
.. autoclass:: tox.execute.api.ExecuteStatus |
| 131 |
:members: |
| 132 |
|
| 133 |
.. autoclass:: tox.execute.api.ExecuteInstance |
| 134 |
:members: |
| 135 |
|
| 136 |
.. autoclass:: tox.execute.stream.SyncWrite |
| 137 |
:members: |
| 138 |
|
| 139 |
installer |
| 140 |
========= |
| 141 |
|
| 142 |
.. autoclass:: tox.tox_env.installer.Installer |
| 143 |
:members: |
| 144 |
|
| 145 |
session |
| 146 |
======= |
| 147 |
|
| 148 |
.. autoclass:: tox.session.state.State |
| 149 |
:members: |
| 150 |
|
| 151 |
.. autoclass:: tox.session.env_select.EnvSelector |
| 152 |
:members: |
| 153 |
|
| 154 |
.. autoclass:: tox.tox_env.info.Info |
| 155 |
:members: |
| 156 |
|
| 157 |
testing |
| 158 |
======= |
| 159 |
|
| 160 |
.. automodule:: tox.pytest |
| 161 |
:no-members: |
| 162 |
|
| 163 |
.. autoclass:: tox.pytest.ToxProject |
| 164 |
:members: |
| 165 |
|
| 166 |
.. autoclass:: tox.pytest.ToxProjectCreator |
| 167 |
:members: |
| 168 |
|
| 169 |
.. autoclass:: tox.pytest.ToxRunOutcome |
| 170 |
:members: |