Linting.

Author: domdfcoding

domdf_python_tools/bases.py

@@ -380,17 +380,35 @@ def __init__(self, value: Union[SupportsFloat, _SupportsIndex, str, bytes, bytea
 		self._value = (float(value), )
 
 	def as_integer_ratio(self) -> Tuple[int, int]:
+		"""
+		Returns the float as a fraction.
+		"""
+
 		return float(self).as_integer_ratio()
 
-	def hex(self) -> str:
+	def hex(self) -> str:  # noqa: A003
+		"""
+		Returns the hexadecimal (base 16) representation of the float.
+		"""
+
 		return float(self).hex()
 
 	def is_integer(self) -> bool:
+		"""
+		Returns whether the float is an integer.
+		"""
+
 		return float(self).is_integer()
 
 	@classmethod
-	def fromhex(cls: Type[_F], __s: str) -> _F:
-		return cls(float.fromhex(__s))
+	def fromhex(cls: Type[_F], string: str) -> _F:
+		"""
+		Create a floating-point number from a hexadecimal string.
+
+		:param string:
+		"""
+
+		return cls(float.fromhex(string))
 
 	def __add__(self: _F, other: float) -> _F:
 		return self.__class__(float(self).__add__(other))

domdf_python_tools/pagesizes/classes.py

@@ -3,8 +3,6 @@
 #  classes.py
 """
 Classes representing pagesizes.
-
-.. |AnyNumber| replace:: :py:data:`~typing.Union` [:class:`int`, :class:`float`, :class:`~decimal.Decimal`, :class:`~domdf_python_tools.pagesizes.Unit`]
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>

domdf_python_tools/pagesizes/units.py

@@ -1,6 +1,9 @@
-#  !/usr/bin/env python
+#!/usr/bin/env python
 #
 #  units.py
+"""
+Provides a variety of units for use with pagesizes.
+"""
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 #

domdf_python_tools/terminal_colours.py

@@ -105,19 +105,19 @@
 style_stack: List[str] = []
 
 
-def code_to_chars(code) -> str:
+def code_to_chars(code) -> str:  # noqa: D103
 	return CSI + str(code) + 'm'
 
 
-def set_title(title: str) -> str:
+def set_title(title: str) -> str:  # noqa: D103
 	return OSC + "2;" + title + BEL
 
 
-def clear_screen(mode: int = 2) -> str:
+def clear_screen(mode: int = 2) -> str:  # noqa: D103
 	return CSI + str(mode) + 'J'
 
 
-def clear_line(mode: int = 2) -> str:
+def clear_line(mode: int = 2) -> str:  # noqa: D103
 	return CSI + str(mode) + 'K'
 
 
@@ -204,9 +204,15 @@ def __init__(self) -> None:
 
 
 class AnsiCursor:
+	"""
+	Provides methods to control the cursor.
+
+	.. TODO:: Add show and hide methods.
+	"""
 
 	def UP(self, n: int = 1) -> str:
 		"""
+		Moves the cursor up.
 
 		:param n:
 		"""
@@ -215,6 +221,7 @@ def UP(self, n: int = 1) -> str:
 
 	def DOWN(self, n: int = 1) -> str:
 		"""
+		Moves the cursor down.
 
 		:param n:
 		"""
@@ -223,6 +230,7 @@ def DOWN(self, n: int = 1) -> str:
 
 	def FORWARD(self, n: int = 1) -> str:
 		"""
+		Moves the cursor forward (right).
 
 		:param n:
 		"""
@@ -231,6 +239,7 @@ def FORWARD(self, n: int = 1) -> str:
 
 	def BACK(self, n: int = 1) -> str:
 		"""
+		Moves the cursor back (left).
 
 		:param n:
 		"""
@@ -239,6 +248,7 @@ def BACK(self, n: int = 1) -> str:
 
 	def POS(self, x: int = 1, y: int = 1) -> str:
 		"""
+		Sets the position of the cursor.
 
 		:param x:
 		:param y:

domdf_python_tools/testing.py

@@ -214,7 +214,7 @@ def testing_boolean_values(
 
 
 @lru_cache(1)
-def whitespace_perms_list() -> List[str]:
+def whitespace_perms_list() -> List[str]:  # noqa: D103
 	chain = itertools.chain.from_iterable(itertools.permutations(whitespace, n) for n in Len(whitespace))
 	return list(''.join(x) for x in chain)
 
@@ -393,7 +393,7 @@ def is_docker():
 	<class 'bool'>
 
 	.. versionadded:: 0.6.0
-	"""
+	"""  # noqa: D400
 
 	if os.path.exists("/.dockerenv"):
 		return True

repo_helper.yml

@@ -66,5 +66,6 @@ extra_sphinx_extensions:
 
 tox_unmanaged:
  - testenv
+ - flake8
 
 tox_testenv_extras: all

tox.ini

@@ -125,9 +125,14 @@ rst-directives =
     TODO
     envvar
     extras-require
+rst-roles = manpage
 per-file-ignores =
     tests/*: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
     */*.pyi: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
+    tests/list_tests.py: PT011 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
+    tests/test_paths_stdlib.py: PT011 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
+    tests/test_pretty_print.py: PT011 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
+    tests/seq_tests.py: PT011 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
 pytest-parametrize-names-type = csv
 inline-quotes = "
 multiline-quotes = """