Merge branch 'master' into mypy

* master:
  [requires.io] dependency update
  [requires.io] dependency update
  [requires.io] dependency update
  [requires.io] dependency update
  update decription
  Add docs-auto Tox environment
  add some tests and a fix
  Revert "Work around flake8 bug"
  Work around flake8 bug
  Un-export parse_host and remove it from the docs.
  Forgot to pin sphinx-rtd-theme
  parse is exported publicly but not documented.
  parse_host is documented but not exported publicly.
  URL.family does not exist.
  Add docs environment to tox config.

# Conflicts:
#	src/hyperlink/_url.py

Author: wsanchez

.travis.yml

@@ -26,6 +26,8 @@ matrix:
       env: TOXENV=test-pypy3,codecov
     - python: "2.7"
       env: TOXENV=packaging-py27
+    - python: "3.8"
+      env: TOXENV=docs
 
 
 install:

docs/api.rst

@@ -61,7 +61,6 @@ URLs have many parts, and URL objects have many attributes to represent them.
 .. autoattribute:: hyperlink.URL.userinfo
 .. autoattribute:: hyperlink.URL.user
 .. autoattribute:: hyperlink.URL.rooted
-.. autoattribute:: hyperlink.URL.family
 
 Low-level functions
 -------------------
@@ -70,6 +69,6 @@ A couple of notable helpers used by the :class:`~hyperlink.URL` type.
 
 .. autoclass:: hyperlink.URLParseError
 .. autofunction:: hyperlink.register_scheme
-.. autofunction:: hyperlink.parse_host
+.. autofunction:: hyperlink.parse
 
 .. TODO: run doctests in docs?

src/hyperlink/__init__.py

@@ -1,16 +1,17 @@
+from ._url import (
+    parse,
+    register_scheme,
+    URL,
+    EncodedURL,
+    DecodedURL,
+    URLParseError,
+)
 
-from ._url import (URL,
-                   parse,
-                   EncodedURL,
-                   DecodedURL,
-                   URLParseError,
-                   register_scheme)
-
-__all__ = [
-    "URL",
+__all__ = (
     "parse",
+    "register_scheme",
+    "URL",
     "EncodedURL",
     "DecodedURL",
     "URLParseError",
-    "register_scheme",
-]
+)

src/hyperlink/_url.py

@@ -797,25 +797,29 @@ class URL(object):
     constructor arguments is below.
 
     Args:
-        scheme: The text name of the scheme.
-        host: The host portion of the network location
-        port: The port part of the network location. If ``None`` or no port is
-            passed, the port will default to the default port of the scheme, if
-            it is known. See the ``SCHEME_PORT_MAP`` and
-            :func:`register_default_port` for more info.
-        path: A tuple of strings representing the slash-separated parts of the
-            path.
-        query: The query parameters, as a dictionary or as an iterable of
-            key-value pairs.
-        fragment: The fragment part of the URL.
-        rooted: Whether or not the path begins with a slash.
-        userinfo: The username or colon-separated username:password pair.
-        uses_netloc: Indicates whether two slashes appear between the scheme
-            and the host (``http://eg.com`` vs. ``mailto:e@g.com``).
-            Set automatically based on scheme.
-
-    All of these parts are also exposed as read-only attributes of URL
-    instances, along with several useful methods.
+       scheme: The text name of the scheme.
+       host: The host portion of the network location
+       port: The port part of the network location. If
+          ``None`` or no port is passed, the port will default to
+          the default port of the scheme, if it is known. See the
+          ``SCHEME_PORT_MAP`` and :func:`register_default_port`
+          for more info.
+       path: A tuple of strings representing the
+          slash-separated parts of the path.
+       query: The query parameters, as a dictionary or
+          as an iterable of key-value pairs.
+       fragment: The fragment part of the URL.
+       rooted: A rooted URL is one which indicates an absolute path.
+          This is True on any URL that includes a host, or any relative URL
+          that starts with a slash.
+       userinfo: The username or colon-separated
+          username:password pair.
+       uses_netloc: Indicates whether two slashes appear
+          between the scheme and the host (``http://eg.com`` vs
+          ``mailto:e@g.com``). Set automatically based on scheme.
+
+    All of these parts are also exposed as read-only attributes of
+    URL instances, along with several useful methods.
 
     .. _RFC 3986: https://tools.ietf.org/html/rfc3986
     .. _RFC 3987: https://tools.ietf.org/html/rfc3987
@@ -880,8 +884,12 @@ def __init__(
         uses_netloc = scheme_uses_netloc(self._scheme, uses_netloc)
         self._uses_netloc = _typecheck("uses_netloc",
                                        uses_netloc, bool, NoneType)
-
-        return
+        # fixup for rooted consistency
+        if self._host:
+            self._rooted = True
+        if (not self._rooted) and self._path and self._path[0] == '':
+            self._rooted = True
+            self._path = self._path[1:]
 
     def get_decoded_url(self, lazy=False):
         # type: (bool) -> DecodedURL
@@ -1051,7 +1059,7 @@ def __eq__(self, other):
         if not isinstance(other, self.__class__):
             return NotImplemented
         for attr in ['scheme', 'userinfo', 'host', 'query',
-                     'fragment', 'port', 'uses_netloc']:
+                     'fragment', 'port', 'uses_netloc', 'rooted']:
             if getattr(self, attr) != getattr(other, attr):
                 return False
         if (

src/hyperlink/test/test_url.py

@@ -1081,6 +1081,42 @@ def test_netloc_slashes(self):
 
         return
 
+    def test_rooted_to_relative(self):
+        # type: () -> None
+        """
+        On host-relative URLs, the C{rooted} flag can be updated to indicate
+        that the path should no longer be treated as absolute.
+        """
+        a = URL(path=['hello'])
+        self.assertEqual(a.to_text(), 'hello')
+        b = a.replace(rooted=True)
+        self.assertEqual(b.to_text(), '/hello')
+        self.assertNotEqual(a, b)
+
+    def test_autorooted(self):
+        # type: () -> None
+        """
+        The C{rooted} flag can be updated in some cases, but it cannot be made
+        to conflict with other facts surrounding the URL; for example, all URLs
+        involving an authority (host) are inherently rooted because it is not
+        syntactically possible to express otherwise; also, once an unrooted URL
+        gains a path that starts with an empty string, that empty string is
+        elided and it becomes rooted, because these cases are syntactically
+        indistinguisable in real URL text.
+        """
+        relative_path_rooted = URL(path=['', 'foo'], rooted=False)
+        self.assertEqual(relative_path_rooted.rooted, True)
+        relative_flag_rooted = URL(path=['foo'], rooted=True)
+        self.assertEqual(relative_flag_rooted.rooted, True)
+        self.assertEqual(relative_path_rooted, relative_flag_rooted)
+
+        attempt_unrooted_absolute = URL(host="foo", path=['bar'], rooted=False)
+        normal_absolute = URL(host="foo", path=["bar"])
+        attempted_rooted_replacement = normal_absolute.replace(rooted=True)
+        self.assertEqual(attempt_unrooted_absolute, normal_absolute)
+        self.assertEqual(normal_absolute.rooted, True)
+        self.assertEqual(attempt_unrooted_absolute.rooted, True)
+
     def test_wrong_constructor(self):
         # type: () -> None
         with self.assertRaises(ValueError):

tox.ini

@@ -5,6 +5,7 @@ envlist =
     test-py{26,27,34,35,36,37,38,py,py3}
     coverage_report
     packaging
+    docs
 
 skip_missing_interpreters = {tty:True:False}
 
@@ -143,7 +144,7 @@ skip_install = True
 
 
 deps =
-    mypy==0.740
+    mypy==0.750
 
 
 commands =
@@ -218,11 +219,53 @@ deps =
 commands =
     coverage combine
     coverage xml -o "{env:COVERAGE_XML}"
-    codecov --file="{env:COVERAGE_XML}" --env \
-        GITHUB_REF GITHUB_COMMIT GITHUB_USER GITHUB_WORKFLOW \
-        TRAVIS_BRANCH TRAVIS_BUILD_WEB_URL TRAVIS_COMMIT TRAVIS_COMMIT_MESSAGE \
-        APPVEYOR_REPO_BRANCH APPVEYOR_REPO_COMMIT \
-        APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED
+    codecov --file="{env:COVERAGE_XML}" --env                 \
+        GITHUB_REF GITHUB_COMMIT GITHUB_USER GITHUB_WORKFLOW  \
+        TRAVIS_BRANCH TRAVIS_BUILD_WEB_URL                    \
+        TRAVIS_COMMIT TRAVIS_COMMIT_MESSAGE                   \
+        APPVEYOR_REPO_BRANCH APPVEYOR_REPO_COMMIT             \
+        APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL                     \
+        APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED
+
+
+##
+# Documentation
+##
+
+[testenv:docs]
+
+description = build documentation
+
+basepython = python3.8
+
+deps =
+    Sphinx==2.2.2
+    sphinx-rtd-theme==0.4.3
+
+commands =
+    sphinx-build                           \
+        -b html -d "{envtmpdir}/doctrees"  \
+        "{toxinidir}/docs"                 \
+        "{toxworkdir}/docs/html"
+
+
+[testenv:docs-auto]
+
+description = build documentation and rebuild automatically
+
+basepython = python3.8
+
+deps =
+    Sphinx==2.2.2
+    sphinx-rtd-theme==0.4.3
+    sphinx-autobuild==0.7.1
+
+commands =
+    sphinx-autobuild                       \
+        -b html -d "{envtmpdir}/doctrees"  \
+        --host=localhost                   \
+        "{toxinidir}/docs"                 \
+        "{toxworkdir}/docs/html"
 
 
 ##