Precommit (#64)

* Automatic pre-commit fixes
* Fixed variances in tests
* precommit cleanup, NullPartitionedGrouped fix
* Moved DistributionGenerator to providers.py

Author: tim-band

.github/workflows/pre-commit.yml

@@ -9,9 +9,9 @@ on:
 env:
   # This should be the default but we'll be explicit
   PRE_COMMIT_HOME: ~/.caches/pre-commit
-  PYTHON_VERSION: "3.9"
+  PYTHON_VERSION: "3.10"
 jobs:
-  the_job:
+  clean-check:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code

.github/workflows/tests.yml

@@ -8,50 +8,31 @@ on:
       - main
 env:
   # This should be the default but we'll be explicit
-  PYTHON_VERSION: "3.9"
+  PYTHON_VERSION: "3.10"
 jobs:
-  the_job:
+  unit-tests:
     runs-on: ubuntu-latest
-    services:
-      postgres:
-        image: postgres:15
-        env:
-          POSTGRES_PASSWORD: password
-        ports:
-          - 5432:5432
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-      - name: Bootstrap poetry
+      - name: Start PostgreSQL
         shell: bash
         run: |
-          python -m ensurepip
-          python -m pip install --upgrade pip
-          python -m pip install poetry
+          sudo systemctl start postgresql.service
+      - name: Install poetry
+        shell: bash
+        run: |
+          sudo apt install python3-poetry
       - name: Configure poetry
         shell: bash
         run: |
           python -m poetry config virtualenvs.in-project true
-      # - name: Cache Poetry dependencies
-      #   uses: actions/cache@v3
-      #   id: poetry-cache
-      #   with:
-      #     path: .venv
-      #     key: venv-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('poetry.lock') }}
       - name: Install dependencies
         shell: bash
         if: steps.poetry-cache.outputs.cache-hit != 'true'
         run: |
           python -m poetry install --all-extras
-      - name: Create src database
-        shell: bash
-        run: |
-          PGPASSWORD=password psql --host=localhost --username=postgres --set="ON_ERROR_STOP=1" --file=tests/examples/src.dump
-      - name: Run Unit Tests
+      - name: Run tests
         shell: bash
         run: |
-          REQUIRES_DB=1 poetry run python -m unittest discover --verbose tests
+          poetry run python -m unittest

.pre-commit-config.yaml

@@ -3,21 +3,22 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
+        exclude: docs/(source|build/html)/_static/
       - id: end-of-file-fixer
         exclude: docs/source/_static/
       - id: check-yaml
       - id: check-added-large-files
   - repo: https://github.com/markdownlint/markdownlint
     # Note the "v"
-    rev: v0.11.0
+    rev: v0.12.0
     hooks:
       - id: markdownlint
         args: [--style=mdl_style.rb]
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.8.0.4
+    rev: v0.11.0.1
     hooks:
       - id: shellcheck
   - repo: local
@@ -39,8 +40,7 @@ repos:
         language: system
         types: ['python']
         exclude: (?x)(
-          tests/examples|
-          tests/workspace
+          tests/examples
           )
       - id: isort
         name: isort
@@ -49,7 +49,6 @@ repos:
         types: ['python']
         exclude: (?x)(
           tests/examples|
-          tests/workspace|
           examples
           )
       - id: pylint
@@ -76,7 +75,6 @@ repos:
         language: system
         exclude: (?x)(
           tests/examples|
-          tests/workspace|
           examples
           )
         types: ['python']

.pylintrc

@@ -24,8 +24,7 @@ ignore=CVS
 
 # Add files or directories matching the regex patterns to the ignore-list. The
 # regex matches against paths.
-ignore-paths=tests/examples,
-             tests/workspace
+ignore-paths=tests/examples
 
 # Files or directories matching the regex patterns are skipped. The regex
 # matches against base names, not paths.
@@ -53,7 +52,7 @@ persistent=yes
 
 # Min Python version to use for version dependend checks. Will default to the
 # version used to run pylint.
-py-version=3.9
+py-version=3.10
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.10"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"

CONTRIBUTING.md

@@ -47,16 +47,6 @@ Executing unit tests is straightforward:
 python -m unittest discover --verbose tests/
 ```
 
-for tests that are currently maintained.
-
-## Running functional tests
-
-These tests do not currently work, and will be replaced by unit tests.
-
-Functional tests require PostgreSQL to be installed.
-
-    *WARNING: Some MacOS systems [do not recognise the 'en_US.utf8' locale](https://apple.stackexchange.com/questions/206495/load-a-locale-from-usr-local-share-locale-in-os-x). As a workaround, replace `en_US.utf8` with `en_US.UTF-8` on every `*.dump` file.*
-
 ## Building documentation locally
 
 ```bash