Add warning about implementing pytest_addoption from conftest files
This commit is contained in:
		
							parent
							
								
									06b1b69fb7
								
							
						
					
					
						commit
						ccf7584fac
					
				|  | @ -30,8 +30,15 @@ def pytest_plugin_registered(plugin, manager): | ||||||
| def pytest_addoption(parser): | def pytest_addoption(parser): | ||||||
|     """register argparse-style options and ini-style config values. |     """register argparse-style options and ini-style config values. | ||||||
| 
 | 
 | ||||||
|     This function must be implemented in a :ref:`plugin <pluginorder>` and is |     .. warning:: | ||||||
|     called once at the beginning of a test run. | 
 | ||||||
|  |         This function must be implemented in a :ref:`plugin <pluginorder>` | ||||||
|  |         and is called once at the beginning of a test run. | ||||||
|  | 
 | ||||||
|  |         Implementing this hook from ``conftest.py`` files is **strongly** | ||||||
|  |         discouraged because ``conftest.py`` files are lazily loaded and | ||||||
|  |         may give strange *unknown option* errors depending on the directory | ||||||
|  |         ``py.test`` is invoked from. | ||||||
| 
 | 
 | ||||||
|     :arg parser: To add command line options, call |     :arg parser: To add command line options, call | ||||||
|         :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`. |         :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`. | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue