Skip to content

Commit 57c9868

Browse files
committed
chore(test): pydocstyle manual fixes
1 parent 147ecc5 commit 57c9868

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/libtmux/test.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525

2626

2727
class RandomStrSequence:
28+
"""Factory to generate random string."""
29+
2830
def __init__(
2931
self, characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_"
3032
) -> None:
@@ -41,9 +43,11 @@ def __init__(
4143
self.characters: str = characters
4244

4345
def __iter__(self) -> "RandomStrSequence":
46+
"""Return self."""
4447
return self
4548

4649
def __next__(self) -> str:
50+
"""Return next random string."""
4751
return "".join(random.sample(self.characters, k=8))
4852

4953

@@ -308,18 +312,21 @@ def __init__(self) -> None:
308312
self._reset: t.Dict[str, str] = {}
309313

310314
def set(self, envvar: str, value: str) -> None:
315+
"""Set environment variable."""
311316
if envvar not in self._environ:
312317
self._unset.add(envvar)
313318
else:
314319
self._reset[envvar] = self._environ[envvar]
315320
self._environ[envvar] = value
316321

317322
def unset(self, envvar: str) -> None:
323+
"""Unset environment variable."""
318324
if envvar in self._environ:
319325
self._reset[envvar] = self._environ[envvar]
320326
del self._environ[envvar]
321327

322328
def __enter__(self) -> "EnvironmentVarGuard":
329+
"""Return context for for context manager."""
323330
return self
324331

325332
def __exit__(
@@ -328,6 +335,7 @@ def __exit__(
328335
exc_value: t.Optional[BaseException],
329336
exc_tb: t.Optional[types.TracebackType],
330337
) -> None:
338+
"""Cleanup to run after context manager finishes."""
331339
for envvar, value in self._reset.items():
332340
self._environ[envvar] = value
333341
for unset in self._unset:

0 commit comments

Comments
 (0)