Wip - big update

.git-blame-ignore-revs

@@ -18,3 +18,5 @@ cb040bf0656ab6b3c019fadc6adf98c7d4ba01ea
 f7addad546672815db9293f772db71c57521f8e8
 fbeec4c4322b7a1f8dc4cd82ac3c10e6c313901a
 
+# google style docstrings
+e17857d4369d57961b6f75385fd1e5a1d2434869

.gitignore

@@ -143,3 +143,17 @@ cython_debug/
 # Ignore the lib folder for pysimplesql
 !**pysimplesql/lib/
 !**pysimplesql/lib/**
+
+# Ignore vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix

.libcst.codemod.yaml

@@ -0,0 +1,17 @@
+# String that LibCST should look for in code which indicates that the
+# module is generated code.
+generated_code_marker: '@generated'
+# Command line and arguments for invoking a code formatter. Anything
+# specified here must be capable of taking code via stdin and returning
+# formatted code via stdout.
+formatter: ['black', '-']
+# List of regex patterns which LibCST will evaluate against filenames to
+# determine if the module should be touched.
+blacklist_patterns: []
+# List of modules that contain codemods inside of them.
+modules:
+- 'libcst.codemod.commands'- 'autotyping'
+# Absolute or relative path of the repository root, used for providing
+# full-repo metadata. Relative paths should be specified with this file
+# location as the base.
+repo_root: '.'

doc_examples/ColumnInfo.1.py

@@ -1,22 +1,17 @@
-# Set the null value default for INTEGERS to 10;
+# Set the null value default for 'int' to 10;
 # When reading from the database, if an INTEGER is Null, this value will be set
-frm["Journal"].column_info.set_null_default("INTEGER", 10)
+frm["Journal"].column_info.set_null_default("int", 10)
 
 # Provide a complete custom set of null defaults:
 # note: All supported keys must be included
 null_defaults = {
-    "TEXT": "New Record",
-    "VARCHAR": "New Record",
-    "CHAR": "New Record",
-    "INTEGER": 10,
-    "REAL": 100.0,
-    "DOUBLE": 90.0,
-    "FLOAT": 80.0,
-    "DECIMAL": 70.0,
-    "BOOLEAN": 1,
-    "TIME": lambda x: datetime.now().strftime("%H:%M:%S"),
-    "DATE": lambda x: date.today().strftime("%Y-%m-%d"),
-    "TIMESTAMP": lambda x: datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
-    "DATETIME": lambda x: datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+    "str": lang.description_column_str_null_default,
+    "int": 10,
+    "float": 90.0,
+    "Decimal": Decimal("70.0"),
+    "bool": 1,
+    "time": lambda: dt.datetime.now().strftime(TIME_FORMAT),
+    "date": lambda: dt.date.today().strftime(DATE_FORMAT),
+    "datetime": lambda: dt.datetime.now().strftime(DATETIME_FORMAT),
 }
 frm["Journal"].column_info.set_null_defaults(null_defaults)

doc_scripts/griffe_extension.py

@@ -0,0 +1,36 @@
+import ast
+import re
+
+from griffe import Extension, Object, ObjectNode
+
+
+class RegexUrl(Extension):
+    IGNORE = ["sg"]  #
+
+    def regex_replace(self, input_string: str, regex_pattern, prefix: str):
+        compiled_pattern = re.compile(regex_pattern)
+
+        def replace_function(match):
+            parts = match.group(1).split(".")
+            if any(parts[0].startswith(prefix) for prefix in self.IGNORE):
+                return match.group(0)
+
+            # get text section of url, we will only use the last obj
+            text = parts[-1]
+
+            fn_suffix = ""
+            if match.group(2):
+                # pass () as html encoding
+                fn_suffix = "()"
+            complete_path = prefix + match.group(1)
+            return f"[{text}{fn_suffix}][{complete_path}]"
+
+        return compiled_pattern.sub(replace_function, input_string)
+
+    def on_instance(self, node: ast.AST | ObjectNode, obj: Object) -> None:
+        if obj.docstring:
+            # regex pattern matches a valid non-private class name or function, with or without a '()' at the end
+            regex_pattern = r"\`([A-Za-z][A-Za-z0-9_.]*)(\(\))*\`"
+            obj.docstring.value = self.regex_replace(
+                obj.docstring.value, regex_pattern, "pysimplesql.pysimplesql."
+            )

docs/index.md

@@ -1,17 +1,5 @@
-# Welcome to MkDocs
+# API Reference (more pages to come)
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+::: pysimplesql.pysimplesql
+    options:
+      members_order: source

examples/Flatfile_examples/csv_test.py

@@ -13,14 +13,14 @@
 # Create a simple layout for working with our flatfile data.
 # Note that you can set a specific table name to use, but here I am just using the defaul 'Flatfile'
 # Lets also use some sortable headers so that we can rearrange the flatfile data when saving
-headings=ss.TableHeadings(sort_enable=True)
-headings.add_column('name', 'Name', width=12)
-headings.add_column('address', 'Address', width=25)
-headings.add_column('phone', 'Phone #', width=10)
-headings.add_column('email', 'EMail', width=25)
+table_builder = ss.TableBuilder(num_rows=10)
+table_builder.add_column('name', 'Name', width=12)
+table_builder.add_column('address', 'Address', width=25)
+table_builder.add_column('phone', 'Phone #', width=10)
+table_builder.add_column('email', 'EMail', width=25)
 
 layout = [
-    [ss.selector('Flatfile', sg.Table, num_rows=10, headings=headings)],
+    [ss.selector('Flatfile', table_builder)],
     [ss.field('Flatfile.name')],
     [ss.field('Flatfile.address')],
     [ss.field('Flatfile.phone')],

examples/MSAccess_examples/install_java.py

@@ -6,7 +6,9 @@
 run.  This also serves as an example to automatically download a local Java installation
 for your own projects.
 """
+import configparser
 import os
+import pathlib
 import pysimplesql as ss
 import PySimpleGUI as sg
 import subprocess
@@ -17,11 +19,19 @@
     sg.popup_error("You must `pip install install-jdk` to use this example")
     exit(0)
 
+SETTINGS_FILE = pathlib.Path.cwd() / "settings.ini"
+
 
 # -------------------------------------------------
 # ROUTINES TO INSTALL JAVA IF USER DOES NOT HAVE IT
 # -------------------------------------------------
-def _is_java_installed():
+def _is_java_installed() -> bool:
+    if "JAVA_HOME" in os.environ:
+        return True
+    previous_jre = load_setting("General", "java_home")
+    if previous_jre:
+        os.environ["JAVA_HOME"] = previous_jre
+        return True
     # Returns True if Java is installed, False otherwise
     try:
         subprocess.check_output(["which", "java"])
@@ -64,8 +74,9 @@ def java_check_install() -> bool:
                 pa.close()
                 return False
             pa.close()
-            # set JAVA_HOME
+            # Set JAVA_HOME and save it to settings
             os.environ["JAVA_HOME"] = java_home
+            save_setting("General", "java_home", java_home)
         else:
             url = jdk.get_download_url(11, jre=True)
             sg.popup(
@@ -80,6 +91,33 @@ def java_check_install() -> bool:
     return True
 
 
+def save_setting(section: str, key: str, value: str) -> None:
+    config = configparser.ConfigParser()
+    config.read(SETTINGS_FILE)
+
+    # Create the section if it doesn't exist
+    if section not in config:
+        config[section] = {}
+
+    # Set the value in the section
+    config[section][key] = value
+
+    # Save the settings to the file
+    with open(SETTINGS_FILE, "w") as config_file:
+        config.write(config_file)
+
+
+def load_setting(section: str, key: str, default=None) -> str:
+    config = configparser.ConfigParser()
+    config.read(SETTINGS_FILE)
+
+    # Check if the section and key exist
+    if section in config and key in config[section]:
+        return config[section][key]
+
+    return default
+
+
 if __name__ == "__main__":
     if java_check_install():
         print("Java is installed.")

examples/MSAccess_examples/journal_msaccess.py

@@ -16,13 +16,13 @@
 # -------------------------
 # Define the columns for the table selector using the TableHeading convenience class.
 # This will also allow sorting!
-headings = ss.TableHeadings(sort_enable=True)
-headings.add_column("title", "Title", width=40)
-headings.add_column("entry_date", "Date", width=10)
-headings.add_column("mood_id", "Mood", width=20)
+table_builder = ss.TableBuilder(num_rows=10)
+table_builder.add_column("title", "Title", width=40)
+table_builder.add_column("entry_date", "Date", width=10)
+table_builder.add_column("mood_id", "Mood", width=20)
 
 layout = [
-    [ss.selector("Journal", sg.Table, num_rows=10, headings=headings)],
+    [ss.selector("Journal", table_builder)],
     [ss.actions("Journal")],
     [
         ss.field("Journal.entry_date"),

examples/MySQL_examples/docker/Docker_create.py

@@ -45,7 +45,7 @@
 with tqdm(desc="Starting up container") as pbar:
     container.reload()
     while True:
-        if "Status" in container.attrs["State"]:  # noqa: SIM102
+        if "Status" in container.attrs["State"]:
             if container.attrs["State"]["Status"] == "running":
                 break
         time.sleep(1)

examples/MySQL_examples/journal_mysql_docker.py

@@ -25,13 +25,13 @@
 # -------------------------
 # Define the columns for the table selector using the TableHeading convenience class.
 # This will also allow sorting!
-headings = ss.TableHeadings(sort_enable=True)
-headings.add_column("title", "Title", width=40)
-headings.add_column("entry_date", "Date", width=10)
-headings.add_column("mood_id", "Mood", width=20)
+table_builder = ss.TableBuilder(num_rows=10)
+table_builder.add_column("title", "Title", width=40)
+table_builder.add_column("entry_date", "Date", width=10)
+table_builder.add_column("mood_id", "Mood", width=20)
 
 layout = [
-    [ss.selector("Journal", sg.Table, num_rows=10, headings=headings)],
+    [ss.selector("Journal", table_builder)],
     [ss.actions("Journal")],
     [
         ss.field("Journal.entry_date"),

examples/PostgreSQL_examples/docker/Docker_create.py

@@ -45,7 +45,7 @@
 with tqdm(desc="Starting up container") as pbar:
     container.reload()
     while True:
-        if "Status" in container.attrs["State"]:  # noqa: SIM102
+        if "Status" in container.attrs["State"]:
             if container.attrs["State"]["Status"] == "running":
                 break
         time.sleep(1)

examples/PostgreSQL_examples/journal_postgres_docker.py

@@ -25,13 +25,13 @@
 # -------------------------
 # Define the columns for the table selector using the TableHeading convenience class.
 # This will also allow sorting!
-headings = ss.TableHeadings(sort_enable=True)
-headings.add_column("title", "Title", width=40)
-headings.add_column("entry_date", "Date", width=10)
-headings.add_column("mood_id", "Mood", width=20)
+table_builder = ss.TableBuilder(num_rows=10)
+table_builder.add_column("title", "Title", width=40)
+table_builder.add_column("entry_date", "Date", width=10)
+table_builder.add_column("mood_id", "Mood", width=20)
 
 layout = [
-    [ss.selector("Journal", sg.Table, num_rows=10, headings=headings)],
+    [ss.selector("Journal", table_builder)],
     [ss.actions("Journal")],
     [
         ss.field("Journal.entry_date"),