Merge branch 'main' into missing-exception

hynek · Jul 23, 2023 · 228914c · 228914c
2 parents 6ca2aa7 + 7c8366e
commit 228914c
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 57 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,43 +13,26 @@ env:
   PIP_DISABLE_PIP_VERSION_CHECK: "1"
   PIP_NO_PYTHON_VERSION_WARNING: "1"
 
-  # For re-actors/checkout-python-sdist
-  SETUPTOOLS_SCM_PRETEND_VERSION: "1.0"  # hard-code version for predictable sdist names
-  sdist-artifact: python-package-distributions
-  sdist-name: structlog-1.0.tar.gz
-
   # N.B. default Python version for setup-python comes from the .python-version
   # file at the root of the project.
 
 permissions: {}
 
 jobs:
-  build-sdist:
-    name: 📦 Build the source distribution
+  build-package:
+    name: Build & verify package
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
         with:
-          cache: pip
-      - run: python -Im pip install build
+          fetch-depth: 0
 
-      - run: python -Im build --sdist
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.sdist-artifact }}
-          # NOTE: Exact expected file names are specified here
-          # NOTE: as a safety measure — if anything weird ends
-          # NOTE: up being in this dir or not all dists will be
-          # NOTE: produced, this will fail the workflow.
-          path: dist/${{ env.sdist-name }}
-          retention-days: 15
+      - uses: hynek/build-and-inspect-python-package@v1
 
   tests:
     name: Tests & API Mypy on ${{ matrix.python-version }}
-    needs: build-sdist
+    needs: build-package
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -62,11 +45,12 @@ jobs:
           - "3.12"
 
     steps:
-      - name: Get source code from pre-built sdist
-        uses: re-actors/checkout-python-sdist@release/v1
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v3
         with:
-          source-tarball-name: ${{ env.sdist-name }}
-          workflow-artifact-name: ${{ env.sdist-artifact }}
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1  # needed for config files
 
       - uses: actions/setup-python@v4
         with:
@@ -75,8 +59,8 @@ jobs:
           cache: pip
 
       - run: python -Im pip install tox
-      - run: python -Im tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
-      - run: python -Im tox run -e mypy-api
+      - run: python -Im tox run --installpkg dist/*.whl -f py$(echo ${{ matrix.python-version }} | tr -d .)
+      - run: python -Im tox run --installpkg dist/*.whl -e mypy-api
 
       - name: Upload coverage data
         uses: actions/upload-artifact@v3
@@ -91,12 +75,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Get source code from pre-built sdist
-        uses: re-actors/checkout-python-sdist@release/v1
-        with:
-          source-tarball-name: ${{ env.sdist-name }}
-          workflow-artifact-name: ${{ env.sdist-artifact }}
-
+      - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
           cache: pip
@@ -125,17 +104,19 @@ jobs:
           path: htmlcov
         if: ${{ failure() }}
 
-  mypy:
+  mypy-pkg:
     name: Type-check package
-    needs: build-sdist
+    needs: build-package
     runs-on: ubuntu-latest
 
     steps:
-      - name: Get source code from pre-built sdist
-        uses: re-actors/checkout-python-sdist@release/v1
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v3
         with:
-          source-tarball-name: ${{ env.sdist-name }}
-          workflow-artifact-name: ${{ env.sdist-artifact }}
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1  # needed for config files
+
       - uses: actions/setup-python@v4
         with:
           allow-prereleases: true
@@ -144,18 +125,20 @@ jobs:
       - name: Prepare & run tox
         run: |
           python -Im pip install tox
-          python -Im tox run -e mypy-pkg
+          python -Im tox run --installpkg dist/*.whl -e mypy-pkg
 
   docs:
     name: Build docs & run doctests
-    needs: build-sdist
+    needs: build-package
     runs-on: ubuntu-latest
     steps:
-      - name: Get source code from pre-built sdist
-        uses: re-actors/checkout-python-sdist@release/v1
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v3
         with:
-          source-tarball-name: ${{ env.sdist-name }}
-          workflow-artifact-name: ${{ env.sdist-artifact }}
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1  # needed for config files
+
       - uses: actions/setup-python@v4
         with:
           # Keep in sync with tox.ini/docs & .readthedocs.yaml
@@ -189,6 +172,7 @@ jobs:
       - coverage
       - docs
       - install-dev
+      - mypy-pkg
 
     runs-on: ubuntu-latest
 
@@ -201,15 +185,11 @@ jobs:
 
   colors:
     name: Visual check for color settings using env variables
-    needs: build-sdist
+    needs: build-package
     runs-on: ubuntu-latest
 
     steps:
-      - name: Get source code from pre-built sdist
-        uses: re-actors/checkout-python-sdist@release/v1
-        with:
-          source-tarball-name: ${{ env.sdist-name }}
-          workflow-artifact-name: ${{ env.sdist-artifact }}
+      - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
           cache: pip

diff --git a/.github/workflows/pypi-package.yml b/.github/workflows/pypi-package.yml
@@ -5,8 +5,6 @@ on:
   push:
     branches: [main]
     tags: ["*"]
-  pull_request:
-    branches: [main]
   release:
     types:
       - published
@@ -17,7 +15,6 @@ permissions:
   id-token: write
 
 jobs:
-  # Always build & lint package.
   build-package:
     name: Build & verify package
     runs-on: ubuntu-latest

diff --git a/src/structlog/__init__.py b/src/structlog/__init__.py
@@ -94,13 +94,13 @@
 def __getattr__(name: str) -> str:
     import warnings
 
-    from importlib.metadata import metadata
+    from importlib.metadata import metadata, version
 
     dunder_to_metadata = {
-        "__version__": "version",
         "__description__": "summary",
         "__uri__": "",
         "__email__": "",
+        "__version__": "",
     }
     if name not in dunder_to_metadata.keys():
         msg = f"module {__name__} has no attribute {name}"
@@ -114,6 +114,8 @@ def __getattr__(name: str) -> str:
             DeprecationWarning,
             stacklevel=2,
         )
+    else:
+        return version("structlog")
 
     meta = metadata("structlog")