remove __init__ from global context names; see #111

Author: craigbarratt

custom_components/pyscript/__init__.py

@@ -309,6 +309,7 @@ def glob_read_files(load_paths, apps_config):
                 mod_name = rel_path[0:-3]
                 if mod_name.endswith("/__init__"):
                     rel_import_path = mod_name
+                    mod_name = mod_name[: -len("/__init__")]
                 mod_name = mod_name.replace("/", ".")
                 if path == "":
                     global_ctx_name = f"file.{mod_name}"
@@ -322,14 +323,12 @@ def glob_read_files(load_paths, apps_config):
 
                 if global_ctx_name in ctx2source:
                     # the globs result in apps/APP/__init__.py matching twice, so skip the 2nd time
+                    # also skip apps/APP.py if apps/APP/__init__.py is present
                     continue
 
-                if fq_mod_name.endswith(".__init__"):
-                    fq_mod_name = fq_mod_name[: -len(".__init__")]
-
                 if check_config:
                     app_name = fq_mod_name
-                    i = fq_mod_name.find(".")
+                    i = app_name.find(".")
                     if i >= 0:
                         app_name = app_name[0:i]
                     if not isinstance(apps_config, dict) or app_name not in apps_config:
@@ -365,11 +364,12 @@ def glob_read_files(load_paths, apps_config):
         return ctx2source
 
     load_paths = [
-        # directory, glob, check_config, autoload
+        # path, glob, check_config, autoload
         ["", "*.py", False, True],
-        ["apps", "*.py", True, True],
         ["apps", "*/__init__.py", True, True],
+        ["apps", "*.py", True, True],
         ["apps", "*/**/*.py", False, False],
+        ["modules", "*/__init__.py", False, False],
         ["modules", "*.py", False, False],
         ["modules", "*/**/*.py", False, False],
         ["scripts", "**/*.py", False, True],

custom_components/pyscript/global_ctx.py

@@ -140,27 +140,22 @@ def find_first_file(file_paths):
                 if path.find("/") < 0 or idx < 0:
                     raise ImportError("attempted relative import above parent package")
                 ctx_name = ctx_name[0:idx]
-            idx = ctx_name.rfind(".")
-            if idx >= 0:
-                ctx_name = f"{ctx_name[0:idx]}.{module_name}"
-            file_paths.append([ctx_name, f"{path}/{module_path}.py", path])
+            ctx_name += f".{module_name}"
+            module_info = [ctx_name, f"{path}/{module_path}.py", path]
             path += f"/{module_path}"
-            file_paths.append([f"{ctx_name}.__init__", f"{path}/__init__.py", path])
+            file_paths.append([ctx_name, f"{path}/__init__.py", path])
+            file_paths.append(module_info)
             module_name = ctx_name[ctx_name.find(".") + 1 :]
 
         else:
             if self.rel_import_path is not None and self.rel_import_path.startswith("apps/"):
                 ctx_name = f"apps.{module_name}"
+                file_paths.append([ctx_name, f"apps/{module_path}/__init__.py", f"apps/{module_path}"])
                 file_paths.append([ctx_name, f"apps/{module_path}.py", f"apps/{module_path}"])
-                file_paths.append(
-                    [f"{ctx_name}.__init__", f"apps/{module_path}/__init__.py", f"apps/{module_path}"]
-                )
 
             ctx_name = f"modules.{module_name}"
+            file_paths.append([ctx_name, f"modules/{module_path}/__init__.py", f"modules/{module_path}"])
             file_paths.append([ctx_name, f"modules/{module_path}.py", None])
-            file_paths.append(
-                [f"{ctx_name}.__init__", f"modules/{module_path}/__init__.py", f"modules/{module_path}"]
-            )
 
         #
         # now see if we have loaded it already

docs/reference.rst

@@ -68,16 +68,17 @@ they have changed when the ``pyscript.reload`` service is called, which also rel
   are autoloaded. This is useful for organizing your scripts into subdirectories that are
   related in some way.
 
-``<config>/pyscript/apps/<app_name>.py``
-  all files in the ``apps`` subdirectory with a ``.py`` suffix are autoloaded, provided ``app_name``
-  exists in the pyscript ``yaml`` configuration under ``apps`` (that allows each app to be disabled by
-  simply removing its configuration and reloading).
-
 ``<config>/pyscript/apps/<app_name>/__init__.py``
   every ``__init__.py`` file in a subdirectory in the ``apps`` subdirectory is autoloaded,
   provided ``app_name`` exists in the pyscript ``yaml`` configuration under ``apps``.
-  This form is most convenient for sharing pyscript code, since all the files for one
-  application are stored in its own directory.
+  This package form is most convenient for sharing pyscript code, since all the files for
+  one application are stored in their own directory.
+
+``<config>/pyscript/apps/<app_name>.py``
+  all files in the ``apps`` subdirectory with a ``.py`` suffix are autoloaded, unless the
+  package form above was loaded instead, and provided ``app_name`` exists in the pyscript
+  ``yaml`` configuration under ``apps`` (that allows each app to be disabled by simply
+  removing its configuration and reloading).
 
 Any file name that starts with ``#`` is not loaded, and similarly scripts anywhere below a directory
 name that starts with ``#``, are not loaded. That's a convenient way to disable a specific script or
@@ -95,8 +96,9 @@ created by a script file, or even another Jupyter session.
 
 The optional ``<config>/pyscript/modules`` subdirectory can contain modules (files with a ``.py``
 extension) or packages (directories that contain at least a ``__init__.py`` file) that can be
-imported by any other pyscript files, applications or modules. They are not autoloaded. Any modules
-or packages in ``<config>/pyscript/modules`` that are modified will be unloaded when you call the
+imported by any other pyscript files, applications or modules. The module form is ignored if the
+package form is presemt. They are not autoloaded. Any modules or packages in
+``<config>/pyscript/modules`` that are modified will be unloaded when you call the
 ``pyscript.reload`` service. Importing modules and packages from ``<config>/pyscript/modules`` are
 not restricted if ``allow_all_imports`` is ``False``. Typically common functions or features would
 be implemented in a module or package, and then imported and used by scripts in
@@ -1100,10 +1102,10 @@ lower case are actual fixed names):
   ======================================= ===========================
   ``pyscript/FILE.py``                    ``file.FILE``
   ``pyscript/modules/MODULE.py``          ``modules.MODULE``
-  ``pyscript/modules/MODULE/__init__.py`` ``modules.MODULE.__init__``
+  ``pyscript/modules/MODULE/__init__.py`` ``modules.MODULE``
   ``pyscript/modules/MODULE/FILE.py``     ``modules.MODULE.FILE``
   ``pyscript/apps/APP.py``                ``apps.APP``
-  ``pyscript/apps/APP/__init__.py``       ``apps.APP.__init__``
+  ``pyscript/apps/APP/__init__.py``       ``apps.APP``
   ``pyscript/apps/APP/FILE.py``           ``apps.APP.FILE``
   ``pyscript/scripts/FILE.py``            ``scripts.FILE``
   ``pyscript/scripts/DIR1/FILE.py``       ``scripts.DIR1.FILE``

tests/test_apps_modules.py

@@ -200,7 +200,7 @@ async def state_changed(event):
     ret = await wait_until_done(notify_q)
     assert literal_eval(ret) == [99, "xyz2", "xyz2.other", 1 + 5, 3 * 6, 10 + 30, 50 - 30]
 
-    assert "modules/xyz2 global_ctx=modules.xyz2.__init__;" in caplog.text
+    assert "modules/xyz2 global_ctx=modules.xyz2;" in caplog.text
     assert "func14 global_ctx=scripts.a.b.c.d.func14;" in caplog.text
     assert "ModuleNotFoundError: import of no_such_package not allowed" in caplog.text
     assert "SyntaxError: invalid syntax (bad_module.py, line 2)" in caplog.text

tests/test_reload.py

@@ -69,6 +69,15 @@ def shutdown(trigger_time=None):
 log.info(f"modules/xyz2/other global_ctx={pyscript.get_global_ctx()};")
 
 xyz = 123
+""",
+        #
+        # these shouldn't load since the package takes precedence
+        #
+        f"{conf_dir}/modules/xyz2.py": """
+log.info(f"BOTCH shouldn't load {__name__}")
+""",
+        f"{conf_dir}/apps/world2.py": """
+log.info(f"BOTCH shouldn't load {__name__}")
 """,
     }
 
@@ -123,11 +132,11 @@ async def state_changed(event):
         assert hass.services.has_service("pyscript", "func2")
         assert hass.services.has_service("pyscript", "func3")
 
-        assert "modules/xyz2 global_ctx=modules.xyz2.__init__;" in caplog.text
+        assert "modules/xyz2 global_ctx=modules.xyz2;" in caplog.text
         assert "modules/xyz2/other global_ctx=modules.xyz2.other;" in caplog.text
         assert "hello global_ctx=file.hello xyz=123 xyz2.xyz=123" in caplog.text
         assert "world2.other global_ctx=apps.world2.other" in caplog.text
-        assert "world2 global_ctx=apps.world2.__init__ var1=100, other_abc=987" in caplog.text
+        assert "world2 global_ctx=apps.world2 var1=100, other_abc=987" in caplog.text
 
         #
         # add a new script file
@@ -196,7 +205,7 @@ def func20():
         #
         conf["apps"]["world2"]["var1"] = 200
         await hass.services.async_call("pyscript", "reload", {}, blocking=True)
-        assert "world2 global_ctx=apps.world2.__init__ var1=200, other_abc=987" in caplog.text
+        assert "world2 global_ctx=apps.world2 var1=200, other_abc=987" in caplog.text
         assert "world2.other global_ctx=apps.world2.other shutdown trigger_time=shutdown" in caplog.text
 
         #
@@ -217,7 +226,7 @@ def shutdown(trigger_time=None):
             f"{conf_dir}/apps/world2/other.py"
         ]
         await hass.services.async_call("pyscript", "reload", {}, blocking=True)
-        assert "world2 global_ctx=apps.world2.__init__ var1=200, other_abc=654" in caplog.text
+        assert "world2 global_ctx=apps.world2 var1=200, other_abc=654" in caplog.text
         assert "world2.other global_ctx=apps.world2.other shutdown trigger_time=shutdown" in caplog.text
 
         #
@@ -226,10 +235,10 @@ def shutdown(trigger_time=None):
         #
         for i in range(3):
             assert caplog.text.count("world global_ctx=apps.world xyz=") == 2 + i
-            assert caplog.text.count("world2 global_ctx=apps.world2.__init__ var1=") == 3 + i
+            assert caplog.text.count("world2 global_ctx=apps.world2 var1=") == 3 + i
             assert caplog.text.count("hello global_ctx=file.hello xyz=") == 4 + i
             assert caplog.text.count("modules/xyz2/other global_ctx=modules.xyz2.other") == 2 + i
-            assert caplog.text.count("modules/xyz2 global_ctx=modules.xyz2.__init__") == 2 + i
+            assert caplog.text.count("modules/xyz2 global_ctx=modules.xyz2") == 2 + i
             assert (
                 caplog.text.count("world2.other global_ctx=apps.world2.other shutdown trigger_time=shutdown")
                 == 2
@@ -242,3 +251,8 @@ def shutdown(trigger_time=None):
             )
             if i < 2:
                 await hass.services.async_call("pyscript", "reload", {"global_ctx": "*"}, blocking=True)
+
+        #
+        # make sure files that shouldn't load were not loaded
+        #
+        assert "BOTCH shouldn't load" not in caplog.text