我的问题本质上是“我应该如何构建卡住的、已部署的基于 Python 的 Windows 应用程序的文件和文件夹的结构。”为了了解我的情况，这里有一些背景:

我正在为我的工作场所构建一个使用 Python 2.7 的桌面应用程序。它是基于 PyQt 构建的基于 GUI 的应用程序。我正在使用 Esky 构建应用程序这是一个跨平台的卡住和更新框架。 Esky 基本上包装/调用 py2exe、py2app、bb_freeze 或您已安装的适用于当前平台的任何工具。 Esky 创建了一个压缩包，如下所示:

prog.exe                     - esky bootstrapping executable
appdata/                     - container for all the esky magic
  appname-X.Y.platform/      - specific version of the application
    prog.exe                 - executable(s) as produced by freezer module
    library.zip              - pure-python frozen modules
    pythonXY.dll             - python DLL
    esky-files/              - esky control files
      bootstrap/             - files not yet moved into bootstrapping env
      bootstrap-manifest.txt - list of files expected in bootstrap env
      lockfile.txt           - lockfile to block removal of in-use versions
      ...other deps...
  updates/                   - work area for fetching/unpacking updates

然后可以将这些压缩包放在 Esky 寻找更新的文件服务器上。提供了许多方法来管理更新，包括非常简单的 auto_update()。发生更新时，appname-X.Y.platform 文件夹基本上被替换为下一个版本文件夹...因此 myApp.0.1.win32 文件夹被替换为 myApp.0.2.win32 文件夹。

您应该知道的背景的另一方面是我正在将应用程序分发给我的同事，他们没有安装 Python。我不是在分发 Python 包或库，我是在部署桌面应用程序(我的同事并不特别关心它是用什么编写的，只关心它是否有效)。我构建了一个 Inno 安装程序，用于安装应用程序、提供卸载程序和各种快捷方式。因为团队中的每个人都拥有基本相同的 Windows 7 64 位环境，所以我非常安全地只为该平台构建。

所以，回到结构问题。我读过为项目框架推荐某种格式的指南，例如 Learn Python the Hard Way, Exercise 46或 Hitchhiker's Guide to Packaging .然而，这些指南面向 Python 包开发人员，而不是编译应用程序开发人员。

我也遇到了 Esky 的 appname-X.Y.platform 文件夹的问题，因为每次更新程序时它都会更改名称(以反射(reflect)版本号)。因为我希望“开始”菜单中的一些快捷方式始终引用文档、变更日志等，所以我让安装程序将其中一些文件放在 appdata 文件夹下。当程序更新时，我有一些代码来检查我希望在外部“可见”的那些文件的更新版本，并将更新版本从 appname-X.Y.platform 文件夹中复制出来，并覆盖 appdata 文件夹中的副本。然后我还需要一种存储持久用户设置的方法，因此该程序会生成并使用一个 appdata\settings 文件夹(否则每次更新时设置都会被删除)。

我是否应该继续让应用程序在更新后将新文件推送到 appdata 文件夹的过程？我是否应该构建自己的文档、示例、设置等结构，并让程序在必要时用更新的文件填充这些文件夹？我应该尝试改变或更好地利用 Esky 的行为以更好地适应我的使用吗？也许我应该重新设计我的应用程序，使其既可以作为 Python 包又可以作为最终用户应用程序分发？

这个问题与this one about static files with Esky有关, this one about Python deployed application structure ，以及许多关于 Python 项目结构的一般性问题，这些问题没有使用 Esky 专门解决。还提供了一些讨论 Esky 的视频 here和 here .

我正在寻求有关应对这些挑战的“最佳实践”方法的建议。如果这不符合 StackOverflow 问题格式，我会很乐意尝试重新措辞或缩小问题的范围。

最佳答案

尽管 Esky 的自动更新会在每次更新时更改我的应用程序文件夹的名称，但这是我提到的关于使文件可用于静态位置的快捷方式的问题的解决方案。下面的函数在 QMainWindow 的类定义中。

如果您的应用程序不使用日志记录模块，则日志记录语句可以替换为打印语句，但我强烈建议使用日志记录，尤其是在部署这样的独立应用程序时。

import os
import shutil
import logging

def push_updated_files(self):
    """
    Manually push auto-updated files from the application folder up to the appdata folder
    This enables shortcuts and other features on the computer to point to these files since the application
      directory name changes with each update.
    """
    logger = logging.getLogger(__name__)

    #Verify whether running script or frozen/deployed application
    if getattr(sys, 'frozen', False):
        logger.info("Verifying Application Integrity...")

        #Files which should by copied to appdata directory to be easily referenced by shortcuts, etc.
        data_files = ['main.ico',
                      'uninstall.ico',
                      'ReadMe.txt',
                      'changelog.txt',
                      'WhatsNew.txt',
                      'copyright.txt',
                      'Documentation.pdf']

        logger.debug("  App Path: {0}".format(self._app_path))

        #Get application top directory
        logger.debug("  AppData Directory: {0}".format(self._appdata_path))

        #Get application internal file path
        for f in data_files:
            a_file = f
            int_path = os.path.join(self._app_path, a_file)
            logger.debug("  Internal File Path: {0}".format(int_path))

            #Get file's creation time
            mtime_int = os.stat(int_path).st_mtime
            logger.debug("  Internal File Modified Time: {0}".format(time.ctime(mtime_int)))

            #Get external file path
            ext_path = os.path.join(self._appdata_path, a_file)
            if os.path.exists(ext_path):
                mtime_ext = os.stat(ext_path).st_mtime
                logger.debug("  External File Modified Time: {0}".format(time.ctime(mtime_ext)))

                if mtime_int > mtime_ext:
                    logger.debug("  Replacing external file with new file...")
                    try:
                        os.remove(ext_path)
                        shutil.copy(int_path, ext_path)
                    except Exception, e:
                        logger.error("  Failed to replace the external file...", exc_info=True)
                else:
                    logger.debug("  External file is newer than internal file - all is well.")
            else:
                logger.debug("  Copying file to appdata to be externally accessible")
                shutil.copy(int_path, ext_path)

也与此相关，在处理用户设置时(目前只是一个用于填充最近文件列表的 history.txt 文件)我在 appdata 下有一个 settings 文件夹，但在 application 文件夹之外，这样设置就不会丢失每次更新。我可能会为文档和图标制作类似的文件夹。

关于Esky 的 Python 项目结构，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/20475868/