11"""dtactions __init__
22
3- including utility functions,
4- - getThisDir, for getting the calling directory of module (in site-packages, also when this is a valid symlink),
5- - findInSitePackages, supporting getThisDir
6- - checkDirectory, check existence of directory, with create=True, do create if directory does not exist yet.
73
84Note: -as user, having pipped the package, the scripts run from the site-packages directory,
95 no editing in source files is meant to be done
10- -as developer, you need to clone the package, then `build_package` and,
6+ -as developer, you need to clone the package,
117 after a `pip uninstall dtactions` do: `pip install -e .` from the root of this project.
128
13- Start with the following lines near the top of your python file:
9+
10+ You can retrieve the DtactionsDirectory and DtactionsUserDirectory from here:
1411
1512```
16- try:
17- from dtactions.__init__ import getThisDir, checkDirectory
18- except ModuleNotFoundError:
19- print(f'Run this module after "build_package" and "flit install --symlink"\n ')
20- raise
21-
22- thisDir = getThisDir(__file__) # optional: ... , warnings=True)
13+ from dtactions import getDtactionsDirectory, getDtactionsUserDirectory
14+ print(f'dtactions_directory: "{getDtactionsDirectory()}"')
15+ print(f'dtactions_user_directory: "{getDtactionsUserDirectory()}"')
16+
2317```
2418
25- Also retrieve the DtactionsDirectory and DtactionsUserDirectory from here :
19+ Or with the "Path" versions :
2620
2721```
28- from Dtactionscore.__init__ import getDtactionsDirectory, getDtactionsUserDirectory
29-
30- print(f'DtactionsDirectory: {getDtactionsDirectory()} )
31- print(f'DtactionsUserDirectory: {getDtactionsUserDirectory ()})
22+ from dtactions import getDtactionsPath, getDtactionsUserPath
23+ print(f'dtactions_user_path: "{getDtactionsUserPath()}", (type: "{Type}"')
24+ Type = type(getDtactionsPath() )
25+ print(f'dtactions_path: "{getDtactionsPath ()}", (type: "{Type}")' )
3226```
3327
34- NOTE: these two directories can also be obtained via Dtactionsstatus:
35- ```
36- import natlinkstatus
37- status = natlinkstatus.DtactionsStatus()
38- status.getDtactionsDirectory()
39- status.getDtactionsUserDirectory()
40- ```
4128
4229"""
4330import importlib .metadata
4431__version__ = importlib .metadata .version (__package__ ) #version set in pyproject.toml now.
4532
4633
4734##----------------------
48- import sys
4935import os
5036from pathlib import Path , WindowsPath
37+ #
38+ # def get_home_path() -> Path:
39+ # """get home path, can be tweaked by pytest testing
40+ # """
41+ # return WindowsPath.home()
5142
52- def getDtactionsDirectory ():
43+ def getDtactionsDirectory () -> str :
5344 """return the root directory of dtactions
5445 """
55- return getThisDir ( __file__ )
46+ return str ( Path ( __file__ ). parent )
5647
57- def getDtactionsUserDirectory ():
58- """get the NatlinkUserDirectory
59-
60- Here are config files, especially .natlink
61-
62- By default the users home directory is taken. This directory can be overridden by setting
63- the environment variable DICTATIONTOOLBOXUSER to an existing directory.
64- Restart then the calling program
65- """
66- # default dtHome:
67- dictation_toolbox_user = os .getenv ("DICTATIONTOOLBOXUSER" )
68- if dictation_toolbox_user :
69- dtHome = Path (dictation_toolbox_user )
70- if not dtHome .is_dir ():
71- dtHome = WindowsPath .home ()
72- print (f'dtactions.getDtactionsUserDirectory: environment variable DICTATIONTOOLBOXUSER does not point to a valid directory: "{ dictation_toolbox_user } { dtHome } )
73- else :
74- dtHome = WindowsPath .home ()
75-
76- dtactions_ini_folder = dtHome / ".dtactions"
77- if not dtactions_ini_folder .is_dir ():
78- dtactions_ini_folder .mkdir () #make it if it doesn't exist
79- return str (dtactions_ini_folder )
80-
81- def getThisDir (fileOfModule , warnings = False ):
82- """get directory of calling module, if possible in site-packages
83-
84- call at top of module with `getThisDir(__file__)`
85-
86- If you want to get warnings (each one only once, pass `warnings = True`)
87-
88- More above and in the explanation of findInSitePackages.
48+ def getDtactionsPath () -> Path :
49+ """return the root directory of dtactions as Path instance
8950 """
90- thisFile = Path (fileOfModule )
91- thisDir = thisFile .parent
92- thisDir = findInSitePackages (thisDir , warnings = warnings )
93- return thisDir
51+ return Path (__file__ ).parent
9452
95- def findInSitePackages (directory , warnings ):
96- """get corresponding directory in site-packages
97-
98- For users, just having pipped this package, the "directory" is returned, assuming it is in
99- the site-packages.
100-
101- For developers, the directory is either
102- --in a clone from github.
103- The corresponding directory in site-packages should be a symlink,
104- otherwise there was no "flit install --symlink" yet.
105- --a directory in the site-packages. This directory should be a symlink to a cloned dir.
106-
107- The site-packages directory is returned, but the actual files accessed are in the cloned directory.
108-
109- To get this "GOOD" situation, you perform the steps as pointed out above (or in the README.md file)
53+ def getDtactionsUserDirectory () -> str :
54+ """get the UserDirectory for Dtactions
11055
111- When problems arise, set warnings=True, in the call, preferably when calling getThisDir in the calling module.
112- """
113- dirstr = str (directory )
114- if dirstr .find ('\\ src\\ ' ) < 0 :
115- if warnings :
116- warning (f'directory { dirstr } )
117- return directory
118-
119- commonpart = dirstr .rsplit ('\\ src\\ ' , maxsplit = 1 )[- 1 ]
120- spDir = Path (sys .prefix , 'Lib' , 'site-packages' , commonpart )
121- if spDir .is_dir ():
122- spResolve = spDir .resolve ()
123- if spResolve == spDir :
124- if warnings :
125- warning (f'corresponding site-packages directory is not a symlink: { spDir } \n Please use "flit install --symlink" when you want to test this package' )
126- elif spResolve == directory :
127- # print(f'directory is symlink: {spDir} and resolves to {directory} all right')
128- ## return the symbolic link in the site-packages directory, that resolves to directory!!
129- return spDir
130- else :
131- if warnings :
132- warning (f'directory is symlink: { spDir } { directory } { spResolve } )
133- else :
134- if warnings :
135- warning ('findInSitePackages, not a valid directory in site-packages, no "flit install --symlink" yet: {spDir}' )
136- return directory
137-
138- def checkDirectory (directory , create = None ):
139- """check existence of directory path
140-
141- create == False, None (default): raise OSError if directory is not there
56+ This is by default your-home-directory/.dtactions (so decoupled from the Natlink user directory)
57+
58+ You can override this by setting environment variable `DTACTIONS_USERDIR`
59+ to a valid directory of your choice
14260
143- create == True: create if not existent yet...
144- raise OSError if something strange happens...
145- returns None
14661 """
147- if not isinstance (directory , Path ):
148- directory = Path (directory )
149- if directory .is_dir ():
150- return
151- if create is False :
152- raise OSError (f'Cannot find directory { directory } )
153- if directory .exists ():
154- raise OSError (f'path exists, but is not a directory: { directory } )
155- directory .mkdir (parents = True )
156- if directory .is_dir ():
157- print ('created directory: {directory}' )
158- else :
159- raise OSError (f'did not manage to create directory: { directory } )
62+ # default dtHome:
63+ dta_user_dir = os .getenv ("DTACTIONS_USERDIR" )
64+ if dta_user_dir :
65+ if Path (dta_user_dir ).is_dir ():
66+ return str (dta_user_dir )
67+ print (f'WARNING, dtactions.getDtactionsUserDirectory: environment variable DTACTIONS_USERDIR does not point to a valid directory: "{ dta_user_dir } )
68+
69+ home_path = WindowsPath .home ()
70+
71+ dtactions_ini_path = home_path / ".dtactions"
72+ if not dtactions_ini_path .is_dir ():
73+ dtactions_ini_path .mkdir () #make it if it doesn't exist
74+ if not dtactions_ini_path .is_dir ():
75+ raise IOError (f'dtactions.__init__: dtactions_ini_path cannot be created "{ dtactions_ini_path } )
76+ return str (dtactions_ini_path )
77+
78+ def getDtactionsUserPath () -> Path :
79+ """the "Path" version of getDtactionsUserDirectory
80+ """
81+ return Path (getDtactionsUserDirectory ())
82+
16083
16184warningTexts = []
16285def warning (text ):
@@ -172,5 +95,12 @@ def warning(text):
17295
17396
17497if __name__ == "__main__" :
98+ print (f'dtactions_directory: "{ getDtactionsDirectory ()} )
17599 print (f'dtactions_user_directory: "{ getDtactionsUserDirectory ()} )
100+
101+ Type = type (getDtactionsPath ())
102+ print (f'dtactions_path: "{ getDtactionsPath ()} { Type } )
103+
104+ Type = type (getDtactionsUserPath ())
105+ print (f'dtactions_user_path: "{ getDtactionsUserPath ()} { Type } )
176106
0 commit comments