Moving to pyproject.toml and complete type hints (#107)

* moving to pyproject.toml

* fixing mkdocs

* tweak pyproject.toml

* switch to hatch/hatchling

* linting

* revert removal of editable builds

* bump

* fix docs build

* lint plugins.py

* add history file

* complete type hints

* fix tests

* revert "str->as_str" name change

* tweak HISTORY

* tweak pyproject.toml

Author: samuelcolvin

.github/workflows/ci.yml

@@ -94,13 +94,10 @@ jobs:
           python-version: '3.10'
 
       - name: install
-        run: make install
-
-      - name: set version
-        run: VERSION_PATH='devtools/version.py' python <(curl -Ls https://git.io/JT3rm)
+        run: pip install -U build twine setuptools
 
       - name: build
-        run: python setup.py sdist bdist_wheel
+        run: python -m build
 
       - run: twine check dist/*
 

.gitignore

@@ -19,3 +19,4 @@ old-version/
 *.swp
 /site/
 /site.zip
+/build/

HISTORY.md

@@ -1,3 +1,11 @@
+## v0.8.0 (2021-09-29)
+
+* test with python 3.10 #91
+* display `SQLAlchemy` objects nicely #94
+* fix tests on windows #93
+* show function `qualname` #95
+* cache pygments loading (significant speedup) #96
+
 ## v0.7.0 (2021-09-03)
 
 * switch to [`executing`](https://pypi.org/project/executing/) and [`asttokens`](https://pypi.org/project/asttokens/) 
@@ -9,6 +17,10 @@
 * display `dataclasses` properly, #88
 * uprev test dependencies, #81, #83, #90
 
+## v0.6.1 (2020-10-22)
+
+compatibility with python 3.8.6
+
 ## v0.6.0 (2020-07-29)
 
 * improve `__pretty__` to work better with pydantic classes, #52

MANIFEST.in

@@ -1,6 +1,6 @@
 .DEFAULT_GOAL := all
-isort = isort devtools tests
-black = black -S -l 120 --target-version py37 devtools
+isort = isort devtools tests docs/plugins.py
+black = black -S -l 120 --target-version py37 devtools docs/plugins.py
 
 .PHONY: install
 install:
@@ -15,9 +15,10 @@ format:
 
 .PHONY: lint
 lint:
-	flake8 devtools/ tests/
+	flake8 --max-complexity 10 --max-line-length 120 --ignore E203,W503 devtools tests docs/plugins.py
 	$(isort) --check-only --df
 	$(black) --check --diff
+	mypy devtools
 
 .PHONY: test
 test:
@@ -50,12 +51,10 @@ clean:
 .PHONY: docs
 docs:
 	flake8 --max-line-length=80 docs/examples/
-	python docs/build/main.py
 	mkdocs build
 
 .PHONY: docs-serve
 docs-serve:
-	python docs/build/main.py
 	mkdocs serve
 
 .PHONY: publish-docs

Makefile

@@ -4,3 +4,5 @@
 from .prettier import *
 from .timer import *
 from .version import VERSION
+
+__version__ = VERSION

devtools/__init__.py

@@ -6,10 +6,10 @@
 
 MYPY = False
 if MYPY:
-    from typing import Any, Union
+    from typing import Any, Mapping, Union
 
 
-def strip_ansi(value):
+def strip_ansi(value: str) -> str:
     import re
 
     return re.sub('\033\\[((?:\\d|;)*)([a-zA-Z])', '', value)
@@ -62,7 +62,7 @@ class Style(IntEnum):
     # this is a meta value used for the "Style" instance which is the "style" function
     function = -1
 
-    def __call__(self, input: 'Any', *styles: 'Style', reset: bool = True, apply: bool = True) -> str:
+    def __call__(self, input: 'Any', *styles: 'Union[Style, int, str]', reset: bool = True, apply: bool = True) -> str:
         """
         Styles text with ANSI styles and returns the new string.
 
@@ -91,7 +91,7 @@ def __call__(self, input: 'Any', *styles: 'Style', reset: bool = True, apply: bo
                     s = self.styles[s]
                 except KeyError:
                     raise ValueError(f'invalid style "{s}"')
-            codes.append(_style_as_int(s.value))
+            codes.append(_style_as_int(s.value))  # type: ignore
 
         if codes:
             r = _as_ansi(';'.join(codes)) + text
@@ -103,16 +103,16 @@ def __call__(self, input: 'Any', *styles: 'Style', reset: bool = True, apply: bo
         return r
 
     @property
-    def styles(self):
+    def styles(self) -> 'Mapping[str, Style]':
         return self.__class__.__members__
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         if self == self.function:
             return '<pseudo function sformat(text, *styles)>'
         else:
             return super().__repr__()
 
-    def __str__(self):
+    def __str__(self) -> str:
         if self == self.function:
             return repr(self)
         else:
@@ -139,14 +139,22 @@ class StylePrint:
     for that mistake.
     """
 
-    def __call__(self, input, *styles, reset=True, flush=True, file=None, **print_kwargs):
+    def __call__(
+        self,
+        input: str,
+        *styles: 'Union[Style, int, str]',
+        reset: bool = True,
+        flush: bool = True,
+        file: 'Any' = None,
+        **print_kwargs: 'Any',
+    ) -> None:
         text = sformat(input, *styles, reset=reset, apply=isatty(file))
         print(text, flush=flush, file=file, **print_kwargs)
 
-    def __getattr__(self, item):
+    def __getattr__(self, item: str) -> str:
         return getattr(sformat, item)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return '<pseudo function sprint(text, *styles)>'
 
 

devtools/ansi.py

@@ -10,20 +10,22 @@
 MYPY = False
 if MYPY:
     from types import FrameType
-    from typing import Any, Generator, List, Optional
+    from typing import Any, Generator, List, Optional, Union
 
 pformat = PrettyFormat(
     indent_step=int(os.getenv('PY_DEVTOOLS_INDENT', 4)),
     simple_cutoff=int(os.getenv('PY_DEVTOOLS_SIMPLE_CUTOFF', 10)),
     width=int(os.getenv('PY_DEVTOOLS_WIDTH', 120)),
     yield_from_generators=env_true('PY_DEVTOOLS_YIELD_FROM_GEN', True),
 )
+# required for type hinting because I (stupidly) added methods called `str`
+StrType = str
 
 
 class DebugArgument:
     __slots__ = 'value', 'name', 'extra'
 
-    def __init__(self, value, *, name=None, **extra):
+    def __init__(self, value: 'Any', *, name: 'Optional[str]' = None, **extra: 'Any') -> None:
         self.value = value
         self.name = name
         self.extra = []
@@ -35,7 +37,7 @@ def __init__(self, value, *, name=None, **extra):
             self.extra.append(('len', length))
         self.extra += [(k, v) for k, v in extra.items() if v is not None]
 
-    def str(self, highlight=False) -> str:
+    def str(self, highlight: bool = False) -> StrType:
         s = ''
         if self.name and not is_literal(self.name):
             s = f'{sformat(self.name, sformat.blue, apply=highlight)}: '
@@ -54,7 +56,7 @@ def str(self, highlight=False) -> str:
             s += suffix
         return s
 
-    def __str__(self) -> str:
+    def __str__(self) -> StrType:
         return self.str()
 
 
@@ -66,14 +68,22 @@ class DebugOutput:
     arg_class = DebugArgument
     __slots__ = 'filename', 'lineno', 'frame', 'arguments', 'warning'
 
-    def __init__(self, *, filename: str, lineno: int, frame: str, arguments: 'List[DebugArgument]', warning=None):
+    def __init__(
+        self,
+        *,
+        filename: str,
+        lineno: int,
+        frame: str,
+        arguments: 'List[DebugArgument]',
+        warning: 'Union[None, str, bool]' = None,
+    ) -> None:
         self.filename = filename
         self.lineno = lineno
         self.frame = frame
         self.arguments = arguments
         self.warning = warning
 
-    def str(self, highlight=False) -> str:
+    def str(self, highlight: bool = False) -> StrType:
         if highlight:
             prefix = (
                 f'{sformat(self.filename, sformat.magenta)}:{sformat(self.lineno, sformat.green)} '
@@ -87,10 +97,10 @@ def str(self, highlight=False) -> str:
                 prefix += f' ({self.warning})'
         return f'{prefix}\n    ' + '\n    '.join(a.str(highlight) for a in self.arguments)
 
-    def __str__(self) -> str:
+    def __str__(self) -> StrType:
         return self.str()
 
-    def __repr__(self) -> str:
+    def __repr__(self) -> StrType:
         arguments = ' '.join(str(a) for a in self.arguments)
         return f'<DebugOutput {self.filename}:{self.lineno} {self.frame} arguments: {arguments}>'
 
@@ -102,7 +112,7 @@ def __init__(self, *, warnings: 'Optional[bool]' = None, highlight: 'Optional[bo
         self._show_warnings = env_bool(warnings, 'PY_DEVTOOLS_WARNINGS', True)
         self._highlight = highlight
 
-    def __call__(self, *args, file_=None, flush_=True, **kwargs) -> 'Any':
+    def __call__(self, *args: 'Any', file_: 'Any' = None, flush_: bool = True, **kwargs: 'Any') -> 'Any':
         d_out = self._process(args, kwargs)
         s = d_out.str(use_highlight(self._highlight, file_))
         print(s, file=file_, flush=flush_)
@@ -113,18 +123,18 @@ def __call__(self, *args, file_=None, flush_=True, **kwargs) -> 'Any':
         else:
             return args
 
-    def format(self, *args, **kwargs) -> DebugOutput:
+    def format(self, *args: 'Any', **kwargs: 'Any') -> DebugOutput:
         return self._process(args, kwargs)
 
-    def breakpoint(self):
+    def breakpoint(self) -> None:
         import pdb
 
         pdb.Pdb(skip=['devtools.*']).set_trace()
 
-    def timer(self, name=None, *, verbose=True, file=None, dp=3) -> Timer:
+    def timer(self, name: 'Optional[str]' = None, *, verbose: bool = True, file: 'Any' = None, dp: int = 3) -> Timer:
         return Timer(name=name, verbose=verbose, file=file, dp=dp)
 
-    def _process(self, args, kwargs) -> DebugOutput:
+    def _process(self, args: 'Any', kwargs: 'Any') -> DebugOutput:
         """
         BEWARE: this must be called from a function exactly 2 levels below the top of the stack.
         """
@@ -181,13 +191,13 @@ def _process(self, args, kwargs) -> DebugOutput:
             warning=self._show_warnings and warning,
         )
 
-    def _args_inspection_failed(self, args, kwargs):
+    def _args_inspection_failed(self, args: 'Any', kwargs: 'Any') -> 'Generator[DebugArgument, None, None]':
         for arg in args:
             yield self.output_class.arg_class(arg)
         for name, value in kwargs.items():
             yield self.output_class.arg_class(value, name=name)
 
-    def _process_args(self, ex, args, kwargs) -> 'Generator[DebugArgument, None, None]':
+    def _process_args(self, ex: 'Any', args: 'Any', kwargs: 'Any') -> 'Generator[DebugArgument, None, None]':
         import ast
 
         func_ast = ex.node