From 44ad5da33957c3f36db8ebb388b0e4004d1998db Mon Sep 17 00:00:00 2001 From: Ethan Paul <24588726+enpaul@users.noreply.github.com> Date: Wed, 7 Sep 2022 14:35:30 -0400 Subject: [PATCH] Update name of check CI workflow to improve clarity --- .github/workflows/ci.yaml | 15 ++++++++++++++- peewee_plus.py | 11 +++++++---- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 09b71b7..176831f 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -7,7 +7,7 @@ on: branches: ["devel"] jobs: Test: - name: Python ${{ matrix.python.version }} + name: Test with Python ${{ matrix.python.version }} runs-on: ubuntu-latest strategy: matrix: @@ -26,10 +26,12 @@ jobs: steps: - name: Checkout uses: actions/checkout@v2 + - name: Install Python ${{ matrix.python.version }} uses: actions/setup-python@v4 with: python-version: ${{ matrix.python.version }} + - name: Configure Job Cache uses: actions/cache@v3 with: @@ -41,21 +43,27 @@ jobs: # will be invalidated, and thus all packages will be redownloaded, if the # lockfile is updated key: ${{ runner.os }}-${{ matrix.python.toxenv }}-${{ hashFiles('**/poetry.lock') }} + - name: Configure Path run: echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: Configure Environment run: .github/scripts/setup-env.sh + - name: Run Toxenv ${{ matrix.python.toxenv }} run: poetry run tox -e ${{ matrix.python.toxenv }} Check: + name: Security, Linting, Formatting, Typing runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 + - name: Install Python 3.8 uses: actions/setup-python@v4 with: python-version: 3.8 + - name: Configure Job Cache uses: actions/cache@v3 with: @@ -66,13 +74,18 @@ jobs: # Hardcoded 'py310' slug here lets this cache piggyback on the 'py310' cache # that is generated for the tests above key: ${{ runner.os }}-py310-${{ hashFiles('**/poetry.lock') }} + - name: Configure Path run: echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: Configure Environment run: .github/scripts/setup-env.sh + - name: Run Static Analysis Checks run: poetry run tox -e static + - name: Run Static Analysis Checks (Tests) run: poetry run tox -e static-tests + - name: Run Security Checks run: poetry run tox -e security diff --git a/peewee_plus.py b/peewee_plus.py index b8b062a..70758a9 100644 --- a/peewee_plus.py +++ b/peewee_plus.py @@ -176,7 +176,10 @@ def flat_transaction(interface: peewee.Database): return outer -class PathField(peewee.CharField): +# TODO: The disable=abstract-method pragmas below are to get around new linting warnings +# in pylint>2.12, but they haven't been addressed properly. They should be revisited +# and fixed properly in the future. +class PathField(peewee.CharField): # pylint: disable=abstract-method """Field class for storing file paths This field can be used to simply store pathlib paths in the database without needing to @@ -234,7 +237,7 @@ class PathField(peewee.CharField): ) -class PrecisionFloatField(peewee.FloatField): +class PrecisionFloatField(peewee.FloatField): # pylint: disable=abstract-method """Field class for storing floats with custom precision parameters This field adds support for specifying the ``M`` and ``D`` precision parameters of a @@ -264,7 +267,7 @@ class PrecisionFloatField(peewee.FloatField): return [self.max_digits, self.decimal_places] -class JSONField(peewee.TextField): +class JSONField(peewee.TextField): # pylint: disable=abstract-method """Field class for storing JSON-serializable data This field can be used to store a dictionary of data directly in the database without needing @@ -319,7 +322,7 @@ class JSONField(peewee.TextField): ) from err -class EnumField(peewee.CharField): +class EnumField(peewee.CharField): # pylint: disable=abstract-method """Field class for storing Enums This field can be used for storing members of an :class:`enum.Enum` in the database,