manen 0.3.0.dev4__tar.gz → 0.3.0.dev5__tar.gz

{manen-0.3.0.dev4 → manen-0.3.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: manen
-Version: 0.3.0.dev4
+Version: 0.3.0.dev5
 Summary: An implementation of the Page Object Model design pattern, and other utilities for web scraping and automation.
 Project-URL: Changes, https://kodaho.github.io/manen/changelog.html
 Project-URL: Documentation, https://kodaho.github.io/manen/

{manen-0.3.0.dev4 → manen-0.3.0.dev5}/docs/source/user_guide/page_object_model.ipynb

@@ -538,7 +538,7 @@
         "        Wait(5),\n",
         "    ]\n",
         "\n",
-        "    dont_exist: Annotated[str, CSS('i-dont-exist'), Default(None)]\n",
+        "    dont_exist: Annotated[str | None, CSS('i-dont-exist'), Default(None)]\n",
         "\n",
         "page = SearchResultPage(driver)"
       ]
@@ -553,6 +553,14 @@
         "assert page.dont_exist is None"
       ]
     },
+    {
+      "cell_type": "markdown",
+      "id": "fb45e6e5",
+      "metadata": {},
+      "source": [
+        "Note that when using a default value, the type specified in the annotation should be coherent with the default value, with the restriction that only not-None type is allowed. For example, you can't have something like `Annotated[int | str, CSS('i-dont-exist'), Default('not here')]`."
+      ]
+    },
     {
       "cell_type": "markdown",
       "id": "53a197b2-4723-41a8-a4a5-582614a25440",

{manen-0.3.0.dev4 → manen-0.3.0.dev5}/manen/__init__.py

@@ -17,4 +17,4 @@ use the module :py:mod:`~manen.finder` without :py:mod:`~manen.browser` or
 :py:mod:`~manen.page_object_model` without :py:mod:`~manen.browser`.
 """
 
-__version__ = "0.3.0.dev4"
+__version__ = "0.3.0.dev5"

{manen-0.3.0.dev4 → manen-0.3.0.dev5}/manen/page_object_model/config.py

@@ -1,7 +1,9 @@
 from dataclasses import dataclass
-from typing import Any, get_origin
+from types import NoneType, UnionType
+from typing import Any, get_args, get_origin
 
 from manen.page_object_model.dom import Flag
+from manen.page_object_model.exceptions import SelectorConfigError, TypeConfigError
 
 __all__ = ("CSS", "Default", "LinkText", "PartialLinkText", "Wait", "XPath")
 
@@ -85,8 +87,22 @@ class Config:
     def from_annotation_item(cls, field, annotation):
         origin = get_origin(type_ := annotation.__origin__)
         kwargs = {"name": field}
+
         if origin is list:
-            kwargs.update({"element_type": type_.__args__[0], "many": True})
+            kwargs.update({"element_type": get_args(type_)[0], "many": True})
+
+        elif origin is UnionType:
+            args = [arg for arg in get_args(type_) if arg is not NoneType]
+            if len(args) != 1:
+                raise TypeConfigError(field, args)
+            kwargs.update({"element_type": args[0], "many": False})
+
         else:
             kwargs.update({"element_type": type_, "many": False})
-        return cls.merge(annotation.__metadata__, **kwargs)
+
+        config = cls.merge(annotation.__metadata__, **kwargs)
+
+        if len(config.selectors) == 0:
+            raise SelectorConfigError(field)
+
+        return config

manen-0.3.0.dev5/manen/page_object_model/exceptions.py

@@ -0,0 +1,21 @@
+from manen.exceptions import ManenException
+
+
+class TypeConfigError(TypeError, ManenException):
+    def __init__(self, field, types):
+        self.field = field
+        self.types = types
+
+    def __str__(self):
+        return (
+            f"Field '{self.field}' should have exactly one non-None type in its annotation, but "
+            f"get {self.types}"
+        )
+
+
+class SelectorConfigError(ValueError, ManenException):
+    def __init__(self, field):
+        self.field = field
+
+    def __str__(self):
+        return f"At least one selector should be specified in the annotation of '{self.field}'"