Fix imports from attrs submodules

hynek · hynek · commit fe3c53eda433 · 2021-12-20T08:56:20.000+01:00
diff --git a/src/attr/converters.py b/src/attr/converters.py
@@ -14,9 +14,10 @@
 
 
 __all__ = [
-    "pipe",
-    "optional",
     "default_if_none",
+    "optional",
+    "pipe",
+    "to_bool",
 ]
 
 
diff --git a/src/attrs/__init__.py b/src/attrs/__init__.py
@@ -14,25 +14,22 @@
     __version_info__,
     assoc,
     cmp_using,
-    converters,
     define,
     evolve,
-    exceptions,
     field,
     fields,
     fields_dict,
-    filters,
     frozen,
     has,
     make_class,
     mutable,
     resolve_types,
-    setters,
     validate,
-    validators,
 )
 from attr._next_gen import asdict, astuple
 
+from . import converters, exceptions, filters, setters, validators
+
 
 __all__ = [
     "__author__",
diff --git a/src/attrs/converters.py b/src/attrs/converters.py
@@ -0,0 +1 @@
+from attr.converters import *  # noqa
diff --git a/src/attrs/exceptions.py b/src/attrs/exceptions.py
@@ -0,0 +1 @@
+from attr.exceptions import *  # noqa
diff --git a/src/attrs/filters.py b/src/attrs/filters.py
@@ -0,0 +1 @@
+from attr.filters import *  # noqa
diff --git a/src/attrs/setters.py b/src/attrs/setters.py
@@ -0,0 +1 @@
+from attr.setters import *  # noqa
diff --git a/src/attrs/validators.py b/src/attrs/validators.py
@@ -0,0 +1 @@
+from attr.validators import *  # noqa
diff --git a/tests/test_next_gen.py b/tests/test_next_gen.py
@@ -390,3 +390,49 @@ def test_smoke(self):
         assert attrs.asdict(inst) == _attr.asdict(
             inst, retain_collection_types=True
         )
+
+
+class TestImports:
+    """
+    Verify our re-imports and mirroring works.
+    """
+
+    def test_converters(self):
+        """
+        Importing from attrs.converters works.
+        """
+        from attrs.converters import optional
+
+        assert optional is _attr.converters.optional
+
+    def test_exceptions(self):
+        """
+        Importing from attrs.exceptions works.
+        """
+        from attrs.exceptions import FrozenError
+
+        assert FrozenError is _attr.exceptions.FrozenError
+
+    def test_filters(self):
+        """
+        Importing from attrs.filters works.
+        """
+        from attrs.filters import include
+
+        assert include is _attr.filters.include
+
+    def test_setters(self):
+        """
+        Importing from attrs.setters works.
+        """
+        from attrs.setters import pipe
+
+        assert pipe is _attr.setters.pipe
+
+    def test_validators(self):
+        """
+        Importing from attrs.validators works.
+        """
+        from attrs.validators import and_
+
+        assert and_ is _attr.validators.and_
diff --git a/tests/typing_example.py b/tests/typing_example.py
@@ -390,3 +390,29 @@ class MatchArgs2:
 # NG versions of asdict/astuple
 attrs.asdict(MatchArgs2(1, 2))
 attrs.astuple(MatchArgs2(1, 2))
+
+
+def importing_from_attr() -> None:
+    """
+    Use a function to keep the ns clean.
+    """
+    from attr.converters import optional
+    from attr.exceptions import FrozenError
+    from attr.filters import include
+    from attr.setters import frozen
+    from attr.validators import and_
+
+    assert optional and FrozenError and include and frozen and and_
+
+
+def importing_from_attrs() -> None:
+    """
+    Use a function to keep the ns clean.
+    """
+    from attrs.converters import optional
+    from attrs.exceptions import FrozenError
+    from attrs.filters import include
+    from attrs.setters import frozen
+    from attrs.validators import and_
+
+    assert optional and FrozenError and include and frozen and and_

Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,10 @@`
`14`	`14`
`15`	`15`
`16`	`16`	`__all__ = [`
`17`		`- "pipe",`
`18`		`- "optional",`
`19`	`17`	`"default_if_none",`
	`18`	`+ "optional",`
	`19`	`+ "pipe",`
	`20`	`+ "to_bool",`
`20`	`21`	`]`
`21`	`22`
`22`	`23`