code cleanup (tox-dev#705)

* remove trailing list/tuple commas * improve initproj() docstring

Author: jurko-gospodnetic

tests/test_config.py

@@ -95,7 +95,7 @@ def test_force_dep_version(self, initproj):
  assert config.option.force_dep == [
  'dep1==1.5', 'dep2==2.1', 'dep3==3.0']
  assert [str(x) for x in config.envconfigs['python'].deps] == [
- 'dep1==1.5', 'dep2==2.1', 'dep3==3.0', 'dep4==4.0',
+ 'dep1==1.5', 'dep2==2.1', 'dep3==3.0', 'dep4==4.0'
  ]
 
  def test_force_dep_with_url(self, initproj):
@@ -313,7 +313,7 @@ def test_command_substitution_from_other_section_multiline(self, newconfig):
  "cmd2 param21 param22".split(),
  "cmd1 param11 param12".split(),
  "cmd2 param21 param22".split(),
- ["echo", "cmd", "1", "2", "3", "4", "cmd", "2"],
+ ["echo", "cmd", "1", "2", "3", "4", "cmd", "2"]
  ]
 
  def test_command_substitution_from_other_section_posargs(self, newconfig):
@@ -1137,7 +1137,7 @@ def test_substitution_notfound_issue515(tmpdir, newconfig):
  """)
  conf = config.envconfigs['standard-greeting']
  assert conf.commands == [
- ['python', '-c', 'print("Hello, world!")'],
+ ['python', '-c', 'print("Hello, world!")']
  ]
 
  def test_substitution_nested_env_defaults(tmpdir, newconfig, monkeypatch):
@@ -1268,7 +1268,7 @@ def test_rewrite_simple_posargs(self, tmpdir, newconfig):
 
  @pytest.mark.parametrize('envlist, deps', [
  (['py27'], ('pytest', 'pytest-cov')),
- (['py27', 'py34'], ('pytest', 'py{27,34}: pytest-cov')),
+ (['py27', 'py34'], ('pytest', 'py{27,34}: pytest-cov'))
  ])
  def test_take_dependencies_from_other_testenv(
  self,
@@ -2078,7 +2078,7 @@ def test_help(self, cmd):
  result = cmd.run("tox", "-h")
  assert not result.ret
  result.stdout.fnmatch_lines([
- "*help*",
+ "*help*"
  ])
 
  def test_version_simple(self, cmd):
@@ -2151,7 +2151,7 @@ def test_listenvs(self, cmd, initproj):
 
  [testenv:docs]
  changedir = docs
- ''',
+ '''
  })
  result = cmd.run("tox", "-l")
  result.stdout.fnmatch_lines("""
@@ -2181,7 +2181,7 @@ def test_listenvs_verbose_description(self, cmd, initproj):
  [testenv:docs]
  changedir = docs
  description = let me overwrite that
- ''',
+ '''
  })
  result = cmd.run("tox", "-lv")
  result.stdout.fnmatch_lines("""
@@ -2204,7 +2204,7 @@ def test_listenvs_all(self, cmd, initproj):
 
  [testenv:docs]
  changedir = docs
- ''',
+ '''
  })
  result = cmd.run("tox", "-a")
  result.stdout.fnmatch_lines("""
@@ -2231,7 +2231,7 @@ def test_listenvs_all_verbose_description(self, cmd, initproj):
 
  [testenv:docs]
  changedir = docs
- ''',
+ '''
  })
  result = cmd.run("tox", "-av")
  result.stdout.fnmatch_lines("""
@@ -2250,7 +2250,7 @@ def test_listenvs_all_verbose_description_no_additional_environments(self, cmd,
  'tox.ini': '''
  [tox]
  envlist=py27,py36
- ''',
+ '''
  })
  result = cmd.run("tox", "-av")
  result.stdout.fnmatch_lines("""
@@ -2265,15 +2265,15 @@ def test_config_specific_ini(self, tmpdir, cmd):
  result = cmd.run("tox", "-c", ini, "--showconfig")
  assert not result.ret
  result.stdout.fnmatch_lines([
- "*config-file*hello.ini*",
+ "*config-file*hello.ini*"
  ])
 
  def test_no_tox_ini(self, cmd, initproj):
  initproj("noini-0.5")
  result = cmd.run("tox")
  assert result.ret
  result.stderr.fnmatch_lines([
- "*ERROR*tox.ini*not*found*",
+ "*ERROR*tox.ini*not*found*"
  ])
 
  def test_override_workdir(self, tmpdir, cmd, initproj):
@@ -2283,7 +2283,7 @@ def test_override_workdir(self, tmpdir, cmd, initproj):
  'tox.ini': '''
  [tox]
  toxworkdir=%s
- ''' % baddir,
+ ''' % baddir
  })
  result = cmd.run("tox", "--workdir", gooddir, "--showconfig")
  assert not result.ret
@@ -2302,19 +2302,19 @@ def test_showconfig_with_force_dep_version(self, cmd, initproj):
  deps=
  dep1==2.3
  dep2
- ''',
+ '''
  })
  result = cmd.run("tox", "--showconfig")
  assert result.ret == 0
  result.stdout.fnmatch_lines([
- r'*deps*dep1==2.3, dep2*',
+ r'*deps*dep1==2.3, dep2*'
  ])
  # override dep1 specific version, and force version for dep2
  result = cmd.run("tox", "--showconfig", "--force-dep=dep1",
  "--force-dep=dep2==5.0")
  assert result.ret == 0
  result.stdout.fnmatch_lines([
- r'*deps*dep1, dep2==5.0*',
+ r'*deps*dep1, dep2==5.0*'
  ])
 
  @pytest.mark.xfail(
@@ -2328,7 +2328,7 @@ def test_colon_symbol_in_directory_name(self, cmd, initproj):
 
  [testenv]
  commands = pip --version
- ''',
+ '''
  })
  result = cmd.run("tox")
  assert result.ret == 0
@@ -2374,7 +2374,7 @@ def test_command_parser_with_complex_word_set(self):
  'word', ' ', '[]', ' ', '[literal]', ' ', '{something}', ' ', '{some:other thing}',
  ' ', 'w', '{ord}', ' ', 'w', '{or}', 'd', ' ', 'w', '{ord}', ' ', 'w', '{o:rd}', ' ',
  'w', '{o:r}', 'd', ' ', '{w:or}', 'd',
- ' ', 'w[]ord', ' ', '{posargs:{a key}}',
+ ' ', 'w[]ord', ' ', '{posargs:{a key}}'
  ]
 
  assert parsed == expected

tox/_pytestplugin.py

@@ -291,7 +291,30 @@ def fnmatch_lines(self, lines2):
 
 @pytest.fixture
 def initproj(request, tmpdir):
- """ create a factory function for creating example projects. """
+ """Create a factory function for creating example projects
+
+ Constructed folder/file hierarchy examples:
+
+ with `src_root` other than `.`:
+
+ tmpdir/
+ name/ # base
+ src_root/ # src_root
+ name/ # package_dir
+ __init__.py
+ name.egg-info/ # created later on package build
+ setup.py
+
+ with `src_root` given as `.`:
+
+ tmpdir/
+ name/ # base, src_root
+ name/ # package_dir
+ __init__.py
+ name.egg-info/ # created later on package build
+ setup.py
+
+ """
  def initproj(nameversion, filedefs=None, src_root="."):
  if filedefs is None:
  filedefs = {}