mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-26 13:52:15 +01:00
It looks like login is working. Added module "appsdir"
This commit is contained in:
Jakub Trllo
parent
3b8b9a23bc
commit
aaacaf88c4
8 changed files with 954 additions and 183 deletions
|
|
@ -1,6 +0,0 @@
|
|||
import os
|
||||
import sys
|
||||
import credentials
|
||||
import login_dialog
|
||||
|
||||
# login_dialogue_usage.main()
|
||||
|
|
@ -1,168 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Form implementation generated from reading ui file '..\CODE\github\pypeclub\pype-setup\temp\pype_project_settins_ui\login_dialogue.ui'
|
||||
#
|
||||
# Created by: PyQt5 UI code generator 5.7.1
|
||||
#
|
||||
# WARNING! All changes made in this file will be lost!
|
||||
|
||||
import sys
|
||||
from PyQt5 import QtCore, QtGui, QtWidgets
|
||||
from app import style
|
||||
import credentials
|
||||
import login_tools
|
||||
|
||||
class Login_Dialog_ui(QtWidgets.QWidget):
|
||||
|
||||
SIZE_W = 300
|
||||
SIZE_H = 160
|
||||
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
|
||||
_translate = QtCore.QCoreApplication.translate
|
||||
|
||||
self.resize(self.SIZE_W, self.SIZE_H)
|
||||
self.setMinimumSize(QtCore.QSize(self.SIZE_W, self.SIZE_H))
|
||||
self.setStyleSheet(style.load_stylesheet())
|
||||
|
||||
self.main = QtWidgets.QVBoxLayout()
|
||||
self.main.setObjectName("main")
|
||||
|
||||
self.form = QtWidgets.QFormLayout()
|
||||
self.form.setContentsMargins(10, 15, 10, 5)
|
||||
self.form.setObjectName("form")
|
||||
|
||||
font = QtGui.QFont()
|
||||
font.setFamily("DejaVu Sans Condensed")
|
||||
font.setPointSize(9)
|
||||
font.setBold(True)
|
||||
font.setWeight(50)
|
||||
font.setKerning(True)
|
||||
|
||||
self.ftsite_label = QtWidgets.QLabel("FTrack URL:")
|
||||
self.ftsite_label.setFont(font)
|
||||
self.ftsite_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.ftsite_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.ftsite_label.setObjectName("user_label")
|
||||
|
||||
self.ftsite_input = QtWidgets.QLineEdit()
|
||||
self.ftsite_input.setEnabled(True)
|
||||
self.ftsite_input.setFrame(True)
|
||||
self.ftsite_input.setEnabled(False)
|
||||
self.ftsite_input.setReadOnly(True)
|
||||
self.ftsite_input.setObjectName("ftsite_input")
|
||||
|
||||
self.user_label = QtWidgets.QLabel("Username:")
|
||||
self.user_label.setFont(font)
|
||||
self.user_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.user_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.user_label.setObjectName("user_label")
|
||||
|
||||
self.user_input = QtWidgets.QLineEdit()
|
||||
self.user_input.setEnabled(True)
|
||||
self.user_input.setFrame(True)
|
||||
self.user_input.setObjectName("user_input")
|
||||
self.user_input.setPlaceholderText(_translate("main","user.name"))
|
||||
|
||||
self.api_label = QtWidgets.QLabel("API Key:")
|
||||
self.api_label.setFont(font)
|
||||
self.api_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.api_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.api_label.setObjectName("api_label")
|
||||
|
||||
self.api_input = QtWidgets.QLineEdit()
|
||||
self.api_input.setEnabled(True)
|
||||
self.api_input.setFrame(True)
|
||||
self.api_input.setObjectName("api_input")
|
||||
self.api_input.setPlaceholderText(_translate("main","e.g. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"))
|
||||
|
||||
self.form.addRow(self.ftsite_label, self.ftsite_input)
|
||||
self.form.addRow(self.user_label, self.user_input)
|
||||
self.form.addRow(self.api_label,self.api_input)
|
||||
|
||||
self.btnGroup = QtWidgets.QHBoxLayout()
|
||||
self.btnGroup.addStretch(1)
|
||||
self.btnGroup.setObjectName("btnGroup")
|
||||
|
||||
self.btnEnter = QtWidgets.QPushButton("Login")
|
||||
self.btnEnter.setToolTip('Set Username and API Key with entered values')
|
||||
self.btnEnter.clicked.connect(self._enter_credentials)
|
||||
|
||||
self.btnClose = QtWidgets.QPushButton("Close")
|
||||
self.btnClose.setToolTip('Close this window')
|
||||
self.btnClose.clicked.connect(self._close_widget)
|
||||
|
||||
self.btnFtrack = QtWidgets.QPushButton("Ftrack")
|
||||
self.btnFtrack.setToolTip('Open browser for Login to Ftrack')
|
||||
self.btnFtrack.clicked.connect(self._open_ftrack)
|
||||
|
||||
self.btnGroup.addWidget(self.btnFtrack)
|
||||
self.btnGroup.addWidget(self.btnEnter)
|
||||
self.btnGroup.addWidget(self.btnClose)
|
||||
|
||||
self.main.addLayout(self.form)
|
||||
self.main.addLayout(self.btnGroup)
|
||||
|
||||
self.setLayout(self.main)
|
||||
self.setWindowTitle('FTrack Login')
|
||||
self._set_site()
|
||||
self.show()
|
||||
|
||||
def _set_site(self):
|
||||
try:
|
||||
txt = os.getenv('FTRACK_SERVER')
|
||||
except:
|
||||
txt = "FTrack site si is not set!"
|
||||
|
||||
self.ftsite_input.setText(txt)
|
||||
|
||||
def _enter_credentials(self):
|
||||
print("EnteredCredentials!")
|
||||
user = self.user_input.text()
|
||||
api = self.api_input.text()
|
||||
verification = credentials._check_credentials(user, api)
|
||||
|
||||
if verification:
|
||||
print("SUCCESS")
|
||||
credentials._save_credentials(user, api)
|
||||
credentials._set_env(user, api)
|
||||
self._close_widget()
|
||||
|
||||
def _open_ftrack(self):
|
||||
print("OpenWindow!")
|
||||
try:
|
||||
url = "pype.ftrackapp.com"
|
||||
self.loginSignal = QtCore.pyqtSignal(object, object, object)
|
||||
self._login_server_thread = login_tools.LoginServerThread()
|
||||
self._login_server_thread.loginSignal.connect(self.loginSignal)
|
||||
self._login_server_thread.start(url)
|
||||
except Exception as e:
|
||||
print(e)
|
||||
|
||||
def _close_widget(self):
|
||||
sys.exit(app.exec_())
|
||||
|
||||
|
||||
class Login_Dialog(Login_Dialog_ui):
|
||||
def __init__(self):
|
||||
super(Login_Dialog, self).__init__()
|
||||
|
||||
def execute(self):
|
||||
self._check_credentials()
|
||||
|
||||
|
||||
def getApp():
|
||||
return QtWidgets.QApplication(sys.argv)
|
||||
|
||||
def main():
|
||||
app = getApp()
|
||||
ui = Login_Dialog()
|
||||
ui.show()
|
||||
sys.exit(app.exec_())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
main()
|
||||
|
|
@ -1 +1,15 @@
|
|||
import Login
|
||||
import credentials
|
||||
import login_dialog
|
||||
|
||||
cred = credentials._get_credentials()
|
||||
|
||||
if 'username' in cred and 'apiKey' in cred:
|
||||
validation = credentials._check_credentials(
|
||||
cred['username'],
|
||||
cred['apiKey']
|
||||
)
|
||||
if validation is False:
|
||||
login_dialog.run_login()
|
||||
|
||||
else:
|
||||
login_dialog.run_login()
|
||||
|
|
|
|||
|
|
@ -1,17 +1,25 @@
|
|||
import os
|
||||
import toml
|
||||
# import ftrack_api
|
||||
import ftrack_api
|
||||
import appdirs
|
||||
|
||||
# TODO JUST TEST PATH - path should be in Environment Variables...
|
||||
config_path = r"C:\test"
|
||||
config_path = os.path.normpath(appdirs.user_data_dir('pype-app','pype'))
|
||||
config_name = 'credentials.toml'
|
||||
fpath = os.path.join(config_path, config_name)
|
||||
|
||||
def _get_credentials():
|
||||
|
||||
folder = os.path.dirname(fpath)
|
||||
|
||||
if not os.path.isdir(folder):
|
||||
os.makedirs(folder)
|
||||
|
||||
try:
|
||||
file = open(fpath, 'r')
|
||||
except:
|
||||
file = open(fpath, 'w')
|
||||
filecreate = open(fpath, 'w')
|
||||
filecreate.close()
|
||||
file = open(fpath, 'r')
|
||||
|
||||
credentials = toml.load(file)
|
||||
file.close()
|
||||
|
|
@ -37,13 +45,16 @@ def _set_env(username, apiKey):
|
|||
os.environ['FTRACK_API_USER'] = username
|
||||
os.environ['FTRACK_API_KEY'] = apiKey
|
||||
|
||||
def _check_credentials(username, apiKey):
|
||||
def _check_credentials(username=None, apiKey=None):
|
||||
|
||||
_set_env(username, apiKey)
|
||||
if username and apiKey:
|
||||
_set_env(username, apiKey)
|
||||
|
||||
try:
|
||||
session = ftrack_api.Session()
|
||||
return True
|
||||
except Exception as e:
|
||||
print(e)
|
||||
return False
|
||||
|
||||
session.close()
|
||||
return True
|
||||
310
pype/ftrack/login_dialog.py
Normal file
310
pype/ftrack/login_dialog.py
Normal file
|
|
@ -0,0 +1,310 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Form implementation generated from reading ui file '..\CODE\github\pypeclub\pype-setup\temp\pype_project_settins_ui\login_dialogue.ui'
|
||||
#
|
||||
# Created by: PyQt5 UI code generator 5.7.1
|
||||
#
|
||||
# WARNING! All changes made in this file will be lost!
|
||||
|
||||
import sys
|
||||
from PyQt5 import QtCore, QtGui, QtWidgets
|
||||
from app import style
|
||||
import credentials
|
||||
import login_tools
|
||||
import requests
|
||||
class Login_Dialog_ui(QtWidgets.QWidget):
|
||||
|
||||
SIZE_W = 300
|
||||
SIZE_H = 230
|
||||
|
||||
loginSignal = QtCore.pyqtSignal(object, object, object)
|
||||
_login_server_thread = None
|
||||
inputs = []
|
||||
buttons = []
|
||||
labels = []
|
||||
|
||||
def __init__(self):
|
||||
|
||||
super().__init__()
|
||||
self.loginSignal.connect(self.loginWithCredentials)
|
||||
self._translate = QtCore.QCoreApplication.translate
|
||||
|
||||
self.font = QtGui.QFont()
|
||||
self.font.setFamily("DejaVu Sans Condensed")
|
||||
self.font.setPointSize(9)
|
||||
self.font.setBold(True)
|
||||
self.font.setWeight(50)
|
||||
self.font.setKerning(True)
|
||||
|
||||
self.resize(self.SIZE_W, self.SIZE_H)
|
||||
self.setMinimumSize(QtCore.QSize(self.SIZE_W, self.SIZE_H))
|
||||
self.setStyleSheet(style.load_stylesheet())
|
||||
|
||||
self.setLayout(self._main())
|
||||
self.setWindowTitle('FTrack Login')
|
||||
|
||||
self.show()
|
||||
|
||||
def _main(self):
|
||||
self.main = QtWidgets.QVBoxLayout()
|
||||
self.main.setObjectName("main")
|
||||
|
||||
self.form = QtWidgets.QFormLayout()
|
||||
self.form.setContentsMargins(10, 15, 10, 5)
|
||||
self.form.setObjectName("form")
|
||||
|
||||
self.ftsite_label = QtWidgets.QLabel("FTrack URL:")
|
||||
self.ftsite_label.setFont(self.font)
|
||||
self.ftsite_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.ftsite_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.ftsite_label.setObjectName("user_label")
|
||||
|
||||
self.ftsite_input = QtWidgets.QLineEdit()
|
||||
self.ftsite_input.setEnabled(True)
|
||||
self.ftsite_input.setFrame(True)
|
||||
self.ftsite_input.setEnabled(False)
|
||||
self.ftsite_input.setReadOnly(True)
|
||||
self.ftsite_input.setObjectName("ftsite_input")
|
||||
|
||||
self.user_label = QtWidgets.QLabel("Username:")
|
||||
self.user_label.setFont(self.font)
|
||||
self.user_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.user_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.user_label.setObjectName("user_label")
|
||||
|
||||
self.user_input = QtWidgets.QLineEdit()
|
||||
self.user_input.setEnabled(True)
|
||||
self.user_input.setFrame(True)
|
||||
self.user_input.setObjectName("user_input")
|
||||
self.user_input.setPlaceholderText(self._translate("main","user.name"))
|
||||
self.user_input.textChanged.connect(self._user_changed)
|
||||
|
||||
self.api_label = QtWidgets.QLabel("API Key:")
|
||||
self.api_label.setFont(self.font)
|
||||
self.api_label.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor))
|
||||
self.api_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.api_label.setObjectName("api_label")
|
||||
|
||||
self.api_input = QtWidgets.QLineEdit()
|
||||
self.api_input.setEnabled(True)
|
||||
self.api_input.setFrame(True)
|
||||
self.api_input.setObjectName("api_input")
|
||||
self.api_input.setPlaceholderText(self._translate("main","e.g. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"))
|
||||
self.api_input.textChanged.connect(self._api_changed)
|
||||
|
||||
self.error_label = QtWidgets.QLabel("")
|
||||
self.error_label.setFont(self.font)
|
||||
self.error_label.setTextFormat(QtCore.Qt.RichText)
|
||||
self.error_label.setObjectName("error_label")
|
||||
self.error_label.setWordWrap(True);
|
||||
self.error_label.hide()
|
||||
|
||||
self.form.addRow(self.ftsite_label, self.ftsite_input)
|
||||
self.form.addRow(self.user_label, self.user_input)
|
||||
self.form.addRow(self.api_label,self.api_input)
|
||||
self.form.addRow(self.error_label)
|
||||
|
||||
self.btnGroup = QtWidgets.QHBoxLayout()
|
||||
self.btnGroup.addStretch(1)
|
||||
self.btnGroup.setObjectName("btnGroup")
|
||||
|
||||
self.btnEnter = QtWidgets.QPushButton("Login")
|
||||
self.btnEnter.setToolTip('Set Username and API Key with entered values')
|
||||
self.btnEnter.clicked.connect(self.enter_credentials)
|
||||
|
||||
self.btnClose = QtWidgets.QPushButton("Close")
|
||||
self.btnClose.setToolTip('Close this window')
|
||||
self.btnClose.clicked.connect(self._close_widget)
|
||||
|
||||
self.btnFtrack = QtWidgets.QPushButton("Ftrack")
|
||||
self.btnFtrack.setToolTip('Open browser for Login to Ftrack')
|
||||
self.btnFtrack.clicked.connect(self.open_ftrack)
|
||||
|
||||
self.btnGroup.addWidget(self.btnFtrack)
|
||||
self.btnGroup.addWidget(self.btnEnter)
|
||||
self.btnGroup.addWidget(self.btnClose)
|
||||
|
||||
self.main.addLayout(self.form)
|
||||
self.main.addLayout(self.btnGroup)
|
||||
|
||||
self.inputs.append(self.api_input)
|
||||
self.inputs.append(self.user_input)
|
||||
self.inputs.append(self.ftsite_input)
|
||||
|
||||
self.enter_site()
|
||||
return self.main
|
||||
|
||||
def enter_site(self):
|
||||
try:
|
||||
# # TESTING
|
||||
# url = ".ftrackapp.com"
|
||||
url = os.getenv('FTRACK_SERVER')
|
||||
newurl = self.checkUrl(url)
|
||||
|
||||
if newurl is None:
|
||||
self.btnEnter.setEnabled(False)
|
||||
self.btnFtrack.setEnabled(False)
|
||||
for input in self.inputs:
|
||||
input.setEnabled(False)
|
||||
newurl = url
|
||||
|
||||
self.ftsite_input.setText(newurl)
|
||||
|
||||
except:
|
||||
self.setError("FTRACK_SERVER is not set in templates")
|
||||
self.btnEnter.setEnabled(False)
|
||||
self.btnFtrack.setEnabled(False)
|
||||
for input in self.inputs:
|
||||
input.setEnabled(False)
|
||||
|
||||
def setError(self, msg):
|
||||
self.error_label.setText(msg)
|
||||
self.error_label.show()
|
||||
|
||||
def _user_changed(self):
|
||||
self.user_input.setStyleSheet("")
|
||||
|
||||
def _api_changed(self):
|
||||
self.api_input.setStyleSheet("")
|
||||
|
||||
def _invalid_input(self,entity):
|
||||
entity.setStyleSheet("border: 1px solid red;")
|
||||
|
||||
def enter_credentials(self):
|
||||
user = self.user_input.text().strip()
|
||||
api = self.api_input.text().strip()
|
||||
msg = "You didn't enter "
|
||||
missing = []
|
||||
if user == "":
|
||||
missing.append("Username")
|
||||
self._invalid_input(self.user_input)
|
||||
|
||||
if api == "":
|
||||
missing.append("API Key")
|
||||
self._invalid_input(self.api_input)
|
||||
|
||||
if len(missing) > 0:
|
||||
self.setError("{0} {1}".format(msg, " and ".join(missing)))
|
||||
return
|
||||
|
||||
verification = credentials._check_credentials(user, api)
|
||||
|
||||
if verification:
|
||||
credentials._save_credentials(username, apiKey)
|
||||
credentials._set_env(username, apiKey)
|
||||
self._close_widget()
|
||||
else:
|
||||
self._invalid_input(self.user_input)
|
||||
self._invalid_input(self.api_input)
|
||||
self.setError("We're unable to connect to Ftrack with these credentials")
|
||||
|
||||
def open_ftrack(self):
|
||||
url = self.ftsite_input.text()
|
||||
self.loginWithCredentials(url,None,None)
|
||||
|
||||
def checkUrl(self, url):
|
||||
url = url.strip('/ ')
|
||||
|
||||
if not url:
|
||||
self.setError()
|
||||
return
|
||||
|
||||
if not 'http' in url:
|
||||
if url.endswith('ftrackapp.com'):
|
||||
url = 'https://' + url
|
||||
else:
|
||||
url = 'https://{0}.ftrackapp.com'.format(url)
|
||||
try:
|
||||
result = requests.get(
|
||||
url,
|
||||
allow_redirects=False # Old python API will not work with redirect.
|
||||
)
|
||||
except requests.exceptions.RequestException:
|
||||
self.setError(
|
||||
'The server URL set in Templates could not be reached.'
|
||||
)
|
||||
return
|
||||
|
||||
|
||||
if (
|
||||
result.status_code != 200 or 'FTRACK_VERSION' not in result.headers
|
||||
):
|
||||
self.setError(
|
||||
'The server URL set in Templates is not a valid ftrack server.'
|
||||
)
|
||||
return
|
||||
return url
|
||||
|
||||
def loginWithCredentials(self, url, username, apiKey):
|
||||
url = url.strip('/ ')
|
||||
|
||||
if not url:
|
||||
self.setError(
|
||||
'You need to specify a valid server URL, '
|
||||
'for example https://server-name.ftrackapp.com'
|
||||
)
|
||||
return
|
||||
|
||||
if not 'http' in url:
|
||||
if url.endswith('ftrackapp.com'):
|
||||
url = 'https://' + url
|
||||
else:
|
||||
url = 'https://{0}.ftrackapp.com'.format(url)
|
||||
try:
|
||||
result = requests.get(
|
||||
url,
|
||||
allow_redirects=False # Old python API will not work with redirect.
|
||||
)
|
||||
except requests.exceptions.RequestException:
|
||||
self.setError(
|
||||
'The server URL you provided could not be reached.'
|
||||
)
|
||||
return
|
||||
|
||||
|
||||
if (
|
||||
result.status_code != 200 or 'FTRACK_VERSION' not in result.headers
|
||||
):
|
||||
self.setError(
|
||||
'The server URL you provided is not a valid ftrack server.'
|
||||
)
|
||||
return
|
||||
|
||||
# If there is an existing server thread running we need to stop it.
|
||||
if self._login_server_thread:
|
||||
self._login_server_thread.quit()
|
||||
self._login_server_thread = None
|
||||
|
||||
# If credentials are not properly set, try to get them using a http
|
||||
# server.
|
||||
if not username or not apiKey:
|
||||
self._login_server_thread = login_tools.LoginServerThread()
|
||||
self._login_server_thread.loginSignal.connect(self.loginSignal)
|
||||
self._login_server_thread.start(url)
|
||||
return
|
||||
|
||||
verification = credentials._check_credentials(user, api)
|
||||
|
||||
if verification is True:
|
||||
credentials._save_credentials(username, apiKey)
|
||||
credentials._set_env(username, apiKey)
|
||||
self._close_widget()
|
||||
|
||||
|
||||
def _close_widget(self):
|
||||
sys.exit(app.exec_())
|
||||
|
||||
|
||||
class Login_Dialog(Login_Dialog_ui):
|
||||
def __init__(self):
|
||||
super(Login_Dialog, self).__init__()
|
||||
|
||||
|
||||
def getApp():
|
||||
return QtWidgets.QApplication(sys.argv)
|
||||
|
||||
def run_login():
|
||||
app = getApp()
|
||||
ui = Login_Dialog()
|
||||
ui.show()
|
||||
sys.exit(app.exec_())
|
||||
|
|
@ -26,6 +26,7 @@ class LoginServerHandler(BaseHTTPRequestHandler):
|
|||
|
||||
api_user = None
|
||||
api_key = None
|
||||
login_credentials = None
|
||||
if 'api_user' and 'api_key' in query:
|
||||
login_credentials = parse.parse_qs(query)
|
||||
api_user = login_credentials['api_user'][0]
|
||||
|
|
@ -67,6 +68,7 @@ class LoginServerHandler(BaseHTTPRequestHandler):
|
|||
self.end_headers()
|
||||
self.wfile.write(message.encode())
|
||||
|
||||
|
||||
if login_credentials:
|
||||
self.login_callback(
|
||||
api_user,
|
||||
|
|
@ -78,9 +80,9 @@ class LoginServerThread(QtCore.QThread):
|
|||
'''Login server thread.'''
|
||||
|
||||
# Login signal.
|
||||
# loginSignal = QtCore.Signal(object, object, object)
|
||||
loginSignal = QtCore.pyqtSignal(object, object, object)
|
||||
|
||||
|
||||
def start(self, url):
|
||||
'''Start thread.'''
|
||||
self.url = url
|
||||
608
pype/vendor/appdirs.py
vendored
Normal file
608
pype/vendor/appdirs.py
vendored
Normal file
|
|
@ -0,0 +1,608 @@
|
|||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (c) 2005-2010 ActiveState Software Inc.
|
||||
# Copyright (c) 2013 Eddy Petrișor
|
||||
|
||||
"""Utilities for determining application-specific dirs.
|
||||
|
||||
See <http://github.com/ActiveState/appdirs> for details and usage.
|
||||
"""
|
||||
# Dev Notes:
|
||||
# - MSDN on where to store app data files:
|
||||
# http://support.microsoft.com/default.aspx?scid=kb;en-us;310294#XSLTH3194121123120121120120
|
||||
# - Mac OS X: http://developer.apple.com/documentation/MacOSX/Conceptual/BPFileSystem/index.html
|
||||
# - XDG spec for Un*x: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
|
||||
|
||||
__version_info__ = (1, 4, 3)
|
||||
__version__ = '.'.join(map(str, __version_info__))
|
||||
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
PY3 = sys.version_info[0] == 3
|
||||
|
||||
if PY3:
|
||||
unicode = str
|
||||
|
||||
if sys.platform.startswith('java'):
|
||||
import platform
|
||||
os_name = platform.java_ver()[3][0]
|
||||
if os_name.startswith('Windows'): # "Windows XP", "Windows 7", etc.
|
||||
system = 'win32'
|
||||
elif os_name.startswith('Mac'): # "Mac OS X", etc.
|
||||
system = 'darwin'
|
||||
else: # "Linux", "SunOS", "FreeBSD", etc.
|
||||
# Setting this to "linux2" is not ideal, but only Windows or Mac
|
||||
# are actually checked for and the rest of the module expects
|
||||
# *sys.platform* style strings.
|
||||
system = 'linux2'
|
||||
else:
|
||||
system = sys.platform
|
||||
|
||||
|
||||
|
||||
def user_data_dir(appname=None, appauthor=None, version=None, roaming=False):
|
||||
r"""Return full path to the user-specific data dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"roaming" (boolean, default False) can be set True to use the Windows
|
||||
roaming appdata directory. That means that for users on a Windows
|
||||
network setup for roaming profiles, this user data will be
|
||||
sync'd on login. See
|
||||
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx>
|
||||
for a discussion of issues.
|
||||
|
||||
Typical user data directories are:
|
||||
Mac OS X: ~/Library/Application Support/<AppName>
|
||||
Unix: ~/.local/share/<AppName> # or in $XDG_DATA_HOME, if defined
|
||||
Win XP (not roaming): C:\Documents and Settings\<username>\Application Data\<AppAuthor>\<AppName>
|
||||
Win XP (roaming): C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>
|
||||
Win 7 (not roaming): C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>
|
||||
Win 7 (roaming): C:\Users\<username>\AppData\Roaming\<AppAuthor>\<AppName>
|
||||
|
||||
For Unix, we follow the XDG spec and support $XDG_DATA_HOME.
|
||||
That means, by default "~/.local/share/<AppName>".
|
||||
"""
|
||||
if system == "win32":
|
||||
if appauthor is None:
|
||||
appauthor = appname
|
||||
const = roaming and "CSIDL_APPDATA" or "CSIDL_LOCAL_APPDATA"
|
||||
path = os.path.normpath(_get_win_folder(const))
|
||||
if appname:
|
||||
if appauthor is not False:
|
||||
path = os.path.join(path, appauthor, appname)
|
||||
else:
|
||||
path = os.path.join(path, appname)
|
||||
elif system == 'darwin':
|
||||
path = os.path.expanduser('~/Library/Application Support/')
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
else:
|
||||
path = os.getenv('XDG_DATA_HOME', os.path.expanduser("~/.local/share"))
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
def site_data_dir(appname=None, appauthor=None, version=None, multipath=False):
|
||||
r"""Return full path to the user-shared data dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"multipath" is an optional parameter only applicable to *nix
|
||||
which indicates that the entire list of data dirs should be
|
||||
returned. By default, the first item from XDG_DATA_DIRS is
|
||||
returned, or '/usr/local/share/<AppName>',
|
||||
if XDG_DATA_DIRS is not set
|
||||
|
||||
Typical site data directories are:
|
||||
Mac OS X: /Library/Application Support/<AppName>
|
||||
Unix: /usr/local/share/<AppName> or /usr/share/<AppName>
|
||||
Win XP: C:\Documents and Settings\All Users\Application Data\<AppAuthor>\<AppName>
|
||||
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
|
||||
Win 7: C:\ProgramData\<AppAuthor>\<AppName> # Hidden, but writeable on Win 7.
|
||||
|
||||
For Unix, this is using the $XDG_DATA_DIRS[0] default.
|
||||
|
||||
WARNING: Do not use this on Windows. See the Vista-Fail note above for why.
|
||||
"""
|
||||
if system == "win32":
|
||||
if appauthor is None:
|
||||
appauthor = appname
|
||||
path = os.path.normpath(_get_win_folder("CSIDL_COMMON_APPDATA"))
|
||||
if appname:
|
||||
if appauthor is not False:
|
||||
path = os.path.join(path, appauthor, appname)
|
||||
else:
|
||||
path = os.path.join(path, appname)
|
||||
elif system == 'darwin':
|
||||
path = os.path.expanduser('/Library/Application Support')
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
else:
|
||||
# XDG default for $XDG_DATA_DIRS
|
||||
# only first, if multipath is False
|
||||
path = os.getenv('XDG_DATA_DIRS',
|
||||
os.pathsep.join(['/usr/local/share', '/usr/share']))
|
||||
pathlist = [os.path.expanduser(x.rstrip(os.sep)) for x in path.split(os.pathsep)]
|
||||
if appname:
|
||||
if version:
|
||||
appname = os.path.join(appname, version)
|
||||
pathlist = [os.sep.join([x, appname]) for x in pathlist]
|
||||
|
||||
if multipath:
|
||||
path = os.pathsep.join(pathlist)
|
||||
else:
|
||||
path = pathlist[0]
|
||||
return path
|
||||
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
def user_config_dir(appname=None, appauthor=None, version=None, roaming=False):
|
||||
r"""Return full path to the user-specific config dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"roaming" (boolean, default False) can be set True to use the Windows
|
||||
roaming appdata directory. That means that for users on a Windows
|
||||
network setup for roaming profiles, this user data will be
|
||||
sync'd on login. See
|
||||
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx>
|
||||
for a discussion of issues.
|
||||
|
||||
Typical user config directories are:
|
||||
Mac OS X: same as user_data_dir
|
||||
Unix: ~/.config/<AppName> # or in $XDG_CONFIG_HOME, if defined
|
||||
Win *: same as user_data_dir
|
||||
|
||||
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
|
||||
That means, by default "~/.config/<AppName>".
|
||||
"""
|
||||
if system in ["win32", "darwin"]:
|
||||
path = user_data_dir(appname, appauthor, None, roaming)
|
||||
else:
|
||||
path = os.getenv('XDG_CONFIG_HOME', os.path.expanduser("~/.config"))
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
def site_config_dir(appname=None, appauthor=None, version=None, multipath=False):
|
||||
r"""Return full path to the user-shared data dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"multipath" is an optional parameter only applicable to *nix
|
||||
which indicates that the entire list of config dirs should be
|
||||
returned. By default, the first item from XDG_CONFIG_DIRS is
|
||||
returned, or '/etc/xdg/<AppName>', if XDG_CONFIG_DIRS is not set
|
||||
|
||||
Typical site config directories are:
|
||||
Mac OS X: same as site_data_dir
|
||||
Unix: /etc/xdg/<AppName> or $XDG_CONFIG_DIRS[i]/<AppName> for each value in
|
||||
$XDG_CONFIG_DIRS
|
||||
Win *: same as site_data_dir
|
||||
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
|
||||
|
||||
For Unix, this is using the $XDG_CONFIG_DIRS[0] default, if multipath=False
|
||||
|
||||
WARNING: Do not use this on Windows. See the Vista-Fail note above for why.
|
||||
"""
|
||||
if system in ["win32", "darwin"]:
|
||||
path = site_data_dir(appname, appauthor)
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
else:
|
||||
# XDG default for $XDG_CONFIG_DIRS
|
||||
# only first, if multipath is False
|
||||
path = os.getenv('XDG_CONFIG_DIRS', '/etc/xdg')
|
||||
pathlist = [os.path.expanduser(x.rstrip(os.sep)) for x in path.split(os.pathsep)]
|
||||
if appname:
|
||||
if version:
|
||||
appname = os.path.join(appname, version)
|
||||
pathlist = [os.sep.join([x, appname]) for x in pathlist]
|
||||
|
||||
if multipath:
|
||||
path = os.pathsep.join(pathlist)
|
||||
else:
|
||||
path = pathlist[0]
|
||||
return path
|
||||
|
||||
|
||||
def user_cache_dir(appname=None, appauthor=None, version=None, opinion=True):
|
||||
r"""Return full path to the user-specific cache dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"opinion" (boolean) can be False to disable the appending of
|
||||
"Cache" to the base app data dir for Windows. See
|
||||
discussion below.
|
||||
|
||||
Typical user cache directories are:
|
||||
Mac OS X: ~/Library/Caches/<AppName>
|
||||
Unix: ~/.cache/<AppName> (XDG default)
|
||||
Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Cache
|
||||
Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Cache
|
||||
|
||||
On Windows the only suggestion in the MSDN docs is that local settings go in
|
||||
the `CSIDL_LOCAL_APPDATA` directory. This is identical to the non-roaming
|
||||
app data dir (the default returned by `user_data_dir` above). Apps typically
|
||||
put cache data somewhere *under* the given dir here. Some examples:
|
||||
...\Mozilla\Firefox\Profiles\<ProfileName>\Cache
|
||||
...\Acme\SuperApp\Cache\1.0
|
||||
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value.
|
||||
This can be disabled with the `opinion=False` option.
|
||||
"""
|
||||
if system == "win32":
|
||||
if appauthor is None:
|
||||
appauthor = appname
|
||||
path = os.path.normpath(_get_win_folder("CSIDL_LOCAL_APPDATA"))
|
||||
if appname:
|
||||
if appauthor is not False:
|
||||
path = os.path.join(path, appauthor, appname)
|
||||
else:
|
||||
path = os.path.join(path, appname)
|
||||
if opinion:
|
||||
path = os.path.join(path, "Cache")
|
||||
elif system == 'darwin':
|
||||
path = os.path.expanduser('~/Library/Caches')
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
else:
|
||||
path = os.getenv('XDG_CACHE_HOME', os.path.expanduser('~/.cache'))
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
def user_state_dir(appname=None, appauthor=None, version=None, roaming=False):
|
||||
r"""Return full path to the user-specific state dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"roaming" (boolean, default False) can be set True to use the Windows
|
||||
roaming appdata directory. That means that for users on a Windows
|
||||
network setup for roaming profiles, this user data will be
|
||||
sync'd on login. See
|
||||
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx>
|
||||
for a discussion of issues.
|
||||
|
||||
Typical user state directories are:
|
||||
Mac OS X: same as user_data_dir
|
||||
Unix: ~/.local/state/<AppName> # or in $XDG_STATE_HOME, if defined
|
||||
Win *: same as user_data_dir
|
||||
|
||||
For Unix, we follow this Debian proposal <https://wiki.debian.org/XDGBaseDirectorySpecification#state>
|
||||
to extend the XDG spec and support $XDG_STATE_HOME.
|
||||
|
||||
That means, by default "~/.local/state/<AppName>".
|
||||
"""
|
||||
if system in ["win32", "darwin"]:
|
||||
path = user_data_dir(appname, appauthor, None, roaming)
|
||||
else:
|
||||
path = os.getenv('XDG_STATE_HOME', os.path.expanduser("~/.local/state"))
|
||||
if appname:
|
||||
path = os.path.join(path, appname)
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
def user_log_dir(appname=None, appauthor=None, version=None, opinion=True):
|
||||
r"""Return full path to the user-specific log dir for this application.
|
||||
|
||||
"appname" is the name of application.
|
||||
If None, just the system directory is returned.
|
||||
"appauthor" (only used on Windows) is the name of the
|
||||
appauthor or distributing body for this application. Typically
|
||||
it is the owning company name. This falls back to appname. You may
|
||||
pass False to disable it.
|
||||
"version" is an optional version path element to append to the
|
||||
path. You might want to use this if you want multiple versions
|
||||
of your app to be able to run independently. If used, this
|
||||
would typically be "<major>.<minor>".
|
||||
Only applied when appname is present.
|
||||
"opinion" (boolean) can be False to disable the appending of
|
||||
"Logs" to the base app data dir for Windows, and "log" to the
|
||||
base cache dir for Unix. See discussion below.
|
||||
|
||||
Typical user log directories are:
|
||||
Mac OS X: ~/Library/Logs/<AppName>
|
||||
Unix: ~/.cache/<AppName>/log # or under $XDG_CACHE_HOME if defined
|
||||
Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Logs
|
||||
Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Logs
|
||||
|
||||
On Windows the only suggestion in the MSDN docs is that local settings
|
||||
go in the `CSIDL_LOCAL_APPDATA` directory. (Note: I'm interested in
|
||||
examples of what some windows apps use for a logs dir.)
|
||||
|
||||
OPINION: This function appends "Logs" to the `CSIDL_LOCAL_APPDATA`
|
||||
value for Windows and appends "log" to the user cache dir for Unix.
|
||||
This can be disabled with the `opinion=False` option.
|
||||
"""
|
||||
if system == "darwin":
|
||||
path = os.path.join(
|
||||
os.path.expanduser('~/Library/Logs'),
|
||||
appname)
|
||||
elif system == "win32":
|
||||
path = user_data_dir(appname, appauthor, version)
|
||||
version = False
|
||||
if opinion:
|
||||
path = os.path.join(path, "Logs")
|
||||
else:
|
||||
path = user_cache_dir(appname, appauthor, version)
|
||||
version = False
|
||||
if opinion:
|
||||
path = os.path.join(path, "log")
|
||||
if appname and version:
|
||||
path = os.path.join(path, version)
|
||||
return path
|
||||
|
||||
|
||||
class AppDirs(object):
|
||||
"""Convenience wrapper for getting application dirs."""
|
||||
def __init__(self, appname=None, appauthor=None, version=None,
|
||||
roaming=False, multipath=False):
|
||||
self.appname = appname
|
||||
self.appauthor = appauthor
|
||||
self.version = version
|
||||
self.roaming = roaming
|
||||
self.multipath = multipath
|
||||
|
||||
@property
|
||||
def user_data_dir(self):
|
||||
return user_data_dir(self.appname, self.appauthor,
|
||||
version=self.version, roaming=self.roaming)
|
||||
|
||||
@property
|
||||
def site_data_dir(self):
|
||||
return site_data_dir(self.appname, self.appauthor,
|
||||
version=self.version, multipath=self.multipath)
|
||||
|
||||
@property
|
||||
def user_config_dir(self):
|
||||
return user_config_dir(self.appname, self.appauthor,
|
||||
version=self.version, roaming=self.roaming)
|
||||
|
||||
@property
|
||||
def site_config_dir(self):
|
||||
return site_config_dir(self.appname, self.appauthor,
|
||||
version=self.version, multipath=self.multipath)
|
||||
|
||||
@property
|
||||
def user_cache_dir(self):
|
||||
return user_cache_dir(self.appname, self.appauthor,
|
||||
version=self.version)
|
||||
|
||||
@property
|
||||
def user_state_dir(self):
|
||||
return user_state_dir(self.appname, self.appauthor,
|
||||
version=self.version)
|
||||
|
||||
@property
|
||||
def user_log_dir(self):
|
||||
return user_log_dir(self.appname, self.appauthor,
|
||||
version=self.version)
|
||||
|
||||
|
||||
#---- internal support stuff
|
||||
|
||||
def _get_win_folder_from_registry(csidl_name):
|
||||
"""This is a fallback technique at best. I'm not sure if using the
|
||||
registry for this guarantees us the correct answer for all CSIDL_*
|
||||
names.
|
||||
"""
|
||||
if PY3:
|
||||
import winreg as _winreg
|
||||
else:
|
||||
import _winreg
|
||||
|
||||
shell_folder_name = {
|
||||
"CSIDL_APPDATA": "AppData",
|
||||
"CSIDL_COMMON_APPDATA": "Common AppData",
|
||||
"CSIDL_LOCAL_APPDATA": "Local AppData",
|
||||
}[csidl_name]
|
||||
|
||||
key = _winreg.OpenKey(
|
||||
_winreg.HKEY_CURRENT_USER,
|
||||
r"Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders"
|
||||
)
|
||||
dir, type = _winreg.QueryValueEx(key, shell_folder_name)
|
||||
return dir
|
||||
|
||||
|
||||
def _get_win_folder_with_pywin32(csidl_name):
|
||||
from win32com.shell import shellcon, shell
|
||||
dir = shell.SHGetFolderPath(0, getattr(shellcon, csidl_name), 0, 0)
|
||||
# Try to make this a unicode path because SHGetFolderPath does
|
||||
# not return unicode strings when there is unicode data in the
|
||||
# path.
|
||||
try:
|
||||
dir = unicode(dir)
|
||||
|
||||
# Downgrade to short path name if have highbit chars. See
|
||||
# <http://bugs.activestate.com/show_bug.cgi?id=85099>.
|
||||
has_high_char = False
|
||||
for c in dir:
|
||||
if ord(c) > 255:
|
||||
has_high_char = True
|
||||
break
|
||||
if has_high_char:
|
||||
try:
|
||||
import win32api
|
||||
dir = win32api.GetShortPathName(dir)
|
||||
except ImportError:
|
||||
pass
|
||||
except UnicodeError:
|
||||
pass
|
||||
return dir
|
||||
|
||||
|
||||
def _get_win_folder_with_ctypes(csidl_name):
|
||||
import ctypes
|
||||
|
||||
csidl_const = {
|
||||
"CSIDL_APPDATA": 26,
|
||||
"CSIDL_COMMON_APPDATA": 35,
|
||||
"CSIDL_LOCAL_APPDATA": 28,
|
||||
}[csidl_name]
|
||||
|
||||
buf = ctypes.create_unicode_buffer(1024)
|
||||
ctypes.windll.shell32.SHGetFolderPathW(None, csidl_const, None, 0, buf)
|
||||
|
||||
# Downgrade to short path name if have highbit chars. See
|
||||
# <http://bugs.activestate.com/show_bug.cgi?id=85099>.
|
||||
has_high_char = False
|
||||
for c in buf:
|
||||
if ord(c) > 255:
|
||||
has_high_char = True
|
||||
break
|
||||
if has_high_char:
|
||||
buf2 = ctypes.create_unicode_buffer(1024)
|
||||
if ctypes.windll.kernel32.GetShortPathNameW(buf.value, buf2, 1024):
|
||||
buf = buf2
|
||||
|
||||
return buf.value
|
||||
|
||||
def _get_win_folder_with_jna(csidl_name):
|
||||
import array
|
||||
from com.sun import jna
|
||||
from com.sun.jna.platform import win32
|
||||
|
||||
buf_size = win32.WinDef.MAX_PATH * 2
|
||||
buf = array.zeros('c', buf_size)
|
||||
shell = win32.Shell32.INSTANCE
|
||||
shell.SHGetFolderPath(None, getattr(win32.ShlObj, csidl_name), None, win32.ShlObj.SHGFP_TYPE_CURRENT, buf)
|
||||
dir = jna.Native.toString(buf.tostring()).rstrip("\0")
|
||||
|
||||
# Downgrade to short path name if have highbit chars. See
|
||||
# <http://bugs.activestate.com/show_bug.cgi?id=85099>.
|
||||
has_high_char = False
|
||||
for c in dir:
|
||||
if ord(c) > 255:
|
||||
has_high_char = True
|
||||
break
|
||||
if has_high_char:
|
||||
buf = array.zeros('c', buf_size)
|
||||
kernel = win32.Kernel32.INSTANCE
|
||||
if kernel.GetShortPathName(dir, buf, buf_size):
|
||||
dir = jna.Native.toString(buf.tostring()).rstrip("\0")
|
||||
|
||||
return dir
|
||||
|
||||
if system == "win32":
|
||||
try:
|
||||
import win32com.shell
|
||||
_get_win_folder = _get_win_folder_with_pywin32
|
||||
except ImportError:
|
||||
try:
|
||||
from ctypes import windll
|
||||
_get_win_folder = _get_win_folder_with_ctypes
|
||||
except ImportError:
|
||||
try:
|
||||
import com.sun.jna
|
||||
_get_win_folder = _get_win_folder_with_jna
|
||||
except ImportError:
|
||||
_get_win_folder = _get_win_folder_from_registry
|
||||
|
||||
|
||||
#---- self test code
|
||||
|
||||
if __name__ == "__main__":
|
||||
appname = "MyApp"
|
||||
appauthor = "MyCompany"
|
||||
|
||||
props = ("user_data_dir",
|
||||
"user_config_dir",
|
||||
"user_cache_dir",
|
||||
"user_state_dir",
|
||||
"user_log_dir",
|
||||
"site_data_dir",
|
||||
"site_config_dir")
|
||||
|
||||
print("-- app dirs %s --" % __version__)
|
||||
|
||||
print("-- app dirs (with optional 'version')")
|
||||
dirs = AppDirs(appname, appauthor, version="1.0")
|
||||
for prop in props:
|
||||
print("%s: %s" % (prop, getattr(dirs, prop)))
|
||||
|
||||
print("\n-- app dirs (without optional 'version')")
|
||||
dirs = AppDirs(appname, appauthor)
|
||||
for prop in props:
|
||||
print("%s: %s" % (prop, getattr(dirs, prop)))
|
||||
|
||||
print("\n-- app dirs (without optional 'appauthor')")
|
||||
dirs = AppDirs(appname)
|
||||
for prop in props:
|
||||
print("%s: %s" % (prop, getattr(dirs, prop)))
|
||||
|
||||
print("\n-- app dirs (with disabled 'appauthor')")
|
||||
dirs = AppDirs(appname, appauthor=False)
|
||||
for prop in props:
|
||||
print("%s: %s" % (prop, getattr(dirs, prop)))
|
||||
Loading…
Add table
Add a link
Reference in a new issue