Further document cygpath test parameter collections

EliahKagan · EliahKagan · commit 2fabe71b7ba6 · 2023-11-28T23:05:37.000-05:00
diff --git a/test/test_util.py b/test/test_util.py
@@ -258,14 +258,15 @@ def _xfail_param(*values, **xfail_kwargs):
     (R"D:/Apps\fOO", "/cygdrive/d/Apps/fOO"),
     (R"D:\Apps/123", "/cygdrive/d/Apps/123"),
 )
+"""Path test cases for cygpath and decygpath, other than extended UNC paths."""
 
 _unc_cygpath_pairs = (
     (R"\\?\a:\com", "/cygdrive/a/com"),
     (R"\\?\a:/com", "/cygdrive/a/com"),
     (R"\\?\UNC\server\D$\Apps", "//server/D$/Apps"),
 )
+"""Extended UNC path test cases for cygpath."""
 
-# Mapping of expected failures for the test_cygpath_ok test.
 _cygpath_ok_xfails = {
     # From _norm_cygpath_pairs:
     (R"C:\Users", "/cygdrive/c/Users"): "/proc/cygdrive/c/Users",
@@ -279,9 +280,9 @@ def _xfail_param(*values, **xfail_kwargs):
     (R"\\?\a:\com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",
     (R"\\?\a:/com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",
 }
+"""Mapping of expected failures for the test_cygpath_ok test."""
 
 
-# Parameter sets for the test_cygpath_ok test.
 _cygpath_ok_params = [
     (
         _xfail_param(*case, reason=f"Returns: {_cygpath_ok_xfails[case]!r}", raises=AssertionError)
@@ -290,6 +291,7 @@ def _xfail_param(*values, **xfail_kwargs):
     )
     for case in _norm_cygpath_pairs + _unc_cygpath_pairs
 ]
+"""Parameter sets for the test_cygpath_ok test."""
 
 
 @pytest.mark.skipif(sys.platform != "cygwin", reason="Paths specifically for Cygwin.")

Original file line number	Diff line number	Diff line change
`@@ -258,14 +258,15 @@ def _xfail_param(values, *xfail_kwargs):`
`258`	`258`	`(R"D:/Apps\fOO", "/cygdrive/d/Apps/fOO"),`
`259`	`259`	`(R"D:\Apps/123", "/cygdrive/d/Apps/123"),`
`260`	`260`	`)`
	`261`	`+"""Path test cases for cygpath and decygpath, other than extended UNC paths."""`
`261`	`262`
`262`	`263`	`_unc_cygpath_pairs = (`
`263`	`264`	`(R"\\?\a:\com", "/cygdrive/a/com"),`
`264`	`265`	`(R"\\?\a:/com", "/cygdrive/a/com"),`
`265`	`266`	`(R"\\?\UNC\server\D$\Apps", "//server/D$/Apps"),`
`266`	`267`	`)`
	`268`	`+"""Extended UNC path test cases for cygpath."""`
`267`	`269`
`268`		`-# Mapping of expected failures for the test_cygpath_ok test.`
`269`	`270`	`_cygpath_ok_xfails = {`
`270`	`271`	`# From _norm_cygpath_pairs:`
`271`	`272`	`(R"C:\Users", "/cygdrive/c/Users"): "/proc/cygdrive/c/Users",`
`@@ -279,9 +280,9 @@ def _xfail_param(values, *xfail_kwargs):`
`279`	`280`	`(R"\\?\a:\com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",`
`280`	`281`	`(R"\\?\a:/com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",`
`281`	`282`	`}`
	`283`	`+"""Mapping of expected failures for the test_cygpath_ok test."""`
`282`	`284`
`283`	`285`
`284`		`-# Parameter sets for the test_cygpath_ok test.`
`285`	`286`	`_cygpath_ok_params = [`
`286`	`287`	`(`
`287`	`288`	`_xfail_param(*case, reason=f"Returns: {_cygpath_ok_xfails[case]!r}", raises=AssertionError)`
`@@ -290,6 +291,7 @@ def _xfail_param(values, *xfail_kwargs):`
`290`	`291`	`)`
`291`	`292`	`for case in _norm_cygpath_pairs + _unc_cygpath_pairs`
`292`	`293`	`]`
	`294`	`+"""Parameter sets for the test_cygpath_ok test."""`
`293`	`295`
`294`	`296`
`295`	`297`	`@pytest.mark.skipif(sys.platform != "cygwin", reason="Paths specifically for Cygwin.")`