natlinkcore 5.4.1__tar.gz → 5.4.2.dev1__tar.gz

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: natlinkcore
-Version: 5.4.1
+Version: 5.4.2.dev1
 Summary: Python portion of Natlink, a compatibility module for Dragon Naturally Speaking
 Author-email: "Quintijn Hoogenboom (maintainer)" <q.hoogenboom@antenna.nl>
 Requires-Python: >=3.9
@@ -17,6 +17,7 @@ Requires-Dist: FreeSimpleGUI>=5.1.0
 Requires-Dist: pydebugstring >= 1.0.0.1
 Requires-Dist: dtactions>=1.6.3
 Requires-Dist: platformdirs >= 4.2.0
+Requires-Dist: natlink ~= 5.5, >= 5.5.7
 Requires-Dist: pyenvutils ; extra == "dev"
 Requires-Dist: entry-point-inspector ; extra == "dev"
 Requires-Dist: build ; extra == "dev"
@@ -54,10 +55,52 @@ Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) h
 Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 
 
 
-## Publishing checklist
-Before you bump the version number in __init__.py and publish:
-- Check the pyroject.toml file for package dependancies.  Do you need a specfic or newer version of
-a dependancy such as dtactions?  Then add or update the version # requirement in dtactions.  
+## Version Numbering and Publishing Checklist
+
+While you are developing, use a .dev release number.  When you are ready for alpha or beta or release candidate, use the appropriate version numbers.
+If you are submitting a pull request, the review should review and adjust the version number.  
+The version specificier is in pyroject.toml.
+
+
+The version number progression is explained in [PEP440](https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering).  
+
+Hypothetical Progression of release numbers.  
+
+Working towards 5.4.0:
+- 5.4.0.dev1
+- 5.4.0.dev2
+- 5.4.0.dev_feature_x
+- 5.4.0a1
+- 5.4.0b1dev1
+- 5.4.0b1
+- 5.4.0rc1
+- 5.4.0rc2
+- 5.4.0
+
+Use alpha and beta specifiers (5.4a2, 5.4.b1, etc) to release alphas and betas.
+If you go through a release candidate phase, use 5.4rc1 etc.
+
+Non breaking changes, add a micro version number.  ie from version 5.4.1 to 5.4.2.
+Breaking changes, add a minor version number.
+
+*Before you publish to pypi*:
+- doublecheck the dependancies, especially on natlink.  You may want to specify a minimum natlink (i.e. 5.5.3) and 
+normally you should also specify that natlink has not had a breaking change by specifying the major and minor version numbers are as expected.  Note that this requires a release of natlinkcore if the minor version of natlink changes.  At minimum this will require an update to pyproject.toml and a release to pypi, even if no python code has changed. 
+
+
+
+This is how the version specifier should look for natlink (subsituting the version numbers appropriate).  In this case, we are saying that any natlink 5.5 is required, and that 
+we require greater than 5.5.7 as well because we are relying on a non-breaking change introduced in 5.5.7.
+`    "natlink ~= 5.5, >= 5.5.7"
+`
+Often, the natlink dependancy should just specify the major and minor version:
+`
+    "natlink ~= 5.5"
+`
+
+You could have a case where natlinkcore works with natlink 5.5 and 5.6, you could express this in pyproject.toml as
+    "natlink ~= 5.5, ~= 5.6".  
+
 
 ## Debugging Instructions
 

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/pyproject.toml

@@ -5,7 +5,8 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "natlinkcore"
 authors = [{name = "Quintijn Hoogenboom (maintainer)", email = "q.hoogenboom@antenna.nl"}]
-dynamic = ["version", "description"]
+version="5.4.2.dev1"
+dynamic = [ "description"]
 requires-python = ">=3.9"
 readme = "readme.md"
 dependencies= [
@@ -13,7 +14,8 @@ dependencies= [
     "FreeSimpleGUI>=5.1.0", 
     "pydebugstring >= 1.0.0.1",
     "dtactions>=1.6.3",
-    "platformdirs >= 4.2.0"
+    "platformdirs >= 4.2.0",
+    "natlink ~= 5.5, >= 5.5.7"
 ]
     classifiers=[
         "Development Status :: 4 - Beta",

natlinkcore-5.4.2.dev1/readme.md

@@ -0,0 +1,81 @@
+
+# Natlinkcore 
+
+## More Information
+ Please refer to the README file in the project repository [https://github.com/dictation-toolbox/natlink](https://github.com/dictation-toolbox/natlink) for more information about natlink.
+
+## Installing from PyPi
+You can install from [The Python Package Index (PyPI)](https://pypi.org/) with 
+
+`py -m pip install natlinkcore`
+
+Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.
+
+ 
+## Test Framework
+Tests use the [pytest](https://docs.pytest.org/) framework.  
+For developers, if you are developing on the project, please add tests for any new features or bug
+fixes.  
+
+Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) have build in support for test frameworks and make it easy to run and debug pytest.   see [Visual Studio Code for testing](https://code.visualstudio.com/docs/python/testing).
+
+
+## Building the Python Package Locally
+
+`py -m build` to build the Python package locally.
+
+Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 
+
+
+## Version Numbering and Publishing Checklist
+
+While you are developing, use a .dev release number.  When you are ready for alpha or beta or release candidate, use the appropriate version numbers.
+If you are submitting a pull request, the review should review and adjust the version number.  
+The version specificier is in pyroject.toml.
+
+
+The version number progression is explained in [PEP440](https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering).  
+
+Hypothetical Progression of release numbers.  
+
+Working towards 5.4.0:
+- 5.4.0.dev1
+- 5.4.0.dev2
+- 5.4.0.dev_feature_x
+- 5.4.0a1
+- 5.4.0b1dev1
+- 5.4.0b1
+- 5.4.0rc1
+- 5.4.0rc2
+- 5.4.0
+
+Use alpha and beta specifiers (5.4a2, 5.4.b1, etc) to release alphas and betas.
+If you go through a release candidate phase, use 5.4rc1 etc.
+
+Non breaking changes, add a micro version number.  ie from version 5.4.1 to 5.4.2.
+Breaking changes, add a minor version number.
+
+*Before you publish to pypi*:
+- doublecheck the dependancies, especially on natlink.  You may want to specify a minimum natlink (i.e. 5.5.3) and 
+normally you should also specify that natlink has not had a breaking change by specifying the major and minor version numbers are as expected.  Note that this requires a release of natlinkcore if the minor version of natlink changes.  At minimum this will require an update to pyproject.toml and a release to pypi, even if no python code has changed. 
+
+
+
+This is how the version specifier should look for natlink (subsituting the version numbers appropriate).  In this case, we are saying that any natlink 5.5 is required, and that 
+we require greater than 5.5.7 as well because we are relying on a non-breaking change introduced in 5.5.7.
+`    "natlink ~= 5.5, >= 5.5.7"
+`
+Often, the natlink dependancy should just specify the major and minor version:
+`
+    "natlink ~= 5.5"
+`
+
+You could have a case where natlinkcore works with natlink 5.5 and 5.6, you could express this in pyproject.toml as
+    "natlink ~= 5.5, ~= 5.6".  
+
+
+## Debugging Instructions
+
+Read the detailed developer instructions for setting up the debugger.  You can look in this projects tree until 
+documentation/developers.rst.
+

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/src/natlinkcore/__init__.py

@@ -1,7 +1,10 @@
 '''Python portion of Natlink, a compatibility module for Dragon Naturally Speaking
 The python stuff including test modules'''
 
-__version__="5.4.1"
+import importlib.metadata
+
+__version__ = importlib.metadata.version(__package__)  #version set in pyproject.toml now.
+
 #pylint:disable=
 from pathlib import Path
 

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/src/natlinkcore/config.py

@@ -144,20 +144,19 @@ class NatlinkConfig:
         raise NoGoodConfigFoundException('No natlink config file found, please run configure natlink program\n\t(***configurenatlink***)')
 
 def expand_path(input_path: str) -> str:
-    r"""expand path if it starts with "~" or has environment variables (%XXXX%)
+    r"""expand path if it starts with "~" or starts with an environment variable or name of python package
     
-    Paths can be:
-    
-    - the name of a python package, or a sub directory of a python package
-    - Obsolete: natlink_userdir/...: the directory where natlink.ini is is searched for, either %(NATLINK_USERDIR) or ~/.natlink
-    - ~/...: the home directory
-    - Now: natlink_settingsdir/...: the directory where natlink.ini is is searched for, either %(NATLINK_SETTINGSDIR) or ~/.natlink
-    - ~/...: the home directory
-    - some environment variable: this environment variable is expanded.
-    
-    The Documents directory can be found by "~\Documents"...
-    
-    When nothing to expand, return input
+Paths can be:
+
+- the name of a python package, or a sub directory of a python package
+- natlink_settingsdir/...: the directory where natlink.ini is is searched for, either`%(NATLINK_SETTINGSDIR)` or `~/.natlink`
+- `~/...`: the home directory
+- Obsolete: natlink_userdir/...: instead natlink_settingsdir will be searched for, and a message is thrown. In the config program things are checked more thoroughly.
+- some other environment variable: this environment variable is expanded 
+
+The Documents directory can be found by "~\Documents"...
+
+When there is nothing to expand, just return the input
     """
     expanduser, expandvars, normpath, isdir = os.path.expanduser, os.path.expandvars, os.path.normpath, os.path.isdir
     
@@ -228,10 +227,10 @@ def expand_path(input_path: str) -> str:
     return normpath(env_expanded)
 
 def expand_natlink_settingsdir():
-    """not with envvariables, but special:
+    """Return the location of the natlink config files
     
     if NATLINK_SETTINGSDIR is set: return this, but... it should end with ".natlink"
-    if NATLINK_SETTINGSDIR is NOT set: return Path.home()/'.natlink'
+    if NATLINK_SETTINGSDIR is NOT set: return `Path.home()/'.natlink'`
     """
     normpath = os.path.normpath
     nsd = os.getenv('natlink_settingsdir')

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/src/natlinkcore/configure/natlinkconfig_gui.py

@@ -56,14 +56,14 @@ def collapse(layout, key, visible):
 
 #### Hidden UI Columns ####
 dragonfly2_section = [[sg.Text('Dragonfly', text_color='black')],
-                     [sg.T('Dragonfly user directory:', tooltip='The directory to dragonfly2 user scripts (UserDirectory can also be used)'), sg.Input(Status.getDragonflyUserDirectory(), key='Set_UserDir_Dragonfly2', enable_events=True, readonly=True), sg.FolderBrowse(), sg.B("Clear", key='Clear_UserDir_Dragonfly2', enable_events=True)]]
+                     [sg.T('Dragonfly user directory:', tooltip='The directory to dragonfly2 user scripts (UserDirectory can also be used)'), sg.Input(Status.getDragonflyUserDirectory(), key='Set_UserDir_Dragonfly2', enable_events=False, readonly=False), sg.FolderBrowse(), sg.B("Clear", key='Clear_UserDir_Dragonfly2', enable_events=True)]]
 
 unimacro_section = [[sg.T('Unimacro', text_color='black')],
-                    [sg.T('Unimacro user directory:', tooltip=r'Where the Unimacro user INI files are located, and several other directories (~ or %HOME% allowed)'), sg.I(Status.getUnimacroUserDirectory(), key='Set_UserDir_Unimacro', enable_events=True, readonly=True), sg.FolderBrowse(), sg.B("Clear", key='Clear_UserDir_Unimacro', enable_events=True)]]
+                    [sg.T('Unimacro user directory:', tooltip=r'Where the Unimacro user INI files are located, and several other directories (~ or %HOME% allowed)'), sg.I(Status.getUnimacroUserDirectory(), key='Set_UserDir_Unimacro', enable_events=False, readonly=False), sg.FolderBrowse(), sg.B("Clear", key='Clear_UserDir_Unimacro', enable_events=True)]]
 
 extras_section = [[sg.T('Natlink Loglevel:'),  sg.Combo(default_value=Status.getLogging(), values=("Critical",  "Fatal",  "Error", "Warning", "Info" , "Debug"), key='Set_Logging_Natlink', enable_events=True, auto_size_text=True, readonly=True)],
-                  [sg.T('Autohotkey exe dir:'), sg.I(Status.getAhkExeDir(), key='Set_Exe_Ahk', enable_events=True, readonly=True), sg.FolderBrowse(), sg.B("Clear", key='Clear_Exe_Ahk', enable_events=True)],
-                  [sg.T('Autohotkey scripts dir:'), sg.I(Status.getAhkUserDir(), key='Set_ScriptsDir_Ahk', enable_events=True, readonly=True), sg.FolderBrowse(), sg.B("Clear", key='Clear_ScriptsDir_Ahk', enable_events=True)],
+                  [sg.T('Autohotkey exe dir:'), sg.I(Status.getAhkExeDir(), key='Set_Exe_Ahk', enable_events=False, readonly=False), sg.FolderBrowse(), sg.B("Clear", key='Clear_Exe_Ahk', enable_events=False)],
+                  [sg.T('Autohotkey scripts dir:'), sg.I(Status.getAhkUserDir(), key='Set_ScriptsDir_Ahk', enable_events=False, readonly=False), sg.FolderBrowse(), sg.B("Clear", key='Clear_ScriptsDir_Ahk', enable_events=False)],
                   [sg.T('Natlink GUI Output')],
                   [sg.Output(size=(40,10), echo_stdout_stderr=True, expand_x=True, key='-OUTPUT-')]]
 

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/src/natlinkcore/loader.py

@@ -19,6 +19,7 @@ import debugpy
 
 import natlink
 from natlinkcore.config import LogLevel, NatlinkConfig, expand_path
+from natlinkcore.natlinkutils import idd_reload, idd_exit
 from natlinkcore.readwritefile import ReadWriteFile
 from natlinkcore.callbackhandler import CallbackHandler
 from natlinkcore.singleton import Singleton
@@ -257,6 +258,13 @@ class NatlinkMain(metaclass=Singleton):
             if d_expanded not in sys.path:
                 sys.path.insert(0, d_expanded)
 
+    @staticmethod
+    def _del_dirs_from_path(directories: Iterable[str]) -> None:
+        for d in directories:
+            d_expanded = expand_path(d)
+            if d_expanded in sys.path:
+                sys.path.remove(d_expanded)
+
     def _call_and_catch_all_exceptions(self, fn: Callable[[], None]) -> None:
         try:
             fn()
@@ -455,6 +463,14 @@ class NatlinkMain(metaclass=Singleton):
                 value -= 1
                 self.load_on_begin_utterance = value
             self.trigger_load()
+
+    def on_message_window_callback(self, event):
+        if event == idd_reload:
+            self.trigger_load(force_load=True)
+            natlink.setBeginCallback(self.on_begin_callback)
+            natlink.setChangeCallback(self.on_change_callback)
+        elif event == idd_exit:
+            self.finish()
                 
     def get_user_language(self, DNSuserDirectory):
         """return the user language (default "enx") from Dragon inifiles
@@ -545,6 +561,17 @@ class NatlinkMain(metaclass=Singleton):
             self.trigger_load()
         natlink.setBeginCallback(self.on_begin_callback)
         natlink.setChangeCallback(self.on_change_callback)
+        natlink.setMessageWindow(self.on_message_window_callback)
+
+    def finish(self) -> None:
+        # reverse changes made by start()
+        natlink.setMessageWindow(None)
+        natlink.setChangeCallback(None)
+        natlink.setBeginCallback(None)
+        self.unload_all_loaded_modules()
+        self._del_dirs_from_path(self.config.directories)
+        natlink.active_loader = None
+        self.logger.info('Stopping natlink loader')
 
     def setup_logger(self) -> None:
         for handler in list(self.logger.handlers):

{natlinkcore-5.4.1 → natlinkcore-5.4.2.dev1}/src/natlinkcore/natlinkutils.py

@@ -124,6 +124,11 @@ dgnwordflag_title_mode		= 0x02000000
 dgnwordflag_space_bar		= 0x08000000
 dgnwordflag_topicadded		= 0x40000000
 dgnwordflag_DNS8newwrdProp  = 0x20000000
+
+# The following constants define the window message codes which are passed
+# to the message window callback on menu command activation.
+idd_reload = 32768
+idd_exit = 32769
  
 ## temporary fix, remove as soon as natlinkmain is more secure QH (Febr 2021) 
  

natlinkcore-5.4.1/readme.md

@@ -1,39 +0,0 @@
-
-# Natlinkcore 
-
-## More Information
- Please refer to the README file in the project repository [https://github.com/dictation-toolbox/natlink](https://github.com/dictation-toolbox/natlink) for more information about natlink.
-
-## Installing from PyPi
-You can install from [The Python Package Index (PyPI)](https://pypi.org/) with 
-
-`py -m pip install natlinkcore`
-
-Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.
-
- 
-## Test Framework
-Tests use the [pytest](https://docs.pytest.org/) framework.  
-For developers, if you are developing on the project, please add tests for any new features or bug
-fixes.  
-
-Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) have build in support for test frameworks and make it easy to run and debug pytest.   see [Visual Studio Code for testing](https://code.visualstudio.com/docs/python/testing).
-
-
-## Building the Python Package Locally
-
-`py -m build` to build the Python package locally.
-
-Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 
-
-
-## Publishing checklist
-Before you bump the version number in __init__.py and publish:
-- Check the pyroject.toml file for package dependancies.  Do you need a specfic or newer version of
-a dependancy such as dtactions?  Then add or update the version # requirement in dtactions.  
-
-## Debugging Instructions
-
-Read the detailed developer instructions for setting up the debugger.  You can look in this projects tree until 
-documentation/developers.rst.
-