Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

drop black and isort #270

Merged
merged 4 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,3 @@ docs/_build/
/watchfiles/*.so
/target/
/site/
# i have a pet hate of the proliferation of files in the root directory
.rustfmt.toml
1 change: 1 addition & 0 deletions .rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
max_width = 120
31 changes: 15 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,41 +1,40 @@
.DEFAULT_GOAL := all
isort = isort watchfiles tests
black = black watchfiles tests
ruff = ruff watchfiles tests

.PHONY: install
install:
pip install -U pip pre-commit
pip install -U pip pre-commit maturin
pip install -r requirements/all.txt
pip install -e .
pre-commit install

.PHONY: update-lockfiles
update-lockfiles:
@echo "Updating requirements files using pip-compile"
pip-compile -q --strip-extras -o requirements/linting.txt requirements/linting.in
pip-compile -q --strip-extras -c requirements/linting.txt -o requirements/pyproject.txt pyproject.toml
pip-compile -q --strip-extras -c requirements/linting.txt -c requirements/pyproject.txt -o requirements/testing.txt requirements/testing.in
pip-compile -q --strip-extras -c requirements/linting.txt -c requirements/pyproject.txt -c requirements/testing.txt -o requirements/docs.txt requirements/docs.in
pip install --dry-run -r requirements/all.txt

.PHONY: build-dev
build-dev:
pip uninstall -y watchfiles
@rm -f watchfiles/*.so
cargo build
@rm -f target/debug/lib_rust_notify.d
@mv target/debug/lib_rust_notify.* watchfiles/_rust_notify.so
maturin develop

.PHONY: format
format:
$(ruff) --fix-only
$(isort)
$(black)
ruff check --fix-only watchfiles tests
ruff format watchfiles tests
@echo 'max_width = 120' > .rustfmt.toml
cargo fmt

.PHONY: lint-python
lint-python:
$(ruff)
$(isort) --check-only --df
$(black) --check --diff
ruff check watchfiles tests
ruff format --check watchfiles tests

.PHONY: lint-rust
lint-rust:
cargo fmt --version
@echo 'max_width = 120' > .rustfmt.toml
cargo fmt --all -- --check
cargo clippy --version
cargo clippy -- -D warnings
Expand Down
22 changes: 6 additions & 16 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,14 @@ exclude_lines = [
]
omit = ['*/__main__.py']

[tool.black]
color = true
line-length = 120
target-version = ['py39']
skip-string-normalization = true

[tool.isort]
line_length = 120
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
combine_as_imports = true
color_output = true

[tool.ruff]
line-length = 120
extend-select = ['Q']
flake8-quotes = {inline-quotes = 'single', multiline-quotes = 'double'}
target-version = 'py38'
lint.mccabe = { max-complexity = 14 }
lint.extend-select = ['Q', 'RUF100', 'C90', 'UP', 'I']
lint.flake8-quotes = {inline-quotes = 'single', multiline-quotes = 'double'}
lint.pydocstyle = { convention = 'google' }
format.quote-style = 'single'

[tool.mypy]
strict = true
Expand Down
39 changes: 26 additions & 13 deletions requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#
# This file is autogenerated by pip-compile with python 3.10
# To update, run:
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --output-file=requirements/docs.txt requirements/docs.in
# pip-compile --constraint=requirements/linting.txt --constraint=requirements/pyproject.txt --constraint=requirements/testing.txt --output-file=requirements/docs.txt requirements/docs.in
#
black==22.8.0
# via -r docs.in
# via -r requirements/docs.in
click==8.1.3
# via
# black
Expand Down Expand Up @@ -36,46 +36,54 @@ markupsafe==2.1.1
# jinja2
# mkdocstrings
mdx-include==1.4.2
# via -r docs.in
# via -r requirements/docs.in
mergedeep==1.3.4
# via mkdocs
mkdocs==1.3.1
# via
# -r docs.in
# -r requirements/docs.in
# mkdocs-autorefs
# mkdocs-material
# mkdocs-simple-hooks
# mkdocstrings
mkdocs-autorefs==0.4.1
# via mkdocstrings
mkdocs-material==8.4.3
# via -r docs.in
# via -r requirements/docs.in
mkdocs-material-extensions==1.0.3
# via mkdocs-material
mkdocs-simple-hooks==0.1.5
# via -r docs.in
# via -r requirements/docs.in
mkdocstrings[python]==0.19.0
# via
# -r docs.in
# -r requirements/docs.in
# mkdocstrings-python
mkdocstrings-python==0.7.1
# via mkdocstrings
mypy-extensions==0.4.3
# via black
# via
# -c requirements/linting.txt
# black
packaging==21.3
# via mkdocs
# via
# -c requirements/testing.txt
# mkdocs
pathspec==0.10.1
# via black
platformdirs==2.5.2
# via black
pygments==2.15.0
# via mkdocs-material
# via
# -c requirements/testing.txt
# mkdocs-material
pymdown-extensions==10.0
# via
# mkdocs-material
# mkdocstrings
pyparsing==3.0.9
# via packaging
# via
# -c requirements/testing.txt
# packaging
python-dateutil==2.8.2
# via ghp-import
pyyaml==6.0
Expand All @@ -89,6 +97,11 @@ rcslice==1.1.0
# via mdx-include
six==1.16.0
# via python-dateutil
tomli==2.0.1
# via
# -c requirements/linting.txt
# -c requirements/testing.txt
# black
watchdog==2.1.9
# via mkdocs
zipp==3.8.1
Expand Down
2 changes: 0 additions & 2 deletions requirements/linting.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
black
isort[colors]
mypy
ruff
trio
30 changes: 8 additions & 22 deletions requirements/linting.txt
Original file line number Diff line number Diff line change
@@ -1,45 +1,31 @@
#
# This file is autogenerated by pip-compile with python 3.10
# To update, run:
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --output-file=requirements/linting.txt requirements/linting.in
#
async-generator==1.10
# via trio
attrs==22.1.0
# via trio
black==22.8.0
# via -r requirements/linting.in
click==8.1.3
# via black
colorama==0.4.5
# via isort
# via
# outcome
# trio
idna==3.3
# via trio
isort[colors]==5.10.1
# via -r requirements/linting.in
mypy==0.971
# via -r requirements/linting.in
mypy-extensions==0.4.3
# via
# black
# mypy
# via mypy
outcome==1.2.0
# via trio
pathspec==0.10.1
# via black
platformdirs==2.5.2
# via black
ruff==0.0.285
ruff==0.4.3
# via -r requirements/linting.in
sniffio==1.3.0
# via trio
sortedcontainers==2.4.0
# via trio
tomli==2.0.1
# via
# black
# mypy
# via mypy
trio==0.21.0
# via -r requirements/linting.in
typing-extensions==4.3.0
Expand Down
14 changes: 9 additions & 5 deletions requirements/pyproject.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
#
# This file is autogenerated by pip-compile with python 3.10
# To update, run:
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --output-file=requirements/pyproject.txt pyproject.toml
# pip-compile --constraint=requirements/linting.txt --output-file=requirements/pyproject.txt pyproject.toml
#
anyio==3.6.1
# via watchfiles (pyproject.toml)
idna==3.3
# via anyio
# via
# -c requirements/linting.txt
# anyio
sniffio==1.3.0
# via anyio
# via
# -c requirements/linting.txt
# anyio
24 changes: 15 additions & 9 deletions requirements/testing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --output-file=requirements/testing.txt requirements/testing.in
# pip-compile --constraint=requirements/linting.txt --constraint=requirements/pyproject.txt --output-file=requirements/testing.txt requirements/testing.in
#
commonmark==0.9.1
# via rich
coverage==6.4.4
# via -r testing.in
# via -r requirements/testing.in
dirty-equals==0.5.0
# via -r testing.in
# via -r requirements/testing.in
exceptiongroup==1.2.1
# via pytest
iniconfig==1.1.1
# via pytest
packaging==21.3
Expand All @@ -22,21 +24,25 @@ pyparsing==3.0.9
# via packaging
pytest==7.4.2
# via
# -r testing.in
# -r requirements/testing.in
# pytest-mock
# pytest-pretty
# pytest-timeout
pytest-mock==3.8.2
# via -r testing.in
# via -r requirements/testing.in
pytest-pretty==0.0.1
# via -r testing.in
# via -r requirements/testing.in
pytest-timeout==2.1.0
# via -r testing.in
# via -r requirements/testing.in
pytz==2022.2.1
# via dirty-equals
rich==12.6.0
# via pytest-pretty
tomli==2.0.1
# via pytest
# via
# -c requirements/linting.txt
# pytest
typing-extensions==4.3.0
# via dirty-equals
# via
# -c requirements/linting.txt
# dirty-equals
5 changes: 3 additions & 2 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ def close(self):
from typing import Literal, Protocol

class MockRustType(Protocol):
def __call__(self, changes: ChangesType, *, exit_code: Literal['signal', 'stop', 'timeout'] = 'stop') -> Any:
...
def __call__(
self, changes: ChangesType, *, exit_code: Literal['signal', 'stop', 'timeout'] = 'stop'
) -> Any: ...


@pytest.fixture
Expand Down
4 changes: 2 additions & 2 deletions tests/test_watch.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ def test_watch_timeout(mock_rust_notify: 'MockRustType', caplog):
assert change_list == [{(Change.added, 'spam.py')}]
assert mock.watch_count == 2
assert caplog.text == (
"watchfiles.main DEBUG: rust notify timeout, continuing\n" # noqa: Q000
'watchfiles.main DEBUG: rust notify timeout, continuing\n'
"watchfiles.main DEBUG: 1 change detected: {(<Change.added: 1>, 'spam.py')}\n"
)

Expand All @@ -167,7 +167,7 @@ async def test_awatch_timeout(mock_rust_notify: 'MockRustType', caplog):
assert change_list == [{(Change.added, 'spam.py')}]
assert mock.watch_count == 2
assert caplog.text == (
"watchfiles.main DEBUG: rust notify timeout, continuing\n" # noqa: Q000
'watchfiles.main DEBUG: rust notify timeout, continuing\n'
"watchfiles.main DEBUG: 1 change detected: {(<Change.added: 1>, 'spam.py')}\n"
)

Expand Down
10 changes: 5 additions & 5 deletions watchfiles/_rust_notify.pyi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Any, List, Literal, Optional, Protocol, Set, Tuple, Union
from typing import Any, Literal, Protocol

__all__ = 'RustNotify', 'WatchfilesRustInternalError'

Expand All @@ -16,7 +16,7 @@ class RustNotify:

def __init__(
self,
watch_paths: List[str],
watch_paths: list[str],
debug: bool,
force_polling: bool,
poll_delay_ms: int,
Expand All @@ -42,8 +42,8 @@ class RustNotify:
debounce_ms: int,
step_ms: int,
timeout_ms: int,
stop_event: Optional[AbstractEvent],
) -> Union[Set[Tuple[int, str]], Literal['signal', 'stop', 'timeout']]:
stop_event: AbstractEvent | None,
) -> set[tuple[int, str]] | Literal['signal', 'stop', 'timeout']:
"""
Watch for changes.

Expand Down Expand Up @@ -74,7 +74,7 @@ class RustNotify:
* `'stop'` string, if the `stop_event` was set
* `'timeout'` string, if `timeout_ms` was exceeded
"""
def __enter__(self) -> 'RustNotify':
def __enter__(self) -> RustNotify:
"""
Does nothing, but allows `RustNotify` to be used as a context manager.

Expand Down
Loading
Loading