Tidying up and adding __all__s

domdfcoding · domdfcoding · commit 749438412705 · 2020-06-24T17:56:22.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -34,7 +34,6 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
-.coverage*
 *.mo
 *.pot
 *.log
diff --git a/domdf_python_tools/doctools.py b/domdf_python_tools/doctools.py
@@ -2,7 +2,7 @@
 #
 #  doctools.py
 """
-Utilities for documenting functions, classes and methods
+Utilities for documenting functions, classes and methods.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -36,7 +36,7 @@
 
 def deindent_string(string: str) -> str:
 	"""
-	Removes all indentation from the given string
+	Removes all indentation from the given string.
 
 	:param string: The string to deindent
 	:type string: str
diff --git a/domdf_python_tools/pagesizes/__init__.py b/domdf_python_tools/pagesizes/__init__.py
@@ -1,13 +1,12 @@
-#  !/usr/bin/env python
+#!/usr/bin/env python
 #
-#  pagesizes.py
+#  __init__.py
 """
-List of common pagesizes and some tools for working with them
+List of common pagesizes and some tools for working with them.
 
 This module defines a few common page sizes in points (1/72 inch).
 
-To be expanded to include things like label sizes, envelope windows
-etc.
+To be expanded to include things like label sizes, envelope windows etc.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
diff --git a/domdf_python_tools/pagesizes/classes.py b/domdf_python_tools/pagesizes/classes.py
@@ -310,46 +310,54 @@ class PageSize(BaseSize):
 
 	__slots__: List[str] = []
 
-	def __new__(cls, width, height, unit=pt):
+	def __new__(cls, width: AnyNumber, height: AnyNumber, unit: AnyNumber = pt):
+		"""
+		Create a new :class:`~domdf_python_tools.pagesizes.classes.PageSize` object.
+
+		:param width:
+		:param height:
+		:param unit:
+		"""
+
 		width, height = convert_from((width, height), unit)
 		return super().__new__(cls, width, height)
 
 	@property
 	def inch(self) -> Size_inch:
 		"""
-		Returns the pagesize in inches
+		Returns the pagesize in inches.
 		"""
 
 		return Size_inch.from_pt(self)
 
 	@property
 	def cm(self) -> Size_cm:
 		"""
-		Returns the pagesize in centimeters
+		Returns the pagesize in centimeters.
 		"""
 
 		return Size_cm.from_pt(self)
 
 	@property
 	def mm(self) -> Size_mm:
 		"""
-		Returns the pagesize in millimeters
+		Returns the pagesize in millimeters.
 		"""
 
 		return Size_mm.from_pt(self)
 
 	@property
 	def um(self) -> Size_um:
 		"""
-		Returns the pagesize in micrometers
+		Returns the pagesize in micrometers.
 		"""
 
 		return Size_um.from_pt(self)
 
 	@property
 	def pc(self) -> Size_pica:
 		"""
-		Returns the pagesize in pica
+		Returns the pagesize in pica.
 		"""
 
 		return Size_pica.from_pt(self)
@@ -359,7 +367,7 @@ def pc(self) -> Size_pica:
 	@property
 	def dd(self) -> Size_didot:
 		"""
-		Returns the pagesize in didots
+		Returns the pagesize in didots.
 		"""
 
 		return Size_didot.from_pt(self)
@@ -369,7 +377,7 @@ def dd(self) -> Size_didot:
 	@property
 	def cc(self) -> Size_cicero:
 		"""
-		Returns the pagesize in ciceros
+		Returns the pagesize in ciceros.
 		"""
 
 		return Size_cicero.from_pt(self)
@@ -379,7 +387,7 @@ def cc(self) -> Size_cicero:
 	@property
 	def nd(self) -> Size_new_didot:
 		"""
-		Returns the pagesize in new didots
+		Returns the pagesize in new didots.
 		"""
 
 		return Size_new_didot.from_pt(self)
@@ -389,7 +397,7 @@ def nd(self) -> Size_new_didot:
 	@property
 	def nc(self) -> Size_new_cicero:
 		"""
-		Returns the pagesize in new ciceros
+		Returns the pagesize in new ciceros.
 		"""
 
 		return Size_new_cicero.from_pt(self)
@@ -399,7 +407,7 @@ def nc(self) -> Size_new_cicero:
 	@property
 	def sp(self) -> Size_scaled_point:
 		"""
-		Returns the pagesize in scaled point
+		Returns the pagesize in scaled point.
 		"""
 
 		return Size_scaled_point.from_pt(self)
diff --git a/domdf_python_tools/pagesizes/sizes.py b/domdf_python_tools/pagesizes/sizes.py
@@ -35,6 +35,114 @@
 #  MA 02110-1301, USA.
 #
 
+__all__ = [
+		"_4A0",
+		"_2A0",
+		"A0",
+		"A1",
+		"A2",
+		"A3",
+		"A4",
+		"A5",
+		"A6",
+		"A7",
+		"A8",
+		"A9",
+		"A10",
+		"B0",
+		"B1",
+		"B2",
+		"B3",
+		"B4",
+		"B5",
+		"B6",
+		"B7",
+		"B8",
+		"B9",
+		"B10",
+		"C0",
+		"C1",
+		"C2",
+		"C3",
+		"C4",
+		"C5",
+		"C6",
+		"C7",
+		"C8",
+		"C9",
+		"C10",
+		"A2EXTRA",
+		"A3EXTRA",
+		"A3SUPER",
+		"SUPERA3",
+		"A4EXTRA",
+		"A4SUPER",
+		"SUPERA4",
+		"A4LONG",
+		"A5EXTRA",
+		"SOB5EXTRA",
+		"LETTER",
+		"LEGAL",
+		"TABLOID",
+		"ELEVENSEVENTEEN",
+		"JUNIOR_LEGAL",
+		"HALF_LETTER",
+		"GOV_LETTER",
+		"GOV_LEGAL",
+		"LEDGER",
+		"EMPEROR",
+		"QUAD_ROYAL",
+		"QUAD_DEMY",
+		"ANTIQUARIAN",
+		"GRAND_EAGLE",
+		"DOUBLE_ELEPHANT",
+		"ATLAS",
+		"DOUBLE_ROYAL",
+		"COLOMBIER",
+		"DOUBLE_DEMY_US",
+		"DOUBLE_DEMY",
+		"DOUBLE_DEMY_UK",
+		"IMPERIAL",
+		"DOUBLE_LARGE_POST",
+		"ELEPHANT",
+		"PRINCESS",
+		"CARTRIDGE",
+		"ROYAL",
+		"SHEET",
+		"HALF_POST",
+		"DOUBLE_POST",
+		"SUPER_ROYAL",
+		"BROADSHEET",
+		"MEDIUM_US",
+		"MEDIUM_UK",
+		"DEMY",
+		"COPY_DRAUGHT",
+		"LARGE_POST_US",
+		"LARGE_POST_UK",
+		"POST_US",
+		"POST_UK",
+		"CROWN",
+		"PINCHED_POST",
+		"FOOLSCAP_US",
+		"FOOLSCAP_UK",
+		"SMALL_FOOLSCAP",
+		"BRIEF",
+		"POTT",
+		"QUARTO_US",
+		"EXECUTIVE",
+		"MONARCH",
+		"FOLIO",
+		"FOOLSCAP_FOLIO",
+		"QUARTO",
+		"QUARTO_UK",
+		"KINGS",
+		"DUKES",
+		"ID_1",
+		"ID_2",
+		"ID_3",
+		"ID_000",
+		]
+
 # this package
 from .classes import Size_inch, Size_mm
 
diff --git a/domdf_python_tools/pagesizes/utils.py b/domdf_python_tools/pagesizes/utils.py
@@ -2,7 +2,7 @@
 #
 #  utils.py
 """
-Tools for working with pagesizes
+Tools for working with pagesizes.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -52,13 +52,12 @@ def convert_from(
 		from_: AnyNumber,
 		) -> Union[float, Tuple[float, ...]]:
 	"""
-	Convert ``value`` to point from the unit specified in ``from_``
+	Convert ``value`` to point from the unit specified in ``from_``.
 
 	:param value:
 	:param from_: The unit to convert from, specified as a number of points
 
 	:return:
-	:rtype:
 	"""
 
 	if isinstance(value, Sequence):
@@ -76,7 +75,16 @@ def _sequence_convert_from(seq: Sequence[AnyNumber], from_: AnyNumber) -> Tuple[
 _measurement_re = re.compile(r"(\d*\.?\d+) *([A-Za-z]*)")
 
 
-def parse_measurement(measurement):
+def parse_measurement(measurement: str) -> Union[float, Tuple[float, ...]]:
+	"""
+	Parse the given measurement.
+
+	:param measurement:
+	:type measurement: str
+
+	:return:
+	"""
+
 	# TODO: docstring
 	match = _measurement_re.findall(measurement)[0]
 	print(match)
@@ -115,7 +123,7 @@ def parse_measurement(measurement):
 
 def to_length(s):
 	"""
-	Convert a string to a length
+	Convert a string to a length.
 
 	:param s:
 	:type s:
diff --git a/domdf_python_tools/utils.py b/domdf_python_tools/utils.py
@@ -30,6 +30,26 @@
 import sys
 from typing import Any, Generator, Iterable, List, Sequence, Tuple, Union
 
+__all__ = [
+		"pyversion",
+		"as_text",
+		"check_dependencies",
+		"chunks",
+		"cmp",
+		"list2str",
+		"tuple2str",
+		"permutations",
+		"printr",
+		"printt",
+		"stderr_writer",
+		"printe",
+		"split_len",
+		"splitLen",
+		"str2tuple",
+		"strtobool",
+		"enquote_value",
+		]
+
 pyversion: int = int(sys.version_info.major)  # Python Version
 
 
diff --git a/tox.ini b/tox.ini
@@ -2,7 +2,7 @@
 
 # This file must be in the same dir as setup.py
 [tox]
-envlist = py36, py37, py38, pypy3, py39-dev,  docs, mypy
+envlist = py36, py37, py38, pypy3, py39-dev,  mypy
 skip_missing_interpreters = True
 requires = pip >= 19.0.0
 
@@ -11,7 +11,7 @@ requires = pip >= 19.0.0
 python =
     3.6: py36, mypy
     3.7: py37
-    3.8: py38, docs
+    3.8: py38
     pypy3: pypy3
     3.9-dev: py39-dev
 
@@ -133,7 +133,7 @@ commands = tox -e pyup,isort,yapf,mypy,lint {posargs}
 
 [flake8]
 max-line-length = 120
-select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 E101 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 PT001 PT002 PT003 PT004 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q000 Q001 Q002 Q003 W292 E265
+select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 E101 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 PT001 PT002 PT003 PT004 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q000 Q001 Q002 Q003 W292 E265 D100 D101 D102 D103 D104 D105 D106 D107 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417
 exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py
 rst-roles =
     class,
@@ -149,6 +149,8 @@ rst-directives =
     envvar,
     exception,
     seealso
+per-file-ignores =
+    tests/*: D100 D101 D102 D103 D104 D105 D106 D107 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417
 pytest-parametrize-names-type = csv
 inline-quotes = "
 multiline-quotes = """
