Tidying up

Author: domdfcoding

domdf_python_tools/enums.py

@@ -30,7 +30,7 @@
 
 # class IntEnum(Enum):
 # 	"""
-# 	An Enum that can be converted into an integer
+# 	An Enum that can be converted into an integer.
 # 	"""
 #
 # 	def __int__(self):
@@ -45,7 +45,7 @@
 
 class StrEnum(str, Enum):
 	"""
-	An Enum that can be converted into a string
+	An Enum that can be converted into a string.
 	"""
 
 	def __str__(self) -> str:

domdf_python_tools/paths.py

@@ -2,7 +2,7 @@
 #
 #  paths.py
 """
-Functions for paths and files
+Functions for paths and files.
 """
 #
 #  Copyright © 2018-2020 Dominic Davis-Foster <[email protected]>
@@ -154,7 +154,7 @@ def maybe_make(directory: PathLike, mode=0o777, parents: bool = False, exist_ok:
 
 def parent_path(path: PathLike) -> pathlib.Path:
 	"""
-	Returns the path of the parent directory for the given file or directory
+	Returns the path of the parent directory for the given file or directory.
 
 	:param path: Path to find the parent for
 
@@ -169,7 +169,7 @@ def parent_path(path: PathLike) -> pathlib.Path:
 
 def read(filename: PathLike) -> str:
 	"""
-	Read a file in the current directory (in text mode)
+	Read a file in the current directory (in text mode).
 
 	.. warning::
 
@@ -225,7 +225,7 @@ def relpath(path: PathLike, relative_to: Optional[PathLike] = None) -> pathlib.P
 
 def write(var: str, filename: PathLike) -> None:
 	"""
-	Write a variable to file in the current directory
+	Write a variable to file in the current directory.
 
 	TODO: make this the file in the given directory, by default the current directory
 
@@ -239,7 +239,7 @@ def write(var: str, filename: PathLike) -> None:
 
 def clean_writer(string: str, fp: IO) -> None:
 	"""
-	Write string to ``fp`` without trailing spaces
+	Write string to ``fp`` without trailing spaces.
 
 	:param string:
 	:type string: str
@@ -256,7 +256,7 @@ def clean_writer(string: str, fp: IO) -> None:
 
 	for line in buffer:
 		fp.write(line)
-		fp.write("\n")
+		fp.write('\n')
 
 
 def make_executable(filename: PathLike) -> None:

tests/test_terminal_colours.py

@@ -120,7 +120,7 @@ def test_back_attributes(obj, expects, capsys):
 				(Style.BRIGHT, "\033[1m"),
 				]
 		)
-def test_back_attributes(obj, expects, capsys):
+def test_style_attributes(obj, expects, capsys):
 	assert obj == expects
 	assert obj("Hello World") == f"{obj}Hello World\033[22m"
 
@@ -138,9 +138,3 @@ def test_back_attributes(obj, expects, capsys):
 	assert stdout[2] == f"{obj}Coloured Again!"
 	assert stdout[3] == f"\033[22mReset Again!"
 	assert stdout[4] == ''
-
-
-def test_style_attributes():
-	assert Style.DIM == "\033[2m"
-	assert Style.NORMAL == "\033[22m"
-	assert Style.BRIGHT == "\033[1m"