Update validations

.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    # manually triggered
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: make env
+      - name: Lint with pylint
+        run: make pylint
+      - name: Test with pytest
+        run: make test
+      - name: Documentation
+        run: make doc

.pylintrc

@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable=R,attribute-defined-outside-init,bad-continuation,bad-option-value,bare-except,invalid-name,locally-disabled,missing-docstring,redefined-builtin,ungrouped-imports,wrong-import-order,wrong-import-position
+disable=R,attribute-defined-outside-init,bad-continuation,bad-option-value,bare-except,invalid-name,locally-disabled,missing-docstring,redefined-builtin,ungrouped-imports,wrong-import-order,wrong-import-position,superfluous-parens
 
 [REPORTS]
 reports=no

Makefile

@@ -1,16 +1,19 @@
 default: test
 
 test: env
-	.env/bin/py.test -x tests --cov=backslash --cov-report=html
+	.env/bin/pytest -x tests --cov=backslash --cov-report=html
+
+pylint: env
+	.env/bin/pylint --rcfile .pylintrc backslash tests
 
 doc: env
-	.env/bin/python setup.py build_sphinx -a -E
+	.env/bin/sphinx-build -a -W -E docs build/sphinx/html
 
 env: .env/.up-to-date
 
 
 .env/.up-to-date: setup.py Makefile setup.cfg
-	virtualenv --no-site-packages .env
-	.env/bin/pip install -e .[testing]
+	python3 -m venv .env
+	.env/bin/pip install -e .[testing,doc]
 	touch $@
 

backslash/_compat.py

@@ -9,6 +9,7 @@
 #pylint: disable=unused-argument
 #pylint: disable=unused-import
 #pylint: disable=exec-used
+#pylint: disable=unnecessary-lambda-assignment
 import sys
 from contextlib import contextmanager
 

backslash/api.py

@@ -23,7 +23,7 @@
 from .utils import raise_for_status, compute_memory_usage
 from .warning import Warning
 
-from typing import Optional, Union, Dict, Tuple, Any, Iterator, Type, TYPE_CHECKING
+from typing import Optional, Union, Dict, Tuple, Any, Iterator, TYPE_CHECKING
 
 if TYPE_CHECKING:
     from .client import Backslash

backslash/api_object.py

@@ -28,7 +28,7 @@ def __getattr__(self, name: str) -> Optional[Union[int, str]]:
         try:
             return self.__dict__['_data'][name]
         except KeyError:
-            raise AttributeError(name)
+            raise AttributeError(name) from None
 
     def refresh(self):
         prev_id = self.id

backslash/contrib/slash_plugin.py

@@ -17,7 +17,7 @@
 
 try:
     import git
-except Exception as e: # pylint: disable=broad-except
+except Exception:  # pylint: disable=broad-except
     pass
 
 import slash
@@ -38,6 +38,7 @@
 from ..__version__ import __version__ as BACKSLASH_CLIENT_VERSION
 
 _DEFAULT_CONFIG_FILENAME = os.path.expanduser('~/.backslash/config.json')
+_GET_TOKEN_TIMEOUT_SEC = 30
 
 _logger = logbook.Logger(__name__)
 
@@ -388,7 +389,7 @@ def _calculate_file_hash(self, filename):
         returned = self._file_hash_cache.get(filename)
         if returned is None:
             try:
-                with open(filename, 'rb') as f:
+                with open(filename, 'rb', encoding='utf-8') as f:
                     data = f.read()
                     h = hashlib.sha1()
                     h.update('blob '.encode('utf-8'))
@@ -561,7 +562,7 @@ def _get_existing_tokens(self):
     def _get_config(self):
         if not os.path.isfile(self._config_filename):
             return {}
-        with open(self._config_filename) as f:
+        with open(self._config_filename, encoding='utf-8') as f:
             return json.load(f)
 
     def _save_token(self, token):
@@ -571,7 +572,7 @@ def _save_token(self, token):
 
         ensure_dir(os.path.dirname(tmp_filename))
 
-        with open(tmp_filename, 'w') as f:
+        with open(tmp_filename, 'w', encoding='utf-8') as f:
             json.dump(cfg, f, indent=2)
         os.rename(tmp_filename, self._config_filename)
 
@@ -611,7 +612,7 @@ def _fetch_token_via_browser(self):
         opened_browser = False
         url = self._get_token_request_url()
         for retry in itertools.count():
-            resp = requests.get(url)
+            resp = requests.get(url, timeout=_GET_TOKEN_TIMEOUT_SEC)
             resp.raise_for_status()
             data = resp.json()
             if retry == 0:

backslash/utils.py

@@ -38,4 +38,4 @@ def raise_for_status(resp: Response) -> None:
     except HTTPError as e:
         raise HTTPError(
             f'{e.response.request.method} {e.response.request.url}: {e.response.status_code}\n\n{e.response.content}',
-            response=resp, request=resp.request)
+            response=resp, request=resp.request) from None

docs/conf.py

@@ -70,7 +70,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+#language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

setup.cfg

@@ -15,12 +15,17 @@ testing =
     slash>=1.5.0
     Flask
     Flask-Loopback
-    pylint~=2.2.0
+    pylint
     pytest>4.0
     pytest-cov>=2.6
     URLObject
     weber-utils
 
+doc =
+    alabaster
+    releases
+    Sphinx
+
 sentry =
     raven
 

tests/test_backslash.py

@@ -1,4 +1,4 @@
 # py.test style tests here
 
 def test_import():
-    import backslash  # pylint: disable=trailing-newlines, unused-variable, unused-import
+    import backslash  # pylint: disable=unused-import, import-outside-toplevel

tests/test_slash_plugin.py

@@ -9,7 +9,7 @@
 
 
 def test_importing_slash_plugin():
-    from backslash.contrib import slash_plugin  # pylint: disable=unused-variable,unused-import
+    from backslash.contrib import slash_plugin  # pylint: disable=unused-variable,unused-import,import-outside-toplevel
 
 
 def test_exception_distilling(traceback):
@@ -75,7 +75,7 @@ def test_failing():
 
 @pytest.fixture
 def installed_plugin(request, server_url):
-    from backslash.contrib import slash_plugin
+    from backslash.contrib import slash_plugin  # pylint: disable=import-outside-toplevel
     plugin = slash_plugin.BackslashPlugin(url=str(server_url), runtoken='blap')
 
     @request.addfinalizer