QGIS refactors - kamangir/bolt#746

README.md

@@ -102,4 +102,4 @@ graph LR
 
 [![pylint](https://github.com/kamangir/blue-geo/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/blue-geo/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/blue-geo/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/blue-geo/actions/workflows/pytest.yml) [![bashtest](https://github.com/kamangir/blue-geo/actions/workflows/bashtest.yml/badge.svg)](https://github.com/kamangir/blue-geo/actions/workflows/bashtest.yml) [![PyPI version](https://img.shields.io/pypi/v/blue-geo.svg)](https://pypi.org/project/blue-geo/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/blue-geo)](https://pypistats.org/packages/blue-geo)
 
-built by 🌀 [`blue_options-4.190.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌐 [`blue_geo-4.967.1`](https://github.com/kamangir/blue-geo).
+built by 🌀 [`blue_options-4.190.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌐 [`blue_geo-4.969.1`](https://github.com/kamangir/blue-geo).

blue_geo/QGIS/console/QGIS.py

@@ -5,11 +5,14 @@
 
 
 if not QGIS_is_live:
+    from dependency import list_of_dependencies
     from .application import BLUE_GEO_QGIS_APPLICATION
     from .help import Q_help
+    from .graphics import Q_screenshot
     from .logger import Q_log, Q_verbose, Q_clear
-    from dependency import list_of_dependencies
     from .mock import QgsSettings
+    from .objects import Q_get_thing_path, Q_upload
+    from .path import Q_open_path
     from .testing import Q_test
 
     ABCLI_OBJECT_ROOT = ""
@@ -50,19 +53,20 @@ def Q_list_recent_projects() -> str:
     return ",".join(output)
 
 
-def Q_QGIS_help():
-    Q_log("Q_list_recent_projects()", "list recent projects.")
-
-
 class ABCLI_QGIS:
     def __init__(self):
         self.app_list: List[BLUE_GEO_QGIS_APPLICATION] = []
 
     def add_app(self, app: BLUE_GEO_QGIS_APPLICATION):
         self.app_list += [app]
 
-    def help(log):
+    def help_(self):
         Q_log("Q.clear", "clear Python Console.")
+        Q_log("Q.list_recent_projects", "list recent projects.")
+        Q_log('Q.open(" | <object-name> | layer | project")', "open.")
+        Q_log("Q.screenshot([filename],[object_name])", "screenshot.")
+        Q_log("Q.test", "test Q.")
+        Q_log('Q.upload(" | <object-name> | layer | project | qgz")', "upload.")
 
     def intro(self):
         Q_log(self.version)
@@ -89,9 +93,27 @@ def clear(self):
     def help(self):
         Q_help(clear=True)
 
+    def list_recent_projects(self):
+        Q_list_recent_projects()
+
+    def open(thing="object"):
+        Q_open_path(Q_get_thing_path(thing))
+
     @property
     def test(self):
         Q_test()
 
+    def upload(
+        self,
+        thing: str = "",
+        dryrun: bool = False,
+    ):
+        Q_upload(
+            thing=thing,
+            dryrun=dryrun,
+        )
+
 
 QGIS = ABCLI_QGIS()
+
+Q = QGIS

blue_geo/QGIS/console/file_load.py

@@ -1,6 +1,6 @@
 import yaml
 
 
-def Q_load_yaml(filename):
+def Q_load_yaml(filename: str):
     with open(filename, "r") as file:
         return yaml.safe_load(file)

blue_geo/QGIS/console/file_save.py

@@ -0,0 +1,21 @@
+from typing import List
+
+if not QGIS_is_live:
+    from .logger import Q_log
+
+
+def Q_save_text(
+    filename: str,
+    text: List[str],
+    log: bool = True,
+):
+    with open(filename, "w") as fp:
+        fp.writelines([string + "\n" for string in text])
+
+    if log:
+        Q_log(
+            "Q_save_text: {:,} line(s) -> {}".format(
+                len(text),
+                filename,
+            )
+        )

blue_geo/QGIS/console/graphics.py

@@ -17,9 +17,7 @@ def Q_refresh(deep=False):
         iface.mapCanvas().refresh()
 
 
-def Q_screenshot(
-    filename="",
-):
+def Q_screenshot(filename=""):
     filename = Q_file_path_in_object(
         filename=filename if filename else f"{Q_timestamp()}.png",
         object_name=Q_project.name,
@@ -28,7 +26,3 @@ def Q_screenshot(
     qgis.utils.iface.mapCanvas().saveAsImage(filename)
 
     Q_log(filename, icon="🖼️")
-
-
-def Q_graphics_help():
-    Q_log("Q_screenshot([filename],[object_name])", "screenshot.")

blue_geo/QGIS/console/help.py

@@ -1,29 +1,18 @@
 if not QGIS_is_live:
-    from .alias import Q_alias_help
-    from .graphics import Q_graphics_help
     from .layer import Q_layer
     from .logger import Q_clear
-    from .objects import Q_objects_help
-    from .QGIS import QGIS, Q_QGIS_help
+    from .QGIS import QGIS
     from .project import Q_project
-    from .testing import Q_testing_help
 
 
 def Q_help(clear=False):
     if clear:
-        Q_clear()
+        Q_clear(log=False)
 
     for thing in [
         Q_layer,
         Q_project,
     ] + [app for app in QGIS.app_list if app.name != "template"]:
         thing.help()
 
-    for func in [
-        Q_graphics_help,
-        Q_testing_help,
-        Q_objects_help,
-        Q_QGIS_help,
-        Q_alias_help,
-    ]:
-        func()
+    QGIS.help_()

blue_geo/QGIS/console/logger.py

@@ -8,7 +8,7 @@
     from .mock import iface
 
 
-def Q_clear():
+def Q_clear(log: bool = True):
     # https://gis.stackexchange.com/a/480025/250728
     from qgis.PyQt.QtWidgets import QDockWidget
 
@@ -17,7 +17,7 @@ def Q_clear():
 
     QGIS.intro()
 
-    Q_seed("clear")
+    Q_seed("clear", log=log)
 
 
 def Q_hr(length: int = 3):

blue_geo/QGIS/console/objects.py

@@ -3,7 +3,6 @@
 if not QGIS_is_live:
     from .logger import Q_log
     from .layer import Q_layer
-    from .path import Q_open_path
     from .project import Q_project
     from .seed import Q_seed
 
@@ -67,10 +66,6 @@ def Q_file_path_in_object(
     )
 
 
-def Q_open(thing="object"):
-    Q_open_path(Q_get_thing_path(thing))
-
-
 def Q_upload(
     thing="object",
     dryrun: bool = False,
@@ -83,7 +78,3 @@ def Q_upload(
         ],
         dryrun=dryrun,
     )
-
-
-def Q_objects_help():
-    Q_log('Q_open(" | <object-name> | layer | project")', "open.")

blue_geo/QGIS/console/seed.py

@@ -4,7 +4,8 @@
 import random
 
 if not QGIS_is_live:
-    from logger import Q_log
+    from .file_save import Q_save_text
+    from .logger import Q_log
 
 blue_geo_QGIS_path_server = os.path.join(
     os.getenv("HOME", ""),
@@ -17,6 +18,7 @@
 def Q_seed(
     command: Union[str, List[str]],
     dryrun: bool = False,
+    log: bool = True,
 ):
     if isinstance(command, list):
         command = " ".join(command)
@@ -27,13 +29,14 @@ def Q_seed(
     )
 
     if not dryrun:
-        with open(
-            os.path.join(
+        Q_save_text(
+            filename=os.path.join(
                 blue_geo_QGIS_path_server,
                 f"{command_name}.command",
             ),
-            "w",
-        ) as f:
-            f.write(command)
+            text=[command],
+            log=log,
+        )
 
-    Q_log(command_name, command, icon="🌱")
+    if log:
+        Q_log(command_name, command, icon="🌱")

blue_geo/QGIS/console/testing.py

@@ -40,7 +40,3 @@ def Q_test():
         Q_hr()
 
     Q_log(f"ran {description}.", icon="✅")
-
-
-def Q_testing_help():
-    Q_log("Q.test", f"test Q.")

blue_geo/QGIS/seed.py

@@ -33,6 +33,7 @@ def generate_seed(
                 "console/layer",
                 "console/file",
                 "console/file_load",
+                "console/file_save",
                 "console/graphics",
                 "console/objects",
                 "console/path",
@@ -41,7 +42,6 @@ def generate_seed(
                 "console/seed",
                 "console/help",
                 "console/QGIS",
-                "console/alias",
             ]
         ]
         + sorted(glob(f"{apps_path}/*.py"))

blue_geo/__init__.py

@@ -9,7 +9,7 @@
 
 DESCRIPTION = f"{ICON} AI for a Blue Planet."
 
-VERSION = "4.967.1"
+VERSION = "4.969.1"
 
 REPO_NAME = "blue-geo"