chesscalc 2.0.0__tar.gz

chesscalc-2.0.0/LICENCE

@@ -0,0 +1,15 @@
+Licence for chesscalc package
+Copyright (c) 2012, Roger Marsh
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the owner nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

chesscalc-2.0.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: chesscalc
+Version: 2.0.0
+Summary: Calculate player performances in chess games.
+Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
+License: Licence for chesscalc package
+        Copyright (c) 2012, Roger Marsh
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+        
+        
+        Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+        
+        Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+        
+        Neither the name of the owner nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, http://www.solentware.co.uk
+Project-URL: Repository, https://github.com/RogerMarsh/chesscalc.git
+Project-URL: Bug Tracker, https://github.com/RogerMarsh/chesscalc/issues
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Games/Entertainment :: Board Games
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 3 - Alpha
+License-File: LICENCE
+
+=====================================================
+Calculate player performances from chess game results
+=====================================================
+
+.. contents::
+
+
+Description
+===========
+
+This package provides methods to calculate player performances.
+
+Calculate player performances from results of games imported from `PGN`_ format files.
+
+Provide facilities to resolve player identities where inconsistencies exist in the PGN Tag Values for games involving the same player.
+
+Provide facilties to resolve inconsistent identities, time controls or playing modes for example, derived from other PGN Tag Values.
+
+
+Installation Instructions
+=========================
+
+This package is not available on PyPI, or any other package index, but can be installed by typing
+
+   python -m pip install --user --trusted-host solentware.co.uk --find-links http://solentware.co.uk/wheels.html chesscalc
+
+at the command prompt.
+
+See `Python`_ and `pip`_ documentation for alternatives and platform-specific points.
+
+Then run 'python -m pip check' to identify other packages which need to be installed.
+
+
+Run
+===
+
+The command to run this package is:
+
+   python -m chesscalc.calculate
+
+You may need to give the path and version of Python depending on your system's configuration:
+
+   <path to python>/python<version> -m chesscalc.calculate
+
+   For example
+
+      C:\\Python33\\python -m chesscalc.calculate
+
+         on Microsoft Windows or
+
+      python3.3 -m chesscalc.calculate
+
+         on Unix-like systems.
+
+Or use the facilities of your desktop (Microsoft Windows, GNOME, KDE, ...) to set up a convenient way of starting calculate.
+
+
+Notes
+=====
+
+ChessCalc makes no attempt to ease the problems arising from not using PGN Tags in the way envisaged in the PGN specification.  For example:
+
+    Not using the WhiteType and BlackType tags to indicate human or algorithmic players.
+
+    Not using the TimeControl tag to indicate the time controls.  This determines if the game is standard, rapid, or blitz (using English Chess Federation terms); or some other distinctions.
+
+    Not using the Mode tag to indicate Online or Over The Board play.
+
+ChessCalc does use the WhiteTeam and BlackTeam tags which appear in PGN files published by `TWIC`_.  At time of writing I have not seen these PGN tags elsewhere.
+
+The legacy sub-package contains some of the implementation prior to version 2.0.0 but this will be removed in the future.
+
+
+.. _Python: https://python.org
+.. _pip: https://packaging.python.org/installing
+.. _PGN: https://www.chessclub.com/help/PGN-spec
+.. _TWIC: https://theweekinchess.com

chesscalc-2.0.0/README

@@ -0,0 +1,77 @@
+=====================================================
+Calculate player performances from chess game results
+=====================================================
+
+.. contents::
+
+
+Description
+===========
+
+This package provides methods to calculate player performances.
+
+Calculate player performances from results of games imported from `PGN`_ format files.
+
+Provide facilities to resolve player identities where inconsistencies exist in the PGN Tag Values for games involving the same player.
+
+Provide facilties to resolve inconsistent identities, time controls or playing modes for example, derived from other PGN Tag Values.
+
+
+Installation Instructions
+=========================
+
+This package is not available on PyPI, or any other package index, but can be installed by typing
+
+   python -m pip install --user --trusted-host solentware.co.uk --find-links http://solentware.co.uk/wheels.html chesscalc
+
+at the command prompt.
+
+See `Python`_ and `pip`_ documentation for alternatives and platform-specific points.
+
+Then run 'python -m pip check' to identify other packages which need to be installed.
+
+
+Run
+===
+
+The command to run this package is:
+
+   python -m chesscalc.calculate
+
+You may need to give the path and version of Python depending on your system's configuration:
+
+   <path to python>/python<version> -m chesscalc.calculate
+
+   For example
+
+      C:\\Python33\\python -m chesscalc.calculate
+
+         on Microsoft Windows or
+
+      python3.3 -m chesscalc.calculate
+
+         on Unix-like systems.
+
+Or use the facilities of your desktop (Microsoft Windows, GNOME, KDE, ...) to set up a convenient way of starting calculate.
+
+
+Notes
+=====
+
+ChessCalc makes no attempt to ease the problems arising from not using PGN Tags in the way envisaged in the PGN specification.  For example:
+
+    Not using the WhiteType and BlackType tags to indicate human or algorithmic players.
+
+    Not using the TimeControl tag to indicate the time controls.  This determines if the game is standard, rapid, or blitz (using English Chess Federation terms); or some other distinctions.
+
+    Not using the Mode tag to indicate Online or Over The Board play.
+
+ChessCalc does use the WhiteTeam and BlackTeam tags which appear in PGN files published by `TWIC`_.  At time of writing I have not seen these PGN tags elsewhere.
+
+The legacy sub-package contains some of the implementation prior to version 2.0.0 but this will be removed in the future.
+
+
+.. _Python: https://python.org
+.. _pip: https://packaging.python.org/installing
+.. _PGN: https://www.chessclub.com/help/PGN-spec
+.. _TWIC: https://theweekinchess.com

chesscalc-2.0.0/chesscalc/__init__.py

@@ -0,0 +1,71 @@
+# __init__.py
+# Copyright 2008 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Calculate player's performances on a set of games.
+
+Performances are calculated by iteration where each player starts with 0 as
+their performance.  The scale used is +50 for a win, -50 for a loss, and 0 for
+a draw, relative to the opponents performance.  English Chess Federation (ECF)
+grades have the same scale.
+
+The performances are not grades because the results of calculations in previous
+runs are not used in this calculation.
+
+"""
+import os
+import datetime
+import traceback
+
+import solentware_base.core.constants as sb_c_constants
+
+APPLICATION_NAME = "ChessPerfCalc"
+ERROR_LOG = "ErrorLog"
+REPORT_DIRECTORY = "_reports"
+
+# Map database module names to application module
+APPLICATION_DATABASE_MODULE = {
+    sb_c_constants.BERKELEYDB_MODULE: __name__ + ".berkeleydb.database",
+    sb_c_constants.BSDDB3_MODULE: __name__ + ".db.database",
+    sb_c_constants.SQLITE3_MODULE: __name__ + ".sqlite.database",
+    sb_c_constants.APSW_MODULE: __name__ + ".apsw.database",
+    sb_c_constants.DPT_MODULE: __name__ + ".dpt.database",
+    sb_c_constants.UNQLITE_MODULE: __name__ + ".unqlite.database",
+    sb_c_constants.VEDIS_MODULE: __name__ + ".vedis.database",
+    sb_c_constants.DB_TCL_MODULE: __name__ + ".db_tkinter.database",
+    sb_c_constants.LMDB_MODULE: __name__ + ".lmdb.database",
+}
+
+del sb_c_constants
+
+
+def write_error_to_log(directory):
+    """Write the exception to the error log with a time stamp.
+
+    Consider using the ExceptionHandler.report_exception(...) method if
+    the write_error_to_log() call is in an instance of a subclass of the
+    solentware_bind.gui.exceptionhandler.ExceptionHandler class.
+
+    """
+    with open(
+        os.path.join(directory, ERROR_LOG),
+        "a",
+        encoding="utf-8",
+    ) as file:
+        file.write(
+            "".join(
+                (
+                    "\n\n\n",
+                    " ".join(
+                        (
+                            APPLICATION_NAME,
+                            "exception report at",
+                            datetime.datetime.now().isoformat(),
+                        )
+                    ),
+                    "\n\n",
+                    traceback.format_exc(),
+                    "\n\n",
+                )
+            )
+        )

chesscalc-2.0.0/chesscalc/apsw/__init__.py

@@ -0,0 +1,5 @@
+# __init__.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Identify apsw as a sub-package in chesscalc."""

chesscalc-2.0.0/chesscalc/apsw/database.py

@@ -0,0 +1,46 @@
+# database.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Chess Performance Calculation database using Sqlite3 via apsw."""
+
+from solentware_base import apsw_database
+
+from ..core.filespec import FileSpec
+from ..basecore import database
+
+
+class Database(database.Database, apsw_database.Database):
+    """Methods and data structures to create, open, and close database."""
+
+    _deferred_update_process = "chesscalc.apsw.database_du"
+
+    def __init__(
+        self,
+        sqlite3file,
+        use_specification_items=None,
+        dpt_records=None,
+        **kargs,
+    ):
+        """Define database specification then delegate."""
+        names = FileSpec(
+            use_specification_items=use_specification_items,
+            dpt_records=dpt_records,
+        )
+
+        super().__init__(
+            names,
+            sqlite3file,
+            use_specification_items=use_specification_items,
+            **kargs,
+        )
+
+    def delete_database(self):
+        """Close and delete the open chess results database."""
+        return super().delete_database(
+            (
+                self.database_file,
+                "-".join((self.database_file, "lock")),
+                "-".join((self.database_file, "journal")),
+            )
+        )

chesscalc-2.0.0/chesscalc/apsw/database_du.py

@@ -0,0 +1,35 @@
+# database_du.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Chess performance database deferred update using Sqlite 3 via apsw."""
+
+from solentware_base import apswdu_database
+from solentware_base import apsw_database
+
+from ..shared import litedu
+from ..shared import alldu
+
+
+class ApswDatabaseduError(Exception):
+    """Exception class for apsw.database_du module."""
+
+
+class Database(alldu.Alldu, litedu.Litedu, apswdu_database.Database):
+    """Provide custom deferred update for chess performance database."""
+
+    def __init__(self, sqlite3file, **kargs):
+        """Delegate with ApswDatabaseduError as exception class."""
+        super().__init__(sqlite3file, ApswDatabaseduError, **kargs)
+
+
+class DatabaseSU(alldu.Alldu, litedu.Litedu, apsw_database.Database):
+    """Provide custom deferred update for chess performance database."""
+
+    def __init__(self, sqlite3file, **kargs):
+        """Delegate with ApswDatabaseduError as exception class."""
+        super().__init__(sqlite3file, ApswDatabaseduError, **kargs)
+
+    # Class structure implies this is not an override at present.
+    def deferred_update_housekeeping(self):
+        """Override to do nothing."""

chesscalc-2.0.0/chesscalc/basecore/__init__.py

@@ -0,0 +1,5 @@
+# __init__.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Identify basecore as a sub-package in chesscalc."""

chesscalc-2.0.0/chesscalc/basecore/database.py

@@ -0,0 +1,66 @@
+# database.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Database methods common to all database engine interfaces."""
+
+import os
+import shutil
+
+from .. import APPLICATION_NAME, ERROR_LOG, REPORT_DIRECTORY
+
+
+class Database:
+    """Provide methods common to all database engine interfaces."""
+
+    # Non *_du database actions are done in separate threads by default,
+    # not the main thread.  Override with 'can_use_thread = False' in
+    # subclasses if necessary.
+    # For SQLite3 the apsw interface is happy with the default, but the
+    # sqlite3 interface gives a sqlite3.programmingerror exception.
+    # For Berkeley DB the bsddb3 and berkeleydb interfaces are happy with
+    # the default, but the tcl via tkinter interface gives a RuntimeError
+    # exception.
+    can_use_thread = True
+
+    def use_deferred_update_process(self):
+        """Return path to deferred update module."""
+        return self._deferred_update_process
+
+    def open_database(self, files=None):
+        """Return '' to fit behaviour of dpt version of this method."""
+        super().open_database(files=files)
+        return ""
+
+    def delete_database(self, names):
+        """Delete database and return message about items not deleted."""
+        listnames = set(n for n in os.listdir(self.home_directory))
+        homenames = set(n for n in names if os.path.basename(n) in listnames)
+        for name in (ERROR_LOG, REPORT_DIRECTORY):
+            if name in listnames:
+                homenames.add(name)
+        if len(listnames - set(os.path.basename(h) for h in homenames)):
+            message = "".join(
+                (
+                    "There is at least one file or folder in\n\n",
+                    self.home_directory,
+                    "\n\nwhich may not be part of the database.  These items ",
+                    "have not been deleted by ",
+                    APPLICATION_NAME,
+                    ".",
+                )
+            )
+        else:
+            message = None
+        self.close_database()
+        for hnm in homenames:
+            hnm = os.path.join(self.home_directory, hnm)
+            if os.path.isdir(hnm):
+                shutil.rmtree(hnm, ignore_errors=True)
+            else:
+                os.remove(hnm)
+        try:
+            os.rmdir(self.home_directory)
+        except (FileNotFoundError, OSError):
+            pass
+        return message

chesscalc-2.0.0/chesscalc/berkeleydb/__init__.py

@@ -0,0 +1,5 @@
+# __init__.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Identify berkeleydb as a sub-package in chesscalc."""

chesscalc-2.0.0/chesscalc/berkeleydb/database.py

@@ -0,0 +1,73 @@
+# database.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Chess Performance Calculation database using Berkeley DB via berkeleydb."""
+
+from berkeleydb.db import (
+    # DB_BTREE,
+    # DB_HASH,
+    # DB_RECNO,
+    # DB_DUPSORT,
+    DB_CREATE,
+    DB_RECOVER,
+    DB_INIT_MPOOL,
+    DB_INIT_LOCK,
+    DB_INIT_LOG,
+    DB_INIT_TXN,
+    DB_PRIVATE,
+)
+
+from solentware_base import berkeleydb_database
+
+from ..core.filespec import FileSpec
+from ..basecore import database
+
+
+class Database(database.Database, berkeleydb_database.Database):
+    """Methods and data structures to create, open, and close database."""
+
+    _deferred_update_process = "chesscalc.berkeleydb.database_du"
+
+    def __init__(
+        self,
+        DBfile,
+        use_specification_items=None,
+        dpt_records=None,
+        **kargs,
+    ):
+        """Define database specification and environment then delegate."""
+        dbnames = FileSpec(
+            use_specification_items=use_specification_items,
+            dpt_records=dpt_records,
+        )
+
+        environment = {
+            "flags": (
+                DB_CREATE
+                | DB_RECOVER
+                | DB_INIT_MPOOL
+                | DB_INIT_LOCK
+                | DB_INIT_LOG
+                | DB_INIT_TXN
+                | DB_PRIVATE
+            ),
+        }
+
+        super().__init__(
+            dbnames,
+            DBfile,
+            environment,
+            use_specification_items=use_specification_items,
+            **kargs,
+        )
+
+    def delete_database(self):
+        """Close and delete the open chess results database."""
+        return super().delete_database(
+            (
+                self.database_file,
+                "-".join((self.database_file, "lock")),
+                self.dbenv.get_lg_dir().decode(),
+            )
+        )

chesscalc-2.0.0/chesscalc/berkeleydb/database_du.py

@@ -0,0 +1,63 @@
+# database_du.py
+# Copyright 2023 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Chess performance deferred update using Berkeley DB via berkeleydb."""
+
+import berkeleydb.db
+
+from solentware_base import berkeleydbdu_database
+from solentware_base import berkeleydb_database
+
+from ..shared import dbdu
+from ..shared import alldu
+
+
+class BerkeleydbDatabaseduError(Exception):
+    """Exception class for berkeleydb.database_du module."""
+
+
+class Database(alldu.Alldu, dbdu.Dbdu, berkeleydbdu_database.Database):
+    """Provide custom deferred update for chess performance database."""
+
+    def __init__(self, DBfile, **kargs):
+        """Delegate with BerkeleydbDatabaseduError as exception class."""
+        super().__init__(
+            DBfile,
+            BerkeleydbDatabaseduError,
+            (
+                berkeleydb.db.DB_CREATE
+                | berkeleydb.db.DB_RECOVER
+                | berkeleydb.db.DB_INIT_MPOOL
+                | berkeleydb.db.DB_INIT_LOCK
+                | berkeleydb.db.DB_INIT_LOG
+                | berkeleydb.db.DB_INIT_TXN
+                | berkeleydb.db.DB_PRIVATE
+            ),
+            **kargs
+        )
+
+
+class DatabaseSU(alldu.Alldu, dbdu.Dbdu, berkeleydb_database.Database):
+    """Provide custom deferred update for chess performance database."""
+
+    def __init__(self, DBfile, **kargs):
+        """Delegate with BerkeleydbDatabaseduError as exception class."""
+        super().__init__(
+            DBfile,
+            BerkeleydbDatabaseduError,
+            (
+                berkeleydb.db.DB_CREATE
+                | berkeleydb.db.DB_RECOVER
+                | berkeleydb.db.DB_INIT_MPOOL
+                | berkeleydb.db.DB_INIT_LOCK
+                | berkeleydb.db.DB_INIT_LOG
+                | berkeleydb.db.DB_INIT_TXN
+                | berkeleydb.db.DB_PRIVATE
+            ),
+            **kargs
+        )
+
+    # Class structure implies this is not an override at present.
+    def deferred_update_housekeeping(self):
+        """Override to do nothing."""

chesscalc-2.0.0/chesscalc/calculate.py

@@ -0,0 +1,79 @@
+# calculate.py
+# Copyright 2012 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Calculate performances from a file of chess game results."""
+
+if __name__ == "__main__":
+    import multiprocessing
+
+    from . import APPLICATION_NAME
+
+    multiprocessing.set_start_method("spawn")
+    del multiprocessing
+
+    try:
+        from solentware_misc.gui.startstop import (
+            start_application_exception,
+            stop_application,
+            application_exception,
+        )
+    except Exception as error:
+        import tkinter.messagebox
+
+        try:
+            tkinter.messagebox.showerror(
+                title="Start Exception",
+                message=".\n\nThe reported exception is:\n\n".join(
+                    (
+                        " ".join(
+                            (
+                                "Unable to import",
+                                "solentware_misc.gui.startstop module",
+                            )
+                        ),
+                        str(error),
+                    )
+                ),
+            )
+        except tkinter.TclError:
+            pass
+        raise SystemExit(
+            "Unable to import start application utilities"
+        ) from error
+    try:
+        from .gui.calculator import Calculator
+    except Exception as error:
+        start_application_exception(
+            error, appname=APPLICATION_NAME, action="import"
+        )
+        raise SystemExit(
+            " import ".join(("Unable to", APPLICATION_NAME))
+        ) from error
+    try:
+        app = Calculator()
+    except Exception as error:
+        start_application_exception(
+            error, appname=APPLICATION_NAME, action="initialise"
+        )
+        raise SystemExit(
+            " initialise ".join(("Unable to", APPLICATION_NAME))
+        ) from error
+    try:
+        app.widget.mainloop()
+    except SystemExit:
+        stop_application(app, app.widget)
+        raise
+    except Exception as error:
+        application_exception(
+            error,
+            app,
+            app.widget,
+            title="Chess Performace Calculator",
+            appname=APPLICATION_NAME,
+        )
+        raise SystemExit(
+            " reporting exception in ".join(
+                ("Exception while", APPLICATION_NAME)
+            )
+        ) from error

chesscalc-2.0.0/chesscalc/core/__init__.py

@@ -0,0 +1,5 @@
+# __init__.py
+# Copyright 2009 Roger Marsh
+# Licence: See LICENCE (BSD licence)
+
+"""Identify core as a sub-package in chesscalc."""