Apply black.

Author: ionelmc

.cookiecutterrc

@@ -27,7 +27,7 @@ default_context:
     linter: flake8
     package_name: hunter
     pre_commit: 'yes'
-    pre_commit_formatter: black
+    pre_commit_formatter: blue
     project_name: Hunter
     project_short_description: Hunter is a flexible code tracing toolkit, not for measuring coverage, but for debugging, logging, inspection and other nefarious purposes. It has a simple Python API and a convenient terminal API (see `Environment variable activation <env-var-activation_>`_).
     pypi_badge: 'yes'

.pre-commit-config.yaml

@@ -12,18 +12,29 @@ repos:
     rev: v4.3.0
     hooks:
       - id: trailing-whitespace
+        exclude_types:
+          - c
       - id: end-of-file-fixer
+        exclude_types:
+          - c
       - id: double-quote-string-fixer
         exclude: '^tests/'
       - id: mixed-line-ending
         args: [--fix=lf]
+      - id: debug-statements
+        exclude: '^tests/sample*|src/hunter/actions.py'
   - repo: https://github.com/timothycrosley/isort
     rev: 5.10.1
     hooks:
       - id: isort
         types: [python]
       - id: isort
         types: [cython]
+  - repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+      - id: black
+        types: [python]
   - repo: https://gitlab.com/pycqa/flake8
     rev: 3.9.2
     hooks:

ci/bootstrap.py

@@ -69,7 +69,10 @@ def main():
         # This uses sys.executable the same way that the call in
         # cookiecutter-pylibrary/hooks/post_gen_project.py
         # invokes this bootstrap.py itself.
-        for line in subprocess.check_output([sys.executable, '-m', 'tox', '--listenvs'], universal_newlines=True).splitlines()
+        for line in subprocess.check_output(
+            [sys.executable, '-m', 'tox', '--listenvs'],
+            universal_newlines=True,
+        ).splitlines()
     ]
     tox_environments = [line for line in tox_environments if line.startswith('py')]
 

docs/conf.py

@@ -28,6 +28,7 @@
 copyright = '{0}, {1}'.format(year, author)
 try:
     from pkg_resources import get_distribution
+
     version = release = get_distribution('hunter').version
 except Exception:
     traceback.print_exc()
@@ -41,9 +42,7 @@
 }
 html_theme = 'sphinx_py3doc_enhanced_theme'
 html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
-html_theme_options = {
-    'githuburl': 'https://github.com/ionelmc/python-hunter/'
-}
+html_theme_options = {'githuburl': 'https://github.com/ionelmc/python-hunter/'}
 
 html_use_smartypants = True
 html_last_updated_fmt = '%b %d, %Y'

pyproject.toml

@@ -5,6 +5,11 @@ requires = [
     "setuptools_scm>=3.3.1,!=4.0.0",
 ]
 
+[tool.black]
+line-length = 140
+target-version = ['py37']
+skip-string-normalization = true
+
 [tool.ipdb]
 
 [tool.tbump]

setup.cfg

@@ -1,6 +1,7 @@
 [flake8]
 max-line-length = 140
 exclude = .tox,.eggs,ci/templates,build,dist,tests,src/hunter/vendor
+ignore = E203,W503
 
 [tool:isort]
 force_single_line = True

setup.py

@@ -36,7 +36,7 @@
 def read(*names, **kwargs):
     with io.open(
         join(dirname(__file__), *names),
-        encoding=kwargs.get('encoding', 'utf8')
+        encoding=kwargs.get('encoding', 'utf8'),
     ) as fh:
         return fh.read()
 
@@ -79,6 +79,7 @@ def run(self):
 
 class OptionalBuildExt(build_ext):
     """Allow the building of C extensions to fail."""
+
     def run(self):
         try:
             if os.environ.get('SETUPPY_FORCE_PURE'):
@@ -90,12 +91,14 @@ def run(self):
 
     def _unavailable(self, e):
         print('*' * 80)
-        print('''WARNING:
+        print(
+            """WARNING:
 
     An optional code optimization (C extension) could not be compiled.
 
     Optimizations for this package will not be available!
-        ''')
+        """
+        )
 
         print('CAUSE:')
         print('')
@@ -105,6 +108,7 @@ def _unavailable(self, e):
 
 class BinaryDistribution(Distribution):
     """Distribution which almost always forces a binary package with platform name"""
+
     def has_ext_modules(self):
         return super().has_ext_modules() or not os.environ.get('SETUPPY_ALLOW_PURE')
 
@@ -118,9 +122,10 @@ def has_ext_modules(self):
     },
     license='BSD-2-Clause',
     description='Hunter is a flexible code tracing toolkit.',
-    long_description='%s\n%s' % (
+    long_description='%s\n%s'
+    % (
         re.compile('^.. start-badges.*^.. end-badges', re.M | re.S).sub('', read('README.rst')),
-        re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst'))
+        re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst')),
     ),
     author='Ionel Cristian Mărieș',
     author_email='contact@ionelmc.ro',
@@ -155,18 +160,25 @@ def has_ext_modules(self):
         'Issue Tracker': 'https://github.com/ionelmc/python-hunter/issues',
     },
     keywords=[
-        'trace', 'tracer', 'settrace', 'debugger', 'debugging', 'code', 'source'
+        'trace',
+        'tracer',
+        'settrace',
+        'debugger',
+        'debugging',
+        'code',
+        'source',
     ],
     python_requires='>=3.7',
-    install_requires=[
-    ],
+    install_requires=[],
     extras_require={
         ':platform_system != "Windows"': ['manhole >= 1.5'],
     },
     setup_requires=[
         'setuptools_scm>=3.3.1,!=4.0.0',
         'cython',
-    ] if Cython else [
+    ]
+    if Cython
+    else [
         'setuptools_scm>=3.3.1,!=4.0.0',
     ],
     entry_points={
@@ -181,12 +193,14 @@ def has_ext_modules(self):
         'develop': DevelopWithPTH,
         'build_ext': OptionalBuildExt,
     },
-    ext_modules=[] if hasattr(sys, 'pypy_version_info') else [
+    ext_modules=[]
+    if hasattr(sys, 'pypy_version_info')
+    else [
         Extension(
             splitext(relpath(path, 'src').replace(os.sep, '.'))[0],
             sources=[path],
             extra_compile_args=os.environ.get('SETUPPY_CFLAGS', '').split(),
-            include_dirs=[dirname(path)]
+            include_dirs=[dirname(path)],
         )
         for root, _, _ in os.walk('src')
         for path in glob(join(root, '*.pyx' if Cython else '*.c'))

src/hunter/__init__.py

@@ -64,14 +64,19 @@
     'VarsPrinter',
     'VarsSnooper',
     'When',
-
     'stop',
     'trace',
 )
 THREADING_SUPPORT_ALIASES = (
-    'threading_support', 'threads_support', 'thread_support',
-    'threadingsupport', 'threadssupport', 'threadsupport',
-    'threading', 'threads', 'thread',
+    'threading_support',
+    'threads_support',
+    'thread_support',
+    'threadingsupport',
+    'threadssupport',
+    'threadsupport',
+    'threading',
+    'threads',
+    'thread',
 )
 TRACER_OPTION_NAMES = THREADING_SUPPORT_ALIASES + (
     'clear_env_var',
@@ -86,25 +91,28 @@
 def _embed_via_environment():
     if 'PYTHONHUNTER' in os.environ:
         try:
-            eval('trace({[PYTHONHUNTER]})'.format(os.environ), {
-                'And': And,
-                'Backlog': Backlog,
-                'CallPrinter': CallPrinter,
-                'CodePrinter': CodePrinter,
-                'Debugger': Debugger,
-                'ErrorSnooper': ErrorSnooper,
-                'From': From,
-                'Manhole': Manhole,
-                'Not': Not,
-                'Or': Or,
-                'Q': Q,
-                'Query': Query,
-                'StackPrinter': StackPrinter,
-                'VarsPrinter': VarsPrinter,
-                'VarsSnooper': VarsSnooper,
-                'When': When,
-                'trace': trace,
-            })
+            eval(
+                'trace({[PYTHONHUNTER]})'.format(os.environ),
+                {
+                    'And': And,
+                    'Backlog': Backlog,
+                    'CallPrinter': CallPrinter,
+                    'CodePrinter': CodePrinter,
+                    'Debugger': Debugger,
+                    'ErrorSnooper': ErrorSnooper,
+                    'From': From,
+                    'Manhole': Manhole,
+                    'Not': Not,
+                    'Or': Or,
+                    'Q': Q,
+                    'Query': Query,
+                    'StackPrinter': StackPrinter,
+                    'VarsPrinter': VarsPrinter,
+                    'VarsSnooper': VarsSnooper,
+                    'When': When,
+                    'trace': trace,
+                },
+            )
         except Exception as exc:
             sys.stderr.write('Failed to load hunter from PYTHONHUNTER environ variable {[PYTHONHUNTER]!r}: {!r}\n'.format(os.environ, exc))
 
@@ -142,14 +150,12 @@ def _prepare_config(*args, **kwargs):
             continue
 
         _default_config.pop(key)
-        sys.stderr.write('Discarded config from PYTHONHUNTERCONFIG {}={!r}: Unknown option\n'.format(
-            key, value))
+        sys.stderr.write('Discarded config from PYTHONHUNTERCONFIG {}={!r}: Unknown option\n'.format(key, value))
     for position, predicate in enumerate(args):
         if callable(predicate):
             predicates.append(predicate)
         else:
-            sys.stderr.write('Discarded config from PYTHONHUNTERCONFIG {} (position {}): Not a callable\n'.format(
-                predicate, position))
+            sys.stderr.write('Discarded config from PYTHONHUNTERCONFIG {} (position {}): Not a callable\n'.format(predicate, position))
 
     return predicates, options
 
@@ -176,17 +182,14 @@ def Q(*predicates, **query):
             raise TypeError('Action {0!r} is not callable.'.format(a))
 
     if predicates:
-        predicates = tuple(
-            p() if inspect.isclass(p) and issubclass(p, Action) else p
-            for p in predicates
-        )
+        predicates = tuple(p() if inspect.isclass(p) and issubclass(p, Action) else p for p in predicates)
         if any(isinstance(p, (CallPrinter, CodePrinter)) for p in predicates):
             # the user provided an action as a filter, remove the action then to prevent double output
             for action in optional_actions:
                 if action in (CallPrinter, CodePrinter) or isinstance(action, (CallPrinter, CodePrinter)):
                     optional_actions.remove(action)
         if query:
-            predicates += Query(**query),
+            predicates += (Query(**query),)
 
         result = And(*predicates)
     else:
@@ -201,7 +204,7 @@ def Q(*predicates, **query):
 def _merge(*predicates, **query):
     if predicates:
         if query:
-            predicates += Query(**query),
+            predicates += (Query(**query),)
         return And(*predicates)
     else:
         return Query(**query)
@@ -240,7 +243,7 @@ def And(*predicates, **kwargs):
          :class:`hunter.predicates.And`
     """
     if kwargs:
-        predicates += Query(**kwargs),
+        predicates += (Query(**kwargs),)
     return _flatten(_And, *predicates)
 
 
@@ -278,7 +281,7 @@ def Not(*predicates, **kwargs):
          :class:`hunter.predicates.Not`
     """
     if kwargs:
-        predicates += Query(**kwargs),
+        predicates += (Query(**kwargs),)
     if len(predicates) > 1:
         return _Not(_flatten(_And, *predicates))
     else:
@@ -310,8 +313,7 @@ def From(condition=None, predicate=None, watermark=0, **kwargs):
         return _From(Q(**condition_kwargs), Q(**predicate_kwargs), watermark)
     else:
         if kwargs:
-            raise TypeError("Unexpected arguments {}. Don't combine positional with keyword arguments.".format(
-                kwargs.keys()))
+            raise TypeError("Unexpected arguments {}. Don't combine positional with keyword arguments.".format(kwargs.keys()))
         return _From(condition, predicate, watermark)
 
 
@@ -343,9 +345,18 @@ def Backlog(*conditions, **kwargs):
     strip = kwargs.pop('strip', True)
     vars = kwargs.pop('vars', False)
     if not conditions and not kwargs:
-        raise TypeError('Backlog needs at least 1 condition '
-                        "(it doesn't have any effect without one besides making everything incredibly slow).")
-    return _Backlog(_merge(*conditions, **kwargs), size=size, stack=stack, vars=vars, strip=strip, action=action, filter=filter)
+        raise TypeError(
+            'Backlog needs at least 1 condition ' "(it doesn't have any effect without one besides making everything incredibly slow)."
+        )
+    return _Backlog(
+        _merge(*conditions, **kwargs),
+        size=size,
+        stack=stack,
+        vars=vars,
+        strip=strip,
+        action=action,
+        filter=filter,
+    )
 
 
 def stop():
@@ -467,11 +478,13 @@ def tracing_wrapper(*args, **kwargs):
             predicates.append(
                 From(
                     Query(kind='call'),
-                    Not(When(
-                        Query(calls_gt=0, depth=0) & Not(Query(kind='return')),
-                        Stop
-                    )),
-                    watermark=-1
+                    Not(
+                        When(
+                            Query(calls_gt=0, depth=0) & Not(Query(kind='return')),
+                            Stop,
+                        )
+                    ),
+                    watermark=-1,
                 )
             )
             local_tracer = trace(*predicates, **trace_options)
@@ -496,8 +509,7 @@ def load_config(*args, **kwargs):
         else:
             _default_trace_args = eval('_prepare_config({})'.format(os.environ.get('PYTHONHUNTERCONFIG', '')))
     except Exception as exc:
-        sys.stderr.write('Failed to load hunter config from PYTHONHUNTERCONFIG {[PYTHONHUNTERCONFIG]!r}: {!r}\n'.format(
-            os.environ, exc))
+        sys.stderr.write('Failed to load hunter config from PYTHONHUNTERCONFIG {[PYTHONHUNTERCONFIG]!r}: {!r}\n'.format(os.environ, exc))
         _default_trace_args = (), ()