Merge branch 'master' into pylint

Author: Gallaecio

.travis.yml

@@ -4,20 +4,22 @@ matrix:
   include:
     - python: 3.8
       env: TOXENV=security
+    - python: 3.8
+      env: TOXENV=flake8
     - python: 3.8
       env: TOXENV=pylint
     - python: 2.7
       env: TOXENV=py27
     - python: pypy
       env: TOXENV=pypy
-    - python: 3.4
-      env: TOXENV=py34
     - python: 3.5
       env: TOXENV=py35
     - python: 3.6
       env: TOXENV=py36
     - python: 3.7
       env: TOXENV=py37
+    - python: 3.8
+      env: TOXENV=py38
     - python: pypy3
       env: TOXENV=pypy3
     - python: 3.7
@@ -51,7 +53,7 @@ deploy:
     tags: true
     all_branches: true
     repo: scrapy/w3lib
-    condition: "$TOXENV == py27"
+    condition: "$TOXENV == py37"
 
 cache:
   directories:

README.rst

@@ -27,7 +27,7 @@ This is a Python library of web-related functions, such as:
 Requirements
 ============
 
-Python 2.7 or Python 3.4+
+Python 2.7 or Python 3.5+
 
 Install
 =======

conftest.py

@@ -1 +1,11 @@
 collect_ignore = ["setup.py"]
+
+
+def pytest_collection_modifyitems(session, config, items):
+    # Avoid executing tests when executing `--flake8` flag (pytest-flake8)
+    try:
+        from pytest_flake8 import Flake8Item
+        if config.getoption('--flake8'):
+            items[:] = [item for item in items if isinstance(item, Flake8Item)]
+    except ImportError:
+        pass

docs/conf.py

@@ -26,6 +26,7 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    'hoverxref.extension',
     'notfound.extension',
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
@@ -250,11 +251,18 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'python': ('http://docs.python.org/3', None),
+    'pytest': ('https://docs.pytest.org/en/latest', None),
+    'python': ('https://docs.python.org/3', None),
+    'scrapy': ('https://scrapy.readthedocs.io/en/latest', None),
     'tox': ('https://tox.readthedocs.io/en/latest', None),
 }
 
 
-# --- Nitpicking options ------------------------------------------------------
+# -- Nitpicking options -------------------------------------------------------
 
 nitpicky = True
+
+
+# -- sphinx-hoverxref options -------------------------------------------------
+
+hoverxref_auto_ref = True

docs/index.rst

@@ -39,16 +39,15 @@ Install
 Tests
 =====
 
-`pytest`_ is the preferred way to run tests. Just run: ``pytest`` from the
-root directory to execute tests using the default Python interpreter.
+:doc:`pytest <pytest:index>` is the preferred way to run tests. Just run:
+``pytest`` from the root directory to execute tests using the default Python
+interpreter.
 
 :doc:`tox <tox:index>` could be used to run tests for all supported Python
 versions. Install it (using 'pip install tox') and then run ``tox`` from
 the root directory - tests will be executed for all available
 Python interpreters.
 
-.. _pytest: https://docs.pytest.org/en/latest/
-
 
 Changelog
 =========
@@ -59,12 +58,10 @@ Changelog
 History
 -------
 
-The code of w3lib was originally part of the `Scrapy framework`_ but was later
-stripped out of Scrapy, with the aim of make it more reusable and to provide a
-useful library of web functions without depending on Scrapy.
-
-.. _Scrapy framework: http://scrapy.org
-.. _NEWS file: https://github.com/scrapy/w3lib/blob/master/NEWS
+The code of w3lib was originally part of the :doc:`Scrapy framework
+<scrapy:index>` but was later stripped out of Scrapy, with the aim of make it
+more reusable and to provide a useful library of web functions without
+depending on Scrapy.
 
 
 Indices and tables

docs/requirements.txt

@@ -1,3 +1,4 @@
 sphinx
+sphinx-hoverxref
 sphinx-notfound-page
 sphinx_rtd_theme

pytest.ini

@@ -1,2 +1,15 @@
 [pytest]
 doctest_optionflags = ALLOW_UNICODE ALLOW_BYTES
+flake8-ignore =
+    docs/conf.py E121 E122 E265 E401 E501
+    tests/test_encoding.py E128 E221 E241 E302 E401 E501 E731
+    tests/test_form.py E265 E501
+    tests/test_html.py E123 E128 E241 E303 E501 E502
+    tests/test_http.py E128 E261 E302 W291
+    tests/test_url.py E126 E127 E128 E226 E261 E303 E501 W293 W391
+    w3lib/encoding.py E126 E128 E302 E305 E401 E501
+    w3lib/form.py E402 E501 E721
+    w3lib/html.py E128 E302 E501 E502 W504
+    w3lib/http.py E501
+    w3lib/url.py E128 E261 E302 E305 E501 F841 W291 W293 W504
+    w3lib/util.py E302

setup.py

@@ -21,10 +21,10 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: Implementation :: CPython',
         'Programming Language :: Python :: Implementation :: PyPy',
         'Topic :: Internet :: WWW/HTTP',

tests/test_html.py

@@ -211,7 +211,7 @@ def test_with_escape_chars(self):
         # text with escape chars
         self.assertEqual(replace_escape_chars(u'escape\n\n'), u'escape')
         self.assertEqual(replace_escape_chars(u'escape\n', which_ones=('\t',)), u'escape\n')
-        self.assertEqual(replace_escape_chars(u'escape\tchars\n', which_ones=('\t')), 'escapechars\n')
+        self.assertEqual(replace_escape_chars(u'escape\tchars\n', which_ones=('\t',)), 'escapechars\n')
         self.assertEqual(replace_escape_chars(u'escape\tchars\n', replace_by=' '), 'escape chars ')
         self.assertEqual(replace_escape_chars(u'escape\tchars\n', replace_by=u'\xa3'), u'escape\xa3chars\xa3')
         self.assertEqual(replace_escape_chars(u'escape\tchars\n', replace_by=b'\xc2\xa3'), u'escape\xa3chars\xa3')

tox.ini

@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py27, pypy, py34, py35, py36, py37, pypy3, docs
+envlist = py27, pypy, py35, py36, py37, py38, pypy3, docs
 
 [testenv]
 deps =
@@ -22,6 +22,14 @@ deps =
 commands =
     bandit -r -c .bandit.yml {posargs:w3lib}
 
+[testenv:flake8]
+basepython = python3
+deps =
+    {[testenv]deps}
+    pytest-flake8
+commands =
+    pytest --flake8
+
 [testenv:pylint]
 deps =
     {[testenv]deps}