Linting.

Author: domdfcoding

.pre-commit-config.yaml

@@ -58,7 +58,7 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/domdfcoding/yapf-isort
-   rev: v0.4.4
+   rev: v0.5.1
    hooks:
     - id: yapf-isort
       exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$

doc-source/patched_autosummary.py

@@ -26,10 +26,10 @@ def import_by_name(self, name: str, prefixes: List[str]) -> Tuple[str, Any, Any,
 
 
 def setup(app: Sphinx) -> Dict[str, Any]:
-	app.setup_extension('sphinx.ext.autosummary')
-	app.add_directive('autosummary', PatchedAutosummary, override=True)
+	app.setup_extension("sphinx.ext.autosummary")
+	app.add_directive("autosummary", PatchedAutosummary, override=True)
 
 	return {
-			'version': f"{sphinx.__display_version__}-patched-autosummary-0",
-			'parallel_read_safe': True,
+			"version": f"{sphinx.__display_version__}-patched-autosummary-0",
+			"parallel_read_safe": True,
 			}

domdf_python_tools/doctools.py

@@ -37,7 +37,7 @@
 from domdf_python_tools.typing import MethodDescriptorType, MethodWrapperType, WrapperDescriptorType
 
 __all__ = [
-		"F",
+		'F',
 		"deindent_string",
 		"document_object_from_another",
 		"append_doctring_from_another",
@@ -65,9 +65,9 @@ def deindent_string(string: Optional[str]) -> str:
 		# Short circuit if empty string or None
 		return ''
 
-	split_string = string.split("\n")
+	split_string = string.split('\n')
 	deindented_string = [line.lstrip("\t ") for line in split_string]
-	return "\n".join(deindented_string)
+	return '\n'.join(deindented_string)
 
 
 # Functions that do the work

domdf_python_tools/paths.py

@@ -358,7 +358,7 @@ def write_clean(
 		.. versionadded:: 0.3.8
 		"""
 
-		with self.open("w", encoding=encoding, errors=errors) as fp:
+		with self.open('w', encoding=encoding, errors=errors) as fp:
 			clean_writer(string, fp)
 
 	def maybe_make(
@@ -411,7 +411,7 @@ def append_text(
 		.. versionadded:: 0.3.8
 		"""
 
-		with self.open("a", encoding=encoding, errors=errors) as fp:
+		with self.open('a', encoding=encoding, errors=errors) as fp:
 			fp.write(string)
 
 	def write_text(
@@ -450,7 +450,7 @@ def write_lines(
 		.. versionadded:: 0.5.0
 		"""  # noqa D400
 
-		return self.write_clean("\n".join(data), encoding=encoding, errors=errors)
+		return self.write_clean('\n'.join(data), encoding=encoding, errors=errors)
 
 	def read_text(
 			self,
@@ -487,11 +487,11 @@ def read_lines(
 		.. versionadded:: 0.5.0
 		"""  # noqa D400
 
-		return self.read_text(encoding=encoding, errors=errors).split("\n")
+		return self.read_text(encoding=encoding, errors=errors).split('\n')
 
 	def open(  # type: ignore  # noqa A003
 		self,
-		mode: str = "r",
+		mode: str = 'r',
 		buffering: int = -1,
 		encoding: Optional[str] = "UTF-8",
 		errors: Optional[str] = None,
@@ -524,7 +524,7 @@ def open(  # type: ignore  # noqa A003
 			if 'r' in mode:
 				newline = None
 			else:
-				newline = "\n"
+				newline = '\n'
 
 		return super().open(
 				mode,

domdf_python_tools/stringlist.py

@@ -48,7 +48,7 @@ class Indent:
 	:param type: The indent character.
 	"""
 
-	def __init__(self, size: int = 0, type: str = "\t"):  # noqa A002  # pylint: disable=redefined-builtin
+	def __init__(self, size: int = 0, type: str = '\t'):  # noqa A002  # pylint: disable=redefined-builtin
 		self.size = int(size)
 		self.type = str(type)
 
@@ -134,18 +134,18 @@ class StringList(List[str]):
 
 	def __init__(self, iterable: Iterable[String] = (), convert_indents: bool = False) -> None:
 		if isinstance(iterable, str):
-			iterable = iterable.split("\n")
+			iterable = iterable.split('\n')
 
 		self.indent = Indent()
 		self.convert_indents = convert_indents
 		super().__init__([self._make_line(str(x)) for x in iterable])
 
 	def _make_line(self, line: str) -> str:
 		if not str(self.indent_type).strip(" \t") and self.convert_indents:
-			if self.indent_type == "\t":
-				line = convert_indents(line, tab_width=1, from_="    ", to="\t")
+			if self.indent_type == '\t':
+				line = convert_indents(line, tab_width=1, from_="    ", to='\t')
 			else:  # pragma: no cover
-				line = convert_indents(line, tab_width=1, from_="\t", to=self.indent_type)
+				line = convert_indents(line, tab_width=1, from_='\t', to=self.indent_type)
 
 		return f"{self.indent}{line}".rstrip()
 
@@ -156,7 +156,7 @@ def append(self, line: String) -> None:
 		:param line:
 		"""
 
-		for inner_line in str(line).split("\n"):
+		for inner_line in str(line).split('\n'):
 			super().append(self._make_line(inner_line))
 
 	def extend(self, iterable: Iterable[String]) -> None:
@@ -199,9 +199,9 @@ def insert(self, index: int, line: String) -> None:
 		lines: List[str]
 
 		if index < 0 or index > len(self):
-			lines = str(line).split("\n")
+			lines = str(line).split('\n')
 		else:
-			lines = cast(list, reversed(str(line).split("\n")))
+			lines = cast(list, reversed(str(line).split('\n')))
 
 		for inner_line in lines:
 			super().insert(index, self._make_line(inner_line))
@@ -278,7 +278,7 @@ def set_indent_size(self, size: int = 0):
 
 		self.indent.size = int(size)
 
-	def set_indent_type(self, indent_type: str = "\t"):
+	def set_indent_type(self, indent_type: str = '\t'):
 		"""
 		Sets the type of the indent to insert at the beginning of new lines.
 
@@ -340,7 +340,7 @@ def __str__(self) -> str:
 		Returns the :class:`~domdf_python_tools.stringlist.StringList` as a string.
 		"""
 
-		return "\n".join(self)
+		return '\n'.join(self)
 
 	def __eq__(self, other) -> bool:
 		"""
@@ -398,7 +398,7 @@ def with_indent_size(self, size: int = 0):
 			self.indent_size = original_indent_size
 
 	@contextmanager
-	def with_indent_type(self, indent_type: str = "\t"):
+	def with_indent_type(self, indent_type: str = '\t'):
 		"""
 		Context manager to temporarily use a different indent type.
 

domdf_python_tools/terminal.py

@@ -88,7 +88,7 @@ def clear() -> None:
 	if os.name == "nt":  # pragma: no cover (!Windows)
 		os.system("cls")  # nosec: B607,B605
 	else:  # pragma: no cover (!Linux)
-		print("\033c", end='')
+		print("\u001bc", end='')
 
 
 def br() -> None:
@@ -170,7 +170,7 @@ class Echo:
 	:param indent: The indentation of the dictionary of variable assignments.
 	"""
 
-	def __init__(self, indent: str = " " * 2):
+	def __init__(self, indent: str = ' ' * 2):
 		self.indent = indent
 
 		frame = inspect.currentframe()

domdf_python_tools/utils.py

@@ -276,7 +276,7 @@ def posargs2kwargs(
 	return kwargs
 
 
-def convert_indents(text: str, tab_width: int = 4, from_: str = "\t", to: str = " ") -> str:
+def convert_indents(text: str, tab_width: int = 4, from_: str = '\t', to: str = ' ') -> str:
 	r"""
 	Convert indentation at the start of lines in ``text`` from tabs to spaces.
 
@@ -299,7 +299,7 @@ def convert_indents(text: str, tab_width: int = 4, from_: str = "\t", to: str =
 
 		output.append(f"{tab * indent_count}{line}")
 
-	return "\n".join(output)
+	return '\n'.join(output)
 
 
 class _Etcetera(str):
@@ -451,7 +451,7 @@ def _function_wrapper(function):
 		existing_docstring = function.__doc__ or ''
 
 		# split docstring at first occurrence of newline
-		string_list = existing_docstring.split("\n", 1)
+		string_list = existing_docstring.split('\n', 1)
 
 		if should_warn:
 			# The various parts of this decorator being optional makes for
@@ -495,7 +495,7 @@ def _function_wrapper(function):
 				string_list[1] = textwrap.dedent(string_list[1])
 
 				# we need another newline
-				string_list.insert(loc, "\n")
+				string_list.insert(loc, '\n')
 
 				# change the message_location if we add to end of docstring
 				# do this always if not "top"

domdf_python_tools/versions.py

@@ -102,14 +102,14 @@ def __str__(self) -> str:
 		Return version as a string.
 		"""
 
-		return "v" + ".".join(str(x) for x in self)  # pylint: disable=not-an-iterable
+		return 'v' + '.'.join(str(x) for x in self)  # pylint: disable=not-an-iterable
 
 	def __float__(self) -> float:
 		"""
 		Return the major and minor version number as a float.
 		"""
 
-		return float(".".join(str(x) for x in self[:2]))
+		return float('.'.join(str(x) for x in self[:2]))
 
 	def __int__(self) -> int:
 		"""

domdf_python_tools/words.py

@@ -500,7 +500,7 @@ def word_join(
 		iterable: Iterable[str],
 		use_repr: bool = False,
 		oxford: bool = False,
-		delimiter: str = ",",
+		delimiter: str = ',',
 		connective: str = "and",
 		) -> str:
 	"""
@@ -540,21 +540,21 @@ def word_join(
 			return delimiter.join(words[:-1]) + f" {connective} {words[-1]}"
 
 
-TAB = "\t"
+TAB = '\t'
 """
 A literal ``TAB`` (``\\t``) character for use in f-strings.
 
 .. versionadded:: 1.3.0
 """
 
-CR = "\r"
+CR = '\r'
 """
 The carriage return character (``\\r``) for use in f-strings.
 
 .. versionadded:: 1.3.0
 """
 
-LF = "\r"
+LF = '\r'
 """
 The newline character (``\\n``) for use in f-strings.
 

tests/conftest.py

@@ -11,4 +11,4 @@
 @pytest.fixture()
 def original_datadir(request) -> Path:
 	# Work around pycharm confusing datadir with test file.
-	return Path(os.path.splitext(request.module.__file__)[0] + "_")
+	return Path(os.path.splitext(request.module.__file__)[0] + '_')