Skip to content

Commit

Permalink
replace pylint with flake8 everywhere
Browse files Browse the repository at this point in the history
  • Loading branch information
lonvia committed Nov 10, 2024
1 parent 122ecd4 commit d77aa7d
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 9 deletions.
8 changes: 8 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[flake8]
max-line-length = 100
max-doc-length = 100
extend-ignore =
# something == None constructs are needed for SQLAlchemy
E711
per-file-ignores =
__init__.py: F401
6 changes: 3 additions & 3 deletions .github/workflows/ci-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ jobs:
- name: Install Python webservers
run: pip3 install falcon starlette asgi_lifespan

- name: Install latest pylint
run: pip3 install -U pylint
- name: Install latest flake8
run: pip3 install -U flake8
if: matrix.flavour == 'ubuntu-22'

- name: Python linting
run: python3 -m pylint src
run: python3 -m flake8 src
working-directory: Nominatim
if: matrix.flavour == 'ubuntu-22'

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ are in process of consolidating the style. The following rules apply:
* leave out space between a function name and bracket
but add one between control statement(if, while, etc.) and bracket

The coding style is enforced with pylint. It can be tested with:
The coding style is enforced with flake8. It can be tested with:

```
pylint3 --extension-pkg-whitelist=osmium nominatim
make lint
```

## Testing
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pytest:
pytest test/python

lint:
pylint src
flake8 src

bdd:
cd test/bdd; behave -DREMOVE_TEMPLATE=1
Expand Down
5 changes: 2 additions & 3 deletions docs/develop/Development-Environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The Nominatim test suite consists of behavioural tests (using behave) and
unit tests (using pytest). It has the following additional requirements:

* [behave test framework](https://behave.readthedocs.io) >= 1.2.6
* [Pylint](https://pylint.org/) (CI always runs the latest version from pip)
* [flake8](https://flake8.pycqa.org/en/stable/) (CI always runs the latest version from pip)
* [mypy](http://mypy-lang.org/) (plus typing information for external libs)
* [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
* [pytest](https://pytest.org)
Expand All @@ -55,7 +55,6 @@ the vendored version of osm2pgsql, you need to set the PATH accordingly.
### Installing prerequisites on Ubuntu/Debian

The Python tools should always be run with the most recent version.
In particular, pylint tends to have a lot of breaking changes between versions.
The easiest way, to handle these Python dependencies is to run your
development from within a virtual environment.

Expand All @@ -70,7 +69,7 @@ virtualenv ~/nominatim-dev-venv
~/nominatim-dev-venv/bin/pip install\
psutil psycopg[binary] PyICU SQLAlchemy \
python-dotenv jinja2 pyYAML datrie behave \
mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio pylint \
mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio flake8 \
types-jinja2 types-markupsafe types-psutil types-psycopg2 \
types-pygments types-pyyaml types-requests types-ujson \
types-urllib3 typing-extensions unicorn falcon starlette \
Expand Down

0 comments on commit d77aa7d

Please sign in to comment.