switch to ruff (#124)

* switch to ruff * revert tests/test_expr_render.py * fix pyproject.toml, etc. * switch to pinned dependencies * switch to 3.7 deps * skip some tests on 3.7, add pre-commit

Author: samuelcolvin

.github/workflows/ci.yml

@@ -19,10 +19,13 @@ jobs:
  with:
  python-version: '3.10'
 
- - run: pip install -r tests/requirements-linting.txt
- - run: pip install .
+ - run: pip install -r requirements/linting.txt -r requirements/pyproject.txt
+
+ - run: mypy devtools
 
- - run: make lint
+ - uses: pre-commit/action@v3.0.0
+ with:
+ extra_args: --all-files --verbose
 
  test:
  name: test py${{ matrix.python-version }} on ${{ matrix.os }}
@@ -47,7 +50,7 @@ jobs:
  with:
  python-version: ${{ matrix.python-version }}
 
- - run: pip install -r tests/requirements.txt
+ - run: pip install -r requirements/testing.txt -r requirements/pyproject.txt
  - run: pip install .
  - run: pip freeze
 
@@ -102,7 +105,7 @@ jobs:
  python-version: '3.10'
 
  - name: install
- run: make install
+ run: pip install build twine
 
  - name: build
  run: python -m build

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.3.0
+ hooks:
+ - id: check-yaml
+ - id: check-toml
+ - id: end-of-file-fixer
+ - id: trailing-whitespace
+
+- repo: local
+ hooks:
+ - id: ruff
+ name: Ruff
+ entry: ruff
+ args: [--fix, --exit-non-zero-on-fix]
+ types: [python]
+ language: system
+ files: ^devtools/|^tests/
+ - id: black
+ name: Black
+ entry: black
+ types: [python]
+ language: system
+ files: ^devtools/|^tests/
+ exclude: test_expr_render.py

HISTORY.md

@@ -14,7 +14,7 @@
 
 ## v0.7.0 (2021-09-03)
 
-* switch to [`executing`](https://pypi.org/project/executing/) and [`asttokens`](https://pypi.org/project/asttokens/) 
+* switch to [`executing`](https://pypi.org/project/executing/) and [`asttokens`](https://pypi.org/project/asttokens/)
  for finding and printing debug arguments, #82, thanks @alexmojaki
 * correct changelog links, #76, thanks @Cielquan
 * return `debug()` arguments, #87

Makefile

@@ -1,23 +1,36 @@
 .DEFAULT_GOAL := all
-isort = isort devtools tests docs/plugins.py
-black = black -S -l 120 --target-version py37 devtools docs/plugins.py
+sources = devtools tests docs/plugins.py
 
 .PHONY: install
 install:
-python -m pip install -U setuptools pip wheel twine build
-pip install -U -r requirements.txt
+python -m pip install -U pip pre-commit
+pip install -U -r requirements/all.txt
 pip install -e .
+pre-commit install
+
+.PHONY: refresh-lockfiles
+refresh-lockfiles:
+find requirements/ -name '*.txt' ! -name 'all.txt' -type f -delete
+make update-lockfiles
+
+.PHONY: update-lockfiles
+update-lockfiles:
+@echo "Updating requirements/*.txt files using pip-compile"
+pip-compile -q --resolver backtracking -o requirements/linting.txt requirements/linting.in
+pip-compile -q --resolver backtracking -o requirements/testing.txt requirements/testing.in
+pip-compile -q --resolver backtracking -o requirements/docs.txt requirements/docs.in
+pip-compile -q --resolver backtracking -o requirements/pyproject.txt pyproject.toml
+pip install --dry-run -r requirements/all.txt
 
 .PHONY: format
 format:
-$(isort)
-$(black)
+black $(sources)
+ruff $(sources) --fix --exit-zero
 
 .PHONY: lint
 lint:
-flake8 --max-complexity 10 --max-line-length 120 --ignore E203,W503 devtools tests docs/plugins.py
-$(isort) --check-only --df
-$(black) --check --diff
+black $(sources) --check --diff
+ruff $(sources)
 mypy devtools
 
 .PHONY: test

README.md

@@ -64,5 +64,5 @@ outputs:
 devtools can be used without `from devtools import debug` if you add `debug` into `__builtins__`
 in `sitecustomize.py`.
 
-For instructions on adding `debug` to `__builtins__`, 
+For instructions on adding `debug` to `__builtins__`,
 see the [installation docs](https://python-devtools.helpmanual.io/usage/#usage-without-import).

devtools/debug.py

@@ -178,7 +178,7 @@ def _process(self, args: 'Any', kwargs: 'Any') -> DebugOutput:
  ex = source.executing(call_frame)
  function = ex.code_qualname()
  if not ex.node:
- warning = "executing failed to find the calling node"
+ warning = 'executing failed to find the calling node'
  arguments = list(self._args_inspection_failed(args, kwargs))
  else:
  arguments = list(self._process_args(ex, args, kwargs))

devtools/prettier.py

@@ -13,9 +13,9 @@
  cache = lru_cache()
 
 try:
- from sqlalchemy import inspect as sa_inspect # type: ignore
+ from sqlalchemy import inspect as sa_inspect
 except ImportError:
- sa_inspect = None
+ sa_inspect = None # type: ignore[assignment]
 
 __all__ = 'PrettyFormat', 'pformat', 'pprint'
 MYPY = False
@@ -251,7 +251,7 @@ def _format_sqlalchemy_class(self, value: 'Any', _: str, indent_current: int, in
  deferred = set()
 
  fields = [
- (field, getattr(value, field) if field not in deferred else "<deferred>")
+ (field, getattr(value, field) if field not in deferred else '<deferred>')
  for field in dir(value)
  if not (field.startswith('_') or field in ['metadata', 'registry'])
  ]

devtools/utils.py

@@ -93,7 +93,7 @@ def _set_conout_mode(new_mode, mask=0xFFFFFFFF):
  mode = mask = ENABLE_VIRTUAL_TERMINAL_PROCESSING
  try:
  _set_conout_mode(mode, mask)
- except WindowsError as e: # type: ignore
+ except OSError as e:
  if e.winerror == ERROR_INVALID_PARAMETER:
  return False
  raise
@@ -150,15 +150,15 @@ class DataClassType(metaclass=MetaDataClassType):
 class MetaSQLAlchemyClassType(type):
  def __instancecheck__(self, instance: 'Any') -> bool:
  try:
- from sqlalchemy.orm import DeclarativeBase # type: ignore
+ from sqlalchemy.orm import DeclarativeBase
  except ImportError:
  pass
  else:
  if isinstance(instance, DeclarativeBase):
  return True
 
  try:
- from sqlalchemy.ext.declarative import DeclarativeMeta # type: ignore
+ from sqlalchemy.ext.declarative import DeclarativeMeta
  except ImportError:
  pass
  else:

docs/plugins.py

@@ -55,7 +55,7 @@ def gen_examples_html(m: re.Match) -> str:
  conv = Ansi2HTMLConverter()
  name = THIS_DIR / Path(m.group(1))
 
- logger.info("running %s to generate HTML...", name)
+ logger.info('running %s to generate HTML...', name)
  p = subprocess.run((sys.executable, str(name)), stdout=subprocess.PIPE, check=True)
  html = conv.convert(p.stdout.decode(), full=False).strip('\r\n')
  html = html.replace('docs/build/../examples/', '')

docs/usage.md

@@ -96,7 +96,7 @@ Two ways to do this:
 ### Automatic install
 
 !!! warning
- This is experimental, please [create an issue](https://github.com/samuelcolvin/python-devtools/issues) 
+ This is experimental, please [create an issue](https://github.com/samuelcolvin/python-devtools/issues)
  if you encounter any problems.
 
 To install `debug` into `__builtins__` automatically, run: