fix bug where module substring paths are not filtered out correctly

Author: BurnzZ

tests/po_lib/__init__.py

@@ -5,7 +5,7 @@
 
 from url_matcher import Patterns
 
-from .. import po_sub_lib  # NOTE: this module contains a PO with @handle_rules
+from .. import po_lib_sub # NOTE: this module contains a PO with @handle_rules
 from web_poet import handle_urls, PageObjectRegistry
 
 

tests/po_sub_lib/__init__.py renamed to tests/po_lib_sub/__init__.py

@@ -14,12 +14,12 @@ class POBase:
     expected_meta: Dict[str, Any]
 
 
-class POSubLibOverriden:
+class POLibSubOverriden:
     ...
 
 
-@handle_urls("sub_example.com", POSubLibOverriden)
-class POSubLib(POBase):
-    expected_overrides = POSubLibOverriden
+@handle_urls("sub_example.com", POLibSubOverriden)
+class POLibSub(POBase):
+    expected_overrides = POLibSubOverriden
     expected_patterns = Patterns(["sub_example.com"])
     expected_meta = {}  # type: ignore

tests/test_overrides.py

@@ -1,7 +1,7 @@
 import pytest
 from url_matcher import Patterns
 
-from tests.po_sub_lib import POSubLib
+from tests.po_lib_sub import POLibSub
 from tests.po_lib import POTopLevel1, POTopLevel2, POTopLevelOverriden2, secondary_registry
 from tests.po_lib.a_module import POModule
 from tests.po_lib.nested_package import PONestedPkg
@@ -22,7 +22,7 @@ def test_list_page_objects_all():
 
     # Ensure that ALL Override Rules are returned as long as the given
     # registry's @handle_urls annotation was used.
-    assert page_objects == POS.union({POSubLib})
+    assert page_objects == POS.union({POLibSub})
     for rule in rules:
         assert rule.instead_of == rule.use.expected_overrides, rule.use
         assert rule.for_patterns == rule.use.expected_patterns, rule.use
@@ -35,9 +35,9 @@ def test_list_page_objects_from_pkg():
     page_objects = {po.use for po in rules}
 
     # Ensure that the "tests.po_lib", which imports another module named
-    # "tests.po_sub_lib" which contains @handle_urls decorators, does not
+    # "tests.po_lib_sub" which contains @handle_urls decorators, does not
     # retrieve the override rules from the external package.
-    assert POSubLib not in page_objects
+    assert POLibSub not in page_objects
 
     assert page_objects == POS
     for rule in rules:

web_poet/overrides.py

@@ -174,12 +174,19 @@ def _filter_from_module(self, module: str) -> Dict[Callable, OverrideRule]:
         return {
             cls: rule
             for cls, rule in self.data.items()
-            if cls.__module__.startswith(module)
+
+            # A "." is added at the end to prevent incorrect matching on cases
+            # where package names are substrings of one another. For example,
+            # if module = "my_project.po_lib", then it filters like so:
+            #   - "my_project.po_lib_sub.POLibSub"                (filtered out)
+            #   - "my_project.po_lib.POTopLevel1"                 (accepted)
+            #   - "my_project.po_lib.nested_package.PONestedPkg"  (accepted)
+            if cls.__module__.startswith(module + ".") or cls.__module__ == module
         }
 
 
 # For ease of use, we'll create a default registry so that users can simply
-# use its `handles_url()` method directly by `from web_poet import handles_url`
+# use its `handle_urls()` method directly by `from web_poet import handle_urls`
 default_registry = PageObjectRegistry()
 handle_urls = default_registry.handle_urls