Merge pull request #95 from akx/blacken-flake8

Flake8 fixes

Author: ajmyyra

.github/workflows/main.yml

@@ -1,10 +1,28 @@
 name: test
 
-on: 
+on:
   - push
   - pull_request
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install -r requirements-dev.txt
+      - name: Run flake8
+        run: flake8
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip
   build:
     runs-on: ubuntu-latest
     strategy:
@@ -26,7 +44,7 @@ jobs:
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip
-  
+
   deploy:
     name: Build deploy
     runs-on: ubuntu-latest
@@ -39,4 +57,3 @@ jobs:
           build: true
           # only upload if a tag is pushed (otherwise just build & check)
           upload: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
-      

pyproject.toml

@@ -2,3 +2,7 @@
 line-length = 99
 target-version = ['py36']
 skip-string-normalization = true
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3

requirements-dev.in

@@ -1,7 +1,13 @@
 black~=21.4b1; platform_python_implementation != "PyPy"
 flake8
+flake8-bandit
+flake8-black; platform_python_implementation != "PyPy"
+flake8-bugbear
 flake8-docstrings
+flake8-isort
+flake8-pytest
 hacking
+isort
 mock
 pip-tools
 pytest

requirements-dev.txt

@@ -7,9 +7,15 @@
 appdirs==1.4.4
     # via black
 attrs==20.3.0
-    # via pytest
+    # via
+    #   flake8-bugbear
+    #   pytest
+bandit==1.7.0
+    # via flake8-bandit
 black==21.4b1 ; platform_python_implementation != "PyPy"
-    # via -r requirements-dev.in
+    # via
+    #   -r requirements-dev.in
+    #   flake8-black
 certifi==2020.12.5
     # via requests
 chardet==4.0.0
@@ -21,19 +27,45 @@ click==7.1.2
     #   safety
 dparse==0.5.1
     # via safety
+flake8-bandit==2.1.2
+    # via -r requirements-dev.in
+flake8-black==0.2.1 ; platform_python_implementation != "PyPy"
+    # via -r requirements-dev.in
+flake8-bugbear==21.4.3
+    # via -r requirements-dev.in
 flake8-docstrings==1.6.0
     # via -r requirements-dev.in
+flake8-isort==4.0.0
+    # via -r requirements-dev.in
+flake8-polyfill==1.0.2
+    # via flake8-bandit
+flake8-pytest==1.3
+    # via -r requirements-dev.in
 flake8==3.8.4
     # via
     #   -r requirements-dev.in
+    #   flake8-bandit
+    #   flake8-black
+    #   flake8-bugbear
     #   flake8-docstrings
+    #   flake8-isort
+    #   flake8-polyfill
+    #   flake8-pytest
     #   hacking
+gitdb==4.0.7
+    # via gitpython
+gitpython==3.1.14
+    # via bandit
 hacking==4.1.0
     # via -r requirements-dev.in
 idna==2.10
     # via requests
 iniconfig==1.1.1
     # via pytest
+isort==5.8.0
+    # via
+    #   -r requirements-dev.in
+    #   flake8-isort
 mccabe==0.6.1
     # via flake8
 mock==4.0.3
@@ -47,6 +79,8 @@ packaging==20.9
     #   safety
 pathspec==0.8.1
     # via black
+pbr==5.6.0
+    # via stevedore
 pep517==0.10.0
     # via pip-tools
 pip-tools==6.1.0
@@ -56,7 +90,9 @@ pluggy==0.13.1
 py==1.10.0
     # via pytest
 pycodestyle==2.6.0
-    # via flake8
+    # via
+    #   flake8
+    #   flake8-bandit
 pydocstyle==6.0.0
     # via flake8-docstrings
 pyflakes==2.2.0
@@ -66,7 +102,9 @@ pyparsing==2.4.7
 pytest==6.2.3
     # via -r requirements-dev.in
 pyyaml==5.4.1
-    # via dparse
+    # via
+    #   bandit
+    #   dparse
 regex==2021.4.4
     # via black
 requests==2.25.1
@@ -78,9 +116,17 @@ responses==0.13.2
 safety==1.10.3
     # via -r requirements-dev.in
 six==1.15.0
-    # via responses
+    # via
+    #   bandit
+    #   responses
+smmap==4.0.0
+    # via gitdb
 snowballstemmer==2.1.0
     # via pydocstyle
+stevedore==3.3.0
+    # via bandit
+testfixtures==6.17.1
+    # via flake8-isort
 toml==0.10.2
     # via
     #   black

setup.cfg

@@ -23,3 +23,37 @@ packages =
 
 [bdist_wheel]
 universal = 1
+
+[flake8]
+max-line-length = 99
+extend-ignore =
+    # ignore line length problems; those are fixed by black
+    E501
+    # via black
+    E203
+    W503
+    # docstring format leniency
+    D100
+    D104
+    D105
+    D200
+    D202
+    D205
+    D400
+    D401
+    D403
+    # things from `hacking` we don't care about
+    H101
+    H301
+    H306
+    H404
+    H405
+per-file-ignores =
+    test/*: D101,D102,D103,F841,S101,S106,B011
+    # ignore "imported but not used" in any __init__.pys
+    */__init__.py: F401
+exclude =
+    .git
+    ENV
+    __pycache__
+    build

setup.py

@@ -1,23 +1,19 @@
-#!/usr/bin/env python
-
-from setuptools import setup
-import codecs
+import ast
 import os.path
+import re
 
-
-def read(rel_path):
-    here = os.path.abspath(os.path.dirname(__file__))
-    with codecs.open(os.path.join(here, rel_path), 'r') as fp:
-        return fp.read()
+from setuptools import setup
 
 
-def get_version(rel_path):
-    for line in read(rel_path).splitlines():
-        if line.startswith('__version__'):
-            delim = '"' if '"' in line else "'"
-            return line.split(delim)[1]
-    else:
-        raise RuntimeError("Unable to find version string.")
+def get_version(rel_path: str) -> str:
+    """
+    Parse a version string from a __version__ = ... line in the given file.
+    """
+    with open(os.path.join(os.path.dirname(__file__), rel_path)) as infp:
+        match = re.search("__version__ = (.+?)$", infp.read(), re.M)
+        if not match:
+            raise ValueError("No version could be found")
+        return ast.literal_eval(match.group(1))
 
 
 with open('README.md') as f:

test/conftest.py

@@ -1,9 +1,9 @@
 import json
 import os
-import pytest
-import responses
 import sys
 
+import pytest
+import responses
 
 # make files under helpers available for import
 HELPERS_PATH = os.path.join(os.path.dirname(__file__), 'helpers')

test/helpers/infra.py

@@ -1,6 +1,8 @@
-from upcloud_api import CloudManager, Storage, FirewallRule, Tag, IPAddress
+from upcloud_api.firewall import FirewallRule
+from upcloud_api.ip_address import IPAddress
 from upcloud_api.server import Server, login_user_block
-
+from upcloud_api.storage import Storage
+from upcloud_api.tag import Tag
 
 CLUSTER = {
     'web1': Server(

test/helpers/infra_helpers.py

@@ -1,6 +1,3 @@
-from upcloud_api import Tag
-
-
 def create_cluster(manager, cluster):
     """Create all servers in cluster."""
     for server in cluster:
@@ -30,7 +27,7 @@ def firewall_test(manager, firewall_rules, server):
     fs = server.get_firewall_rules()
     assert len(fs) == 2
 
-    for f in fs:
+    for _ in fs:
         manager.delete_firewall_rule(server.uuid, 1)
 
     fs = server.get_firewall_rules()

test/test_apidoc/test_10_ip_addresses.py

@@ -1,7 +1,8 @@
-from upcloud_api import IPAddress, Server
-from conftest import Mock, read_from_file
 import json
-import responses
+
+from conftest import read_from_file
+
+from upcloud_api import IPAddress, Server
 
 
 class TestIP: