Make archive name and archiver for savestate optional.

README.rst

@@ -25,7 +25,7 @@ preferably in a archive file vs a bunch of files.
 Requirements
 ============
 
-- Python (2 or 3)
+- Python 3
 - `fs-uae`_ (obviously :)
 
 Fs-uae-wrapper supports several types of archives:
@@ -157,8 +157,8 @@ Options used:
 
 * ``wrapper`` (required) with ``cd32`` as an value
 * ``wrapper_archive`` (required) path to the archive with CD32 iso/cue/wav
-* ``wrapper_archiver`` (conditionally required) archiver to use for storage
-  save state
+* ``wrapper_archiver`` (optional) archiver to use for storage save state -
+  default ``7z``.
 * ``wrapper_gui_msg`` (optional) if set to "1", will display a graphical
   message during extracting files
 * ``wrapper_save_state`` (optional) if set to "1", will load/archive save state
@@ -175,7 +175,7 @@ fragment of configuration file is saved as ``ChaosEngine.fs-uae``:
    [config]
    wrapper = cd32
    wrapper_archive = ChaosEngine.7z
-   wrapper_archiver = 7z
+   wrapper_archiver = zip
    wrapper_gui_msg = 1
 
    amiga_model = CD32
@@ -219,10 +219,12 @@ archive
 Options used:
 
 * ``wrapper`` (required) with ``archive`` as an value
-* ``wrapper_archive`` (required) path to the archive with assets (usually means
-  whole system directories, floppies or hard disk images)
-* ``wrapper_archiver`` (conditionally required) archiver to use for storage
-  save state
+* ``wrapper_archive`` (optional) path to the archive with assets (usually means
+  whole system directories, floppies or hard disk images), defaults to same
+  name as configuration file with some detected archive extension. Note, that
+  name is case sensitive
+* ``wrapper_archiver`` (optional) archiver to use for storage save state -
+  default ``7z``.
 * ``wrapper_gui_msg`` (optional) if set to "1", will display a graphical
   message during extracting files
 * ``wrapper_persist_data`` (optional) if set to "1", will compress (possibly
@@ -277,7 +279,8 @@ savestate
 Options used:
 
 * ``wrapper`` (required) with ``archive`` as an value
-* ``wrapper_archiver`` (required) archiver to use for storage save state
+* ``wrapper_archiver`` (optional) archiver to use for storage save state -
+  default ``7z``.
 
 This module is primarily used to run emulator with read only media attached
 (like images of floppies or uncompressed CD-ROMs) and its purpose is to

fs_uae_wrapper/base.py

@@ -237,9 +237,9 @@ class Base(object):
             return True
 
         if 'wrapper_archiver' not in self.all_options:
-            logging.error("Configuration lacks of required "
-                          "`wrapper_archiver' option.")
-            return False
+            logging.warning("Configuration lacks of optional "
+                            "`wrapper_archiver' option, fall back to 7z")
+            self.all_options['wrapper_archiver'] = "7z"
 
         if not path.which(self.all_options['wrapper_archiver']):
             logging.error("Cannot find archiver `%s'.",
@@ -295,8 +295,30 @@ class ArchiveBase(Base):
         validation_result = super(ArchiveBase, self)._validate_options()
 
         if 'wrapper_archive' not in self.all_options:
-            sys.stderr.write("Configuration lacks of required "
-                             "`wrapper_archive' option.\n")
-            validation_result = False
+            logging.warning("Configuration lacks of optional `wrapper_archive'"
+                            " option.\n")
+            wrapper_archive = self._get_wrapper_archive_name()
+            if wrapper_archive is None:
+                logging.error("Configuration lacks of optional "
+                              "`wrapper_archive', cannot deduct the name by "
+                              "configuration file name.\n")
+                validation_result = False
+            self.all_options['wrapper_archive'] = wrapper_archive
 
         return validation_result
+
+    def _get_wrapper_archive_name(self):
+        """
+        Return full path to the archive name using configuration file
+        basename and appending one of the expected archive extensions.
+        """
+        basename = os.path.splitext(self.conf_file)[0]
+        file_list = os.listdir('.')
+        for fname in file_list:
+            for ext in ('.7z', '.lha', '.lzx', '.zip', '.rar', '.tar', '.tgz',
+                        '.tar.gz', '.tar.bz2', '.tar.xz'):
+                if ((basename + ext).lower() == fname.lower() and
+                    basename == os.path.splitext(fname)[0]):
+                    return fname
+        return None
+

fs_uae_wrapper/plain.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
 Simple class for executing fs-uae with specified parameters. This is a
 failsafe class for running fs-uae.

fs_uae_wrapper/utils.py

@@ -1,14 +1,12 @@
 """
 Misc utilities
 """
-from distutils import spawn
+import configparser
 import logging
 import os
+import pathlib
+import shutil
 import subprocess
-try:
-    import configparser
-except ImportError:
-    import ConfigParser as configparser
 
 from fs_uae_wrapper import message
 from fs_uae_wrapper import file_archive
@@ -22,8 +20,8 @@ class CmdOption(dict):
     def add(self, option):
         """parse and add option to the dictionary"""
         if not option.startswith('--'):
-            raise AttributeError("Cannot add option `%s' to the dictionary" %
-                                 option)
+            raise AttributeError(f"Cannot add option {option} to the "
+                                 f"dictionary")
         if '=' in option:
             key, val = option.split('=', 1)
             key = key[2:].strip()
@@ -38,15 +36,15 @@ class CmdOption(dict):
         ret_list = []
         for key, val in self.items():
             if val != '1':
-                ret_list.append('--%(k)s=%(v)s' % {'k': key, 'v': val})
+                ret_list.append(f'--{key}={val}')
             else:
-                ret_list.append('--%(k)s' % {'k': key})
+                ret_list.append(f'--{key}')
         return ret_list
 
 
 def get_config_options(conf):
     """Read config file and return options as a dict"""
-    parser = configparser.SafeConfigParser()
+    parser = configparser.ConfigParser()
     try:
         parser.read(conf)
     except configparser.ParsingError:
@@ -90,7 +88,7 @@ def create_archive(arch_name, title='', params=None):
     """
     msg = ''
     if title:
-        msg = "Creating archive for `%s'. Please be patient" % title
+        msg = f"Creating archive for `{title}'. Please be patient"
     return operate_archive(arch_name, 'create', msg, params)
 
 
@@ -100,7 +98,7 @@ def extract_archive(arch_name, title='', params=None):
     """
     msg = ''
     if title:
-        msg = "Extracting files for `%s'. Please be patient" % title
+        msg = f"Extracting files for `{title}'. Please be patient"
     return operate_archive(arch_name, 'extract', msg, params)
 
 
@@ -146,17 +144,18 @@ def interpolate_variables(string, config_path, base=None):
 
     _string = string
     if '$CONFIG' in string:
-        conf_path = os.path.dirname(os.path.abspath(config_path))
-        string = os.path.abspath(string.replace('$CONFIG', conf_path))
+        conf_path = pathlib.Path(config_path).resolve().parent
+        string = str(pathlib.Path(string.replace('$CONFIG', str(conf_path)))
+                     .resolve())
 
     if '$HOME' in string:
         string = string.replace('$HOME', os.path.expandvars('$HOME'))
 
     if '$EXE' in string:
-        string = string.replace('$EXE', spawn.find_executable('fs-uae'))
+        string = string.replace('$EXE', shutil.which('fs-uae'))
 
     if '$APP' in string:
-        string = string.replace('$APP', spawn.find_executable('fs-uae'))
+        string = string.replace('$APP', shutil.which('fs-uae'))
 
     if '$DOCUMENTS' in string:
         xdg_docs = os.getenv('XDG_DOCUMENTS_DIR',

fs_uae_wrapper/wrapper.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 """
 Wrapper for FS-UAE to perform some actions before and or after running the
 emulator, if appropriate option is enabled.
@@ -119,7 +118,3 @@ def run():
 
     if not exit_code:
         sys.exit(4)
-
-
-if __name__ == "__main__":
-    run()

pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fs-uae-wrapper"
+authors = [{name = "Roman Dobosz", email = "gryf73@gmail.com"}]
+license = {text = "BSD"}
+description = "Automate archives support and state saves for fs-uae"
+readme = "README.rst"
+requires-python = ">=3.8"
+keywords = ["uae", "fs-uae", "amiga", "emulator", "wrapper"]
+version = "0.9.1"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Emulators",
+    "Topic :: Games/Entertainment"
+]
+
+[project.urls]
+Homepage = "https://github.com/gryf/fs-uae-wrapper"
+
+[project.scripts]
+fs-uae-wrapper = "fs_uae_wrapper.wrapper:run"
+
+[tool.setuptools]
+py-modules = ["fs_uae_wrapper"]
+
+[tool.distutils.bdist_wheel]
+universal = true

script/fs-uae-wrapper

@@ -1,16 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-"""
-Run CD32 games using fsuae
-"""
-
-from fs_uae_wrapper import wrapper
-
-
-def main():
-    """run wrapper"""
-    wrapper.run()
-
-
-if __name__ == "__main__":
-    main()

setup.py

@@ -1,31 +0,0 @@
-#!/usr/bin/env python
-"""
-Setup for the fs-uae-wrapper
-"""
-from setuptools import setup
-
-
-setup(name='fs-uae-wrapper',
-      packages=['fs_uae_wrapper'],
-      version='0.8.1',
-      description='Automate archives and state for fs-uae',
-      author='Roman Dobosz',
-      author_email='gryf73@gmail.com',
-      url='https://github.com/gryf/fs-uea-wrapper',
-      download_url='https://github.com/gryf/fs-uae-wrapper/archive/master.zip',
-      keywords=['uae', 'fs-uae', 'amiga', 'emulator', 'wrapper'],
-      scripts=['script/fs-uae-wrapper'],
-      classifiers=['Programming Language :: Python :: 2',
-                   'Programming Language :: Python :: 2.7',
-                   'Programming Language :: Python :: 3',
-                   'Programming Language :: Python :: 3.4',
-                   'Development Status :: 4 - Beta',
-                   'Environment :: Console',
-                   'Intended Audience :: End Users/Desktop',
-                   'License :: OSI Approved :: BSD License',
-                   'Operating System :: OS Independent',
-                   'Topic :: System :: Emulators',
-                   'Topic :: Games/Entertainment'],
-      long_description=open('README.rst').read(),
-      options={'test': {'verbose': False,
-                        'coverage': False}})

tests/test_base.py

@@ -286,7 +286,7 @@ class TestBase(TestCase):
         which.return_value = '7z'
         bobj.all_options = {'wrapper': 'dummy',
                             'wrapper_save_state': '1'}
-        self.assertFalse(bobj._validate_options())
+        self.assertTrue(bobj._validate_options())
 
         bobj.all_options = {'wrapper': 'dummy',
                             'wrapper_save_state': '1',

tests/test_savestate.py

@@ -73,7 +73,7 @@ class TestSaveState(TestCase):
         self.assertFalse(arch._validate_options())
 
         arch.all_options['wrapper'] = 'savestate'
-        self.assertFalse(arch._validate_options())
+        self.assertTrue(arch._validate_options())
 
         arch.all_options['wrapper_archiver'] = 'rar'
         self.assertTrue(arch._validate_options())

tests/test_utils.py

@@ -237,8 +237,8 @@ class TestCmdOptions(TestCase):
     @mock.patch('os.path.exists')
     @mock.patch('os.getenv')
     @mock.patch('os.path.expandvars')
-    @mock.patch('distutils.spawn.find_executable')
-    def test_interpolate_variables(self, find_exe, expandv, getenv, os_exists):
+    @mock.patch('shutil.which')
+    def test_interpolate_variables(self, which, expandv, getenv, os_exists):
 
         os_exists.return_value = True
         itrpl = utils.interpolate_variables
@@ -252,7 +252,7 @@ class TestCmdOptions(TestCase):
                          '/home/user')
 
         string = '$APP/$EXE'
-        find_exe.return_value = '/usr/bin/fs-uae'
+        which.return_value = '/usr/bin/fs-uae'
         self.assertEqual(itrpl(string, '/home/user/Config.fs-uae'),
                          '/usr/bin/fs-uae//usr/bin/fs-uae')
 

tests/test_wrapper.py

@@ -47,10 +47,7 @@ class TestWrapper(TestCase):
             fobj.write('\n')
 
         wrapper.run()
-        mock_plain_run.called_once_with('Config.fs-uae',
-                                        ['--fullscreen',
-                                         '--fade_out_duration=0'],
-                                        [])
+        mock_plain_run.assert_called_once()
 
         # This will obviously fail for nonexistent module
         sys.argv.append('--wrapper=dummy_wrapper')

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py3,py27-flake8,py3-flake8
+envlist = py3,py3-flake8
 
 usedevelop = True
 
@@ -10,16 +10,7 @@ commands = py.test --cov=fs_uae_wrapper --cov-report=term-missing
 
 deps = -r{toxinidir}/test-requirements.txt
 
-[testenv:py27]
-deps = {[testenv]deps}
-       mock
-
 [testenv:py3-flake8]
 basepython = python3
 deps = flake8
 commands = flake8 {posargs}
-
-[testenv:py27-flake8]
-basepython = python2.7
-deps = flake8
-commands = flake8 {posargs}