plain-parser 0.1.2.dev6__tar.gz → 0.1.3__tar.gz

plain_parser-0.1.3/.github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 3
+    commit-message:
+      prefix: "chore"
+    labels:
+      - "dependencies"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "ci"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    groups:
+      actions-minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/.github/workflows/lint-and-test.yml

@@ -9,12 +9,17 @@ on:
   # Lets the publish workflows run these checks as a job and depend on it.
   workflow_call:
 
+permissions:
+  contents: read
+
 jobs:
   lint-and-test:
     name: Lint and test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
       - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: "3.11"

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/.github/workflows/publish-dev-to-pypi.yml

@@ -47,13 +47,15 @@ jobs:
         with:
           # hatch-vcs derives the version from git tags, so we need full history.
           fetch-depth: 0
+          persist-credentials: false
 
       - name: Install uv
         # uv provisions its own Python (honoring requires-python), so no
         # separate actions/setup-python step is needed.
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          echo "$HOME/.local/bin" >> $GITHUB_PATH
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: "0.12.23"
+          enable-cache: false
 
       - name: Compute dev version
         id: version
@@ -65,7 +67,7 @@ jobs:
         # run number as the dev counter: it is strictly increasing, so each
         # merge sorts after the last and re-runs never collide.
         run: |
-          RAW=$(uvx --from setuptools-scm python -c \
+          RAW=$(uvx --from setuptools-scm==10.3.4 python -c \
             "from setuptools_scm import get_version; print(get_version())")
           echo "setuptools-scm reports: $RAW"
 
@@ -110,7 +112,7 @@ jobs:
   publish-dev:
     name: Publish dev build to PyPI
     needs: build
-    if: needs.build.outputs.should-publish == 'true'
+    if: github.ref == 'refs/heads/main' && needs.build.outputs.should-publish == 'true'
     runs-on: ubuntu-latest
     environment:
       name: pypi
@@ -120,9 +122,6 @@ jobs:
       # authenticate this run — no long-lived API token needed.
       id-token: write
 
-    env:
-      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-
     steps:
       - name: Download distribution packages
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
@@ -138,20 +137,27 @@ jobs:
           skip-existing: true
 
       - name: Notify Slack (success)
-        if: ${{ success() && env.SLACK_WEBHOOK_URL != '' }}
+        if: success()
+        continue-on-error: true
         env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
           VERSION: ${{ needs.build.outputs.version }}
         run: |
           # Spell out the --pre install: a plain "pip install plain-parser" will
           # NOT pick this up, which otherwise reads as a broken publish.
           TEXT="*plain-parser*: dev build \`$VERSION\` published to PyPI :test_tube:. Normal installs are unaffected — try it with \`pip install --pre plain-parser==$VERSION\`."
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
             --data "$(jq -n --arg t "$TEXT" '{text:$t}')"
 
       - name: Notify Slack (failure)
-        if: ${{ failure() && env.SLACK_WEBHOOK_URL != '' }}
+        if: failure()
+        continue-on-error: true
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
         run: |
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          RUN_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
+          TEXT="*plain-parser*: Publishing dev build to PyPI FAILED :x: (commit \`$GITHUB_SHA\`). See <$RUN_URL|the run log>."
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
-            --data "{\"text\":\"*plain-parser*: Publishing dev build to PyPI FAILED :x: (commit \`${{ github.sha }}\`). See <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|the run log>.\"}"
+            --data "$(jq -n --arg t "$TEXT" '{text:$t}')"

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/.github/workflows/publish-to-pypi.yml

@@ -23,30 +23,34 @@ jobs:
     needs: pre-publish-checks
     runs-on: ubuntu-latest
     permissions:
-      contents: write
-
-    env:
-      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+      contents: read
 
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           # hatch-vcs derives the version from git tags, so we need full history.
           fetch-depth: 0
+          persist-credentials: false
 
       - name: Notify Slack (start)
-        if: ${{ env.SLACK_WEBHOOK_URL != '' }}
+        continue-on-error: true
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          TAG: ${{ github.ref_name }}
+          ACTOR: ${{ github.actor }}
         run: |
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          TEXT="*plain-parser*: Release \`$TAG\` published by *$ACTOR* — building and publishing to PyPI..."
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
-            --data "{\"text\":\"*plain-parser*: Release \`${{ github.ref_name }}\` published by *${{ github.actor }}* — building and publishing to PyPI...\"}"
+            --data "$(jq -n --arg t "$TEXT" '{text:$t}')"
 
       - name: Install uv
         # uv provisions its own Python (honoring requires-python), so no
         # separate actions/setup-python step is needed.
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          echo "$HOME/.local/bin" >> $GITHUB_PATH
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: "0.12.23"
+          enable-cache: false
 
       - name: Build package
         # hatch-vcs reads the version straight from the release tag.
@@ -61,22 +65,57 @@ jobs:
           name: python-package-distributions
           path: dist/
 
+      - name: Notify Slack (build failure)
+        if: failure()
+        continue-on-error: true
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          RUN_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
+          TEXT="*plain-parser*: Build of \`$TAG\` FAILED :x:. Nothing was published to PyPI. See <$RUN_URL|the run log>."
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
+            -H 'Content-type: application/json' \
+            --data "$(jq -n --arg t "$TEXT" '{text:$t}')"
+
+  upload-release-assets:
+    name: Upload assets to GitHub Release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download distribution packages
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+
       - name: Upload assets to GitHub Release
         env:
           GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          TAG: ${{ github.ref_name }}
         run: |
-          gh release upload ${{ github.ref_name }} dist/* --clobber
+          gh release upload "$TAG" dist/* --clobber
 
-      - name: Notify Slack (build failure)
-        if: ${{ failure() && env.SLACK_WEBHOOK_URL != '' }}
+      - name: Notify Slack (upload failure)
+        if: failure()
+        continue-on-error: true
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          TAG: ${{ github.ref_name }}
         run: |
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          RUN_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
+          TEXT="*plain-parser*: Uploading \`$TAG\` to the GitHub Release FAILED :x:. Nothing was published to PyPI. See <$RUN_URL|the run log>."
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
-            --data "{\"text\":\"*plain-parser*: Build of \`${{ github.ref_name }}\` FAILED :x:. Nothing was published to PyPI. See <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|the run log>.\"}"
+            --data "$(jq -n --arg t "$TEXT" '{text:$t}')"
 
   publish-to-pypi:
     name: Publish to PyPI
-    needs: build
+    needs: [build, upload-release-assets]
     runs-on: ubuntu-latest
     environment:
       name: pypi
@@ -86,9 +125,6 @@ jobs:
       # authenticate this run — no long-lived API token needed.
       id-token: write
 
-    env:
-      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-
     steps:
       - name: Download distribution packages
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
@@ -100,8 +136,10 @@ jobs:
         uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # release/v1
 
       - name: Notify Slack (success)
-        if: ${{ success() && env.SLACK_WEBHOOK_URL != '' }}
+        if: success()
+        continue-on-error: true
         env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
           # GitHub marks the release itself as a pre-release; the tag
           # (v0.2.0rc1) carries the same intent for PEP 440.
           IS_PRERELEASE: ${{ github.event.release.prerelease }}
@@ -115,13 +153,19 @@ jobs:
           else
             TEXT="*plain-parser*: \`$TAG\` published to PyPI :white_check_mark:. Install with \`pip install --upgrade plain-parser\`."
           fi
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
             --data "$(jq -n --arg t "$TEXT" '{text:$t}')"
 
       - name: Notify Slack (failure)
-        if: ${{ failure() && env.SLACK_WEBHOOK_URL != '' }}
+        if: failure()
+        continue-on-error: true
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          TAG: ${{ github.ref_name }}
         run: |
-          curl -s -X POST "$SLACK_WEBHOOK_URL" \
+          RUN_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
+          TEXT="*plain-parser*: Publishing \`$TAG\` to PyPI FAILED :x:. See <$RUN_URL|the run log>."
+          curl -sS --fail -X POST "$SLACK_WEBHOOK_URL" \
             -H 'Content-type: application/json' \
-            --data "{\"text\":\"*plain-parser*: Publishing \`${{ github.ref_name }}\` to PyPI FAILED :x:. See <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|the run log>.\"}"
+            --data "$(jq -n --arg t "$TEXT" '{text:$t}')"

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: plain-parser
-Version: 0.1.2.dev6
+Version: 0.1.3
 Summary: Parser for ***plain specification files
 License-Expression: MIT
 License-File: LICENSE

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling>=1.32,<2", "hatch-vcs>=0.5,<0.6"]
 build-backend = "hatchling.build"
 
 [project]

{plain_parser-0.1.2.dev6 → plain_parser-0.1.3}/src/plain_parser/plain_file.py

@@ -715,11 +715,13 @@ def process_required_modules(
     all_required_modules: list[str],
     modules_trace: list[str],
     chain: list[tuple[str, dict]],
+    module_exports: dict[str, list[mistletoe.block_token.token]],
 ) -> list[mistletoe.block_token.token]:
     """Parse and fully validate every required module, deepest first.
 
-    Appends ``(module name, marshalled plain source tree)`` to ``chain`` for each module not already in it
-    and returns the exported definitions of the directly required modules.
+    Appends ``(module name, marshalled plain source tree)`` to ``chain`` for each module not already in it,
+    records each module's exported definitions in ``module_exports``, and returns the exported definitions
+    of the directly required modules.
     """
     exported_definitions = list[mistletoe.block_token.token]()
     for module_name in required_modules:
@@ -727,6 +729,8 @@ def process_required_modules(
             raise PlainSyntaxError(f"Plain syntax error: Circular required module detected: {module_name}.")
 
         if len(all_required_modules) > 0 and module_name == all_required_modules[-1]:
+            # Already processed as an earlier entry; its exports are still visible to this module.
+            exported_definitions.extend(module_exports[module_name])
             continue
 
         code_variables: dict = {}
@@ -750,8 +754,10 @@ def process_required_modules(
                 all_required_modules,
                 modules_trace + [module_name],
                 chain,
+                module_exports,
             )
 
+        own_exported_definitions = list[mistletoe.block_token.token]()
         if EXPORTED_CONCEPTS_DIRECTIVE in plain_file_parse_result.plain_source_obj.metadata:
             exported_concepts = list[str]()
             for concept in plain_file_parse_result.plain_source_obj.metadata[EXPORTED_CONCEPTS_DIRECTIVE]:
@@ -759,11 +765,13 @@ def process_required_modules(
 
             with PlainRenderer() as renderer:
                 for exported_concept in exported_concepts:
-                    exported_definitions.extend(
+                    own_exported_definitions.extend(
                         concept_utils.find_concept_definitions_in_plain_source(
                             exported_concept, plain_file_parse_result.plain_source, renderer
                         )
                     )
+        module_exports[module_name] = own_exported_definitions
+        exported_definitions.extend(own_exported_definitions)
 
         marshalled_plain_source = validate_and_marshall_module(
             plain_file_parse_result, module_name, ancestor_exported_definitions, code_variables, template_dirs
@@ -889,6 +897,7 @@ def _parse_module(
         all_required_modules=[],
         modules_trace=[],
         chain=chain,
+        module_exports={},
     )
 
     marshalled_plain_source = validate_and_marshall_module(

plain_parser-0.1.3/tests/data/requires/shared_export_above.plain

@@ -0,0 +1,12 @@
+---
+requires:
+  - shared_export_top
+---
+
+***implementation reqs***
+
+- Above implementation requirement.
+
+***functional specs***
+
+- An above functionality.

plain_parser-0.1.3/tests/data/requires/shared_export_base.plain

@@ -0,0 +1,16 @@
+---
+exported_concepts:
+  - :KeyStore:
+---
+
+***definitions***
+
+- :KeyStore: holds encryption keys.
+
+***implementation reqs***
+
+- Base implementation requirement.
+
+***functional specs***
+
+- :KeyStore: stores a key.

plain_parser-0.1.3/tests/data/requires/shared_export_middle.plain

@@ -0,0 +1,12 @@
+---
+requires:
+  - shared_export_base
+---
+
+***implementation reqs***
+
+- The functions of :KeyStore: are used to obtain keys.
+
+***functional specs***
+
+- A middle functionality.

plain_parser-0.1.3/tests/data/requires/shared_export_top.plain

@@ -0,0 +1,13 @@
+---
+requires:
+  - shared_export_base
+  - shared_export_middle
+---
+
+***implementation reqs***
+
+- Keys are read through :KeyStore:.
+
+***functional specs***
+
+- A top functionality.