Merge branch 'ggtracker:upstream' into upstream

Author: manuelseeger

.circleci/config.yml

@@ -2,32 +2,30 @@ version: 2.0
 
 build_and_test: &build_and_test_steps
   - checkout
-  - run: sudo pip install --upgrade pip
-  - run: sudo pip install pytest -r requirements.txt
-  - run: pip install --user .
-  - run: python --version ; pip --version ; pwd ; ls -l
+  # Do not use `sudo pip`
+  # pipx is already installed but `pipx list` is empty
+  - run: python --version ; pip --version ; pipx --version ; pwd ; ls -l
+  - run: pip install pytest -r requirements.txt
+  - run: pip install --editable .
   - run: pytest
 
 
 jobs:
   StyleCheck:
     docker:
-      - image: circleci/python:3.10
+      - image: cimg/python:3.11
     steps:
       - checkout
-      - run: sudo pip install black codespell flake8
       - run: python --version ; pip --version ; pwd ; ls -l
+      - run: pip install black codespell ruff
       - run: codespell -L queenland,uint
-      # stop the build if there are Python syntax errors or undefined names
-      - run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-      # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
-      - run: flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - run: ruff .
       - run: black . --check
 
 
   Python3:
     docker:
-      - image: circleci/python:3.10
+      - image: cimg/python:3.11
     steps: *build_and_test_steps
 
 

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 Support
 =========
 
-For real-time support, please visit #sc2reader on the FreeNode.net IRC. For all other support please use the sc2reader@googlegroups.com mailing list or open an issue in the github tracker.
+As of Sept 2023, the best way to get support on sc2reader is on the GitHub project page. Preferably, it would be a new discussion https://github.com/ggtracker/sc2reader/discussions but can also be submitted as n issue
 
 Issues
 =========
@@ -14,15 +14,15 @@ If you can't share your code/replays publicly try to replicate with a smaller sc
 Patches
 =========
 
-Please submit patches by pull request where possible. Patches should add a test to confirm their fix and should not break previously working tests.   Circle CI automatically runs tests on each pull request so please check https://circleci.com/gh/ggtracker/sc2reader to see the results of those tests.
+Please submit patches by pull request where possible. Patches should add a test to confirm their fix and should not break previously working tests.  Circle CI automatically runs tests on each pull request so please check https://circleci.com/gh/ggtracker/sc2reader to see the results of those tests.
 
 If you are having trouble running/add/fixing tests for your patch let me know and I'll see if I can help.
 
 
 Coding Style
 ==============
 
-We'd like our code to follow PEP8 coding style in this project.
+We would like our code to follow [Ruff](https://docs.astral.sh/ruff/) coding style in this project.
 We use [python/black](https://github.com/python/black) in order to make our lives easier.
 We propose you do the same within this project, otherwise you might be asked to
 reformat your pull requests.

STYLE_GUIDE.rst

@@ -1,12 +1,11 @@
 STYLE GUIDE
 ==============
 
-As a rough style guide, please lint your code with black, codespell, and flake8::
+As a rough style guide, please lint your code with black, codespell, and ruff::
 
-    pip install black codespell flake8
+    pip install black codespell ruff
     codespell -L queenland,uint
-    flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-    flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    ruff .
     black . --check
 
 More up-to-date checks may be detailed in `.circleci/config.yml`.

docs/source/conf.py

@@ -10,7 +10,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
+import sys
+
 import sc2reader
 
 autodoc_member_order = "bysource"

examples/sc2autosave.py

@@ -184,7 +184,6 @@ def run(args):
 
     # We break out of this loop in batch mode and on KeyboardInterrupt
     while True:
-
         # The file scan uses the arguments and the state to filter down to
         # only new (since the last sync time) files.
         for path in scan(args, state):
@@ -193,8 +192,9 @@ def run(args):
                 replay = sc2reader.load_replay(path, load_level=2)
             except KeyboardInterrupt:
                 raise
-            except:
+            except Exception as e:
                 # Failure to parse
+                args.log.write(f"{e!r}")
                 file_name = os.path.basename(path)
                 directory = make_directory(args, ("parse_error",))
                 new_path = os.path.join(directory, file_name)

examples/sc2store.py

@@ -11,8 +11,6 @@
 
 from pprint import PrettyPrinter
 
-pprint = PrettyPrinter(indent=2).pprint
-
 from sqlalchemy import create_engine
 from sqlalchemy import Column, ForeignKey, distinct, Table
 from sqlalchemy import Integer, String, Sequence, DateTime
@@ -23,6 +21,8 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.ext.associationproxy import association_proxy
 
+pprint = PrettyPrinter(indent=2).pprint
+
 Base = declarative_base()
 
 party_member = Table(

pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+  "setuptools>=61.2",
+]
+
+[project]
+name = "sc2reader"
+description = "Utility for parsing Starcraft II replay files"
+keywords = [
+  "parser",
+  "replay",
+  "sc2",
+  "starcraft 2",
+]
+license = {text = "MIT"}
+authors = [{name = "Kevin Leung", email = "[email protected]"}]
+requires-python = ">=3.7"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+  "Topic :: Games/Entertainment",
+  "Topic :: Games/Entertainment :: Real Time Strategy",
+  "Topic :: Software Development",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Utilities",
+]
+dynamic = [
+  "readme",
+  "version",
+]
+dependencies = [
+  "mpyq",
+  "pillow",
+]
+[project.optional-dependencies]
+testing = [
+  "pytest",
+]
+[project.urls]
+Homepage = "https://github.com/ggtracker/sc2reader"
+[project.scripts]
+sc2attributes = "sc2reader.scripts.sc2attributes:main"
+sc2json = "sc2reader.scripts.sc2json:main"
+sc2parse = "sc2reader.scripts.sc2parse:main"
+sc2printer = "sc2reader.scripts.sc2printer:main"
+sc2replayer = "sc2reader.scripts.sc2replayer:main"
+
+[tool.setuptools]
+include-package-data = true
+zip-safe = true
+platforms = ["any"]
+
+[tool.setuptools.dynamic]
+readme = {file = ["README.rst", "CHANGELOG.rst"]}
+version = {attr = "sc2reader.__version__"}
+
+[tool.setuptools.packages]
+find = {namespaces = false}

ruff.toml

@@ -0,0 +1,7 @@
+ignore = [
+    "F401",  # module imported but unused; consider using `importlib.util.find_spec` to test for availability
+    "F403",  # Run `removestar` on this codebase
+    "F405",  # Run `removestar` on this codebase
+    "F841",  # Run `ruff --select=F841 --fix .`
+]
+line-length=129

sc2reader/constants.py

@@ -1,3 +1,6 @@
+import json
+import pkgutil
+
 # These are found in Repack-MPQ/fileset.{locale}#Mods#Core.SC2Mod#{locale}.SC2Data/LocalizedData/Editor/EditorCategoryStrings.txt
 # EDSTR_CATEGORY_Race
 # EDSTR_PLAYERPROPS_RACE
@@ -101,9 +104,6 @@
 }
 
 
-import json
-import pkgutil
-
 attributes_json = pkgutil.get_data("sc2reader.data", "attributes.json").decode("utf8")
 attributes_dict = json.loads(attributes_json)
 LOBBY_PROPERTIES = dict()