idfpy 25.1.0__tar.gz

idfpy-25.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to publish (e.g. v25.2.0)"
+        required: true
+        type: string
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: refs/tags/${{ inputs.tag }}
+
+      - uses: astral-sh/setup-uv@v4
+
+      - name: Build
+        run: |
+          VERSION="${{ inputs.tag }}"
+          VERSION="${VERSION#v}"
+          sed -i "s/^version = .*/version = \"${VERSION}\"/" pyproject.toml
+          uv build
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

idfpy-25.1.0/.github/workflows/release-version.yml

@@ -0,0 +1,155 @@
+name: Release EnergyPlus Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      ep_version:
+        description: "EnergyPlus version to target (e.g. 23.2.0)"
+        required: true
+        type: string
+      release_version:
+        description: "idfpy release version (PEP 440, e.g. 23.2.0 or 23.2.0.post1)"
+        required: true
+        type: string
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: master
+          fetch-depth: 0
+
+      - name: Resolve EnergyPlus asset and target refs
+        id: ver
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          EP_VERSION="${{ inputs.ep_version }}"
+          RELEASE_VERSION="${{ inputs.release_version }}"
+          TAG="v${RELEASE_VERSION}"
+          BRANCH="release/ep-${EP_VERSION}"
+
+          RELEASE_JSON=$(gh api "repos/NREL/EnergyPlus/releases/tags/v${EP_VERSION}")
+          ASSET_URL=$(echo "$RELEASE_JSON" | jq -r '
+            .assets[]
+            | select(.name | test("Linux-Ubuntu24\\.04-x86_64\\.tar\\.gz$"))
+            | .browser_download_url
+          ')
+          if [ -z "$ASSET_URL" ]; then
+            ASSET_URL=$(echo "$RELEASE_JSON" | jq -r '
+              .assets[]
+              | select(.name | test("Linux.*x86_64\\.tar\\.gz$"))
+              | .browser_download_url
+            ' | head -1)
+          fi
+          if [ -z "$ASSET_URL" ]; then
+            echo "::error::No Linux x86_64 schema asset found for EnergyPlus ${EP_VERSION}"
+            exit 1
+          fi
+
+          {
+            echo "ep_version=$EP_VERSION"
+            echo "release_version=$RELEASE_VERSION"
+            echo "tag=$TAG"
+            echo "branch=$BRANCH"
+            echo "asset_url=$ASSET_URL"
+          } >> "$GITHUB_OUTPUT"
+          echo "EnergyPlus $EP_VERSION -> idfpy $TAG on $BRANCH"
+
+      - name: Inspect existing tag and PyPI release
+        id: check
+        run: |
+          TAG="${{ steps.ver.outputs.tag }}"
+          VERSION="${{ steps.ver.outputs.release_version }}"
+
+          HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+            "https://pypi.org/pypi/idfpy/${VERSION}/json")
+          if [ "$HTTP_CODE" = "200" ]; then
+            echo "::error::PyPI release idfpy==${VERSION} already exists; bump release_version"
+            exit 1
+          fi
+
+          TAG_EXISTS=false
+          if git ls-remote --exit-code --tags origin "refs/tags/$TAG" > /dev/null 2>&1; then
+            echo "::warning::Remote tag $TAG already exists; skipping git push, only re-publishing to PyPI"
+            TAG_EXISTS=true
+          fi
+          echo "tag_exists=$TAG_EXISTS" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout existing tag for re-publish
+        if: steps.check.outputs.tag_exists == 'true'
+        run: |
+          TAG="${{ steps.ver.outputs.tag }}"
+          git fetch --tags origin "refs/tags/$TAG"
+          git checkout "tags/$TAG"
+
+      - name: Download schema
+        if: steps.check.outputs.tag_exists == 'false'
+        run: |
+          curl -fL -o ep.tar.gz "${{ steps.ver.outputs.asset_url }}"
+          tar -xzf ep.tar.gz --wildcards '*/Energy+.schema.epJSON' --strip-components=1
+          rm ep.tar.gz
+          ls -lh 'Energy+.schema.epJSON'
+
+      - uses: astral-sh/setup-uv@v4
+
+      - name: Generate models
+        if: steps.check.outputs.tag_exists == 'false'
+        run: |
+          uv sync --all-groups
+          uv run idfpy codegen --schema 'Energy+.schema.epJSON' --output idfpy/models
+          uv run ruff check --fix .
+          uv run ruff format .
+          uv run ty check .
+          rm 'Energy+.schema.epJSON'
+
+      - name: Run tests
+        if: steps.check.outputs.tag_exists == 'false'
+        run: uv run pytest tests/ -v
+
+      - name: Set package version
+        if: steps.check.outputs.tag_exists == 'false'
+        run: |
+          VERSION="${{ steps.ver.outputs.release_version }}"
+          sed -i "s/^version = .*/version = \"${VERSION}\"/" pyproject.toml
+
+      - name: Push release branch and tag
+        if: steps.check.outputs.tag_exists == 'false'
+        run: |
+          EP_VERSION="${{ steps.ver.outputs.ep_version }}"
+          TAG="${{ steps.ver.outputs.tag }}"
+          BRANCH="${{ steps.ver.outputs.branch }}"
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Capture codegen + version bump before switching branch
+          git stash push --include-untracked -m "release-${TAG}"
+
+          # Always rebuild the EP support branch on top of current master
+          if git ls-remote --exit-code --heads origin "$BRANCH" > /dev/null; then
+            git fetch origin "$BRANCH"
+          fi
+          git switch -C "$BRANCH" origin/master
+
+          git stash pop
+
+          git add -A
+          git commit -m "feat(models): release ${TAG} for EnergyPlus ${EP_VERSION}"
+          git tag -a "$TAG" -m "idfpy ${TAG} (EnergyPlus ${EP_VERSION})"
+
+          git push origin "$BRANCH" --force-with-lease
+          git push origin "$TAG"
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

idfpy-25.1.0/.github/workflows/sync-energyplus.yml

@@ -0,0 +1,218 @@
+name: Sync EnergyPlus
+
+on:
+  schedule:
+    - cron: "0 6 * * 1"  # Weekly Monday 06:00 UTC
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: master
+          fetch-depth: 0
+
+      - name: Detect latest EnergyPlus release
+        id: ep
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          RELEASE_JSON=$(gh api repos/NREL/EnergyPlus/releases/latest)
+          TAG=$(echo "$RELEASE_JSON" | jq -r '.tag_name')
+          VERSION=${TAG#v}
+          ASSET_URL=$(echo "$RELEASE_JSON" | jq -r '
+            .assets[]
+            | select(.name | test("Linux-Ubuntu24\\.04-x86_64\\.tar\\.gz$"))
+            | .browser_download_url
+          ')
+          if [ -z "$ASSET_URL" ]; then
+            ASSET_URL=$(echo "$RELEASE_JSON" | jq -r '
+              .assets[]
+              | select(.name | test("Linux.*x86_64\\.tar\\.gz$"))
+              | .browser_download_url
+            ' | head -1)
+          fi
+          {
+            echo "version=$VERSION"
+            echo "asset_url=$ASSET_URL"
+          } >> "$GITHUB_OUTPUT"
+          echo "EnergyPlus $VERSION -> $ASSET_URL"
+
+      - name: Skip if version already released
+        id: check
+        run: |
+          VERSION="${{ steps.ep.outputs.version }}"
+          TAG="v${VERSION}"
+
+          TAG_EXISTS=false
+          if git ls-remote --exit-code --tags origin "refs/tags/$TAG" > /dev/null 2>&1; then
+            TAG_EXISTS=true
+          fi
+
+          PYPI_EXISTS=false
+          HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+            "https://pypi.org/pypi/idfpy/${VERSION}/json")
+          if [ "$HTTP_CODE" = "200" ]; then
+            PYPI_EXISTS=true
+          fi
+
+          SKIP=false
+          if [ "$TAG_EXISTS" = "true" ] && [ "$PYPI_EXISTS" = "true" ]; then
+            echo "Tag $TAG and PyPI ${VERSION} both already exist; skipping"
+            SKIP=true
+          elif [ "$TAG_EXISTS" = "true" ]; then
+            echo "::error::Tag $TAG already exists but PyPI ${VERSION} is missing; refusing to proceed"
+            exit 1
+          elif [ "$PYPI_EXISTS" = "true" ]; then
+            echo "::error::PyPI ${VERSION} already exists but tag $TAG is missing; refusing to proceed"
+            exit 1
+          fi
+
+          echo "skip=$SKIP" >> "$GITHUB_OUTPUT"
+
+      - name: Download schema
+        if: steps.check.outputs.skip == 'false'
+        run: |
+          curl -fL -o ep.tar.gz "${{ steps.ep.outputs.asset_url }}"
+          tar -xzf ep.tar.gz --wildcards '*/Energy+.schema.epJSON' --strip-components=1
+          rm ep.tar.gz
+          ls -lh 'Energy+.schema.epJSON'
+
+      - uses: astral-sh/setup-uv@v4
+        if: steps.check.outputs.skip == 'false'
+
+      - name: Generate models
+        if: steps.check.outputs.skip == 'false'
+        run: |
+          uv sync --all-groups
+          uv run idfpy codegen --schema 'Energy+.schema.epJSON' --output idfpy/models
+          uv run ruff check --fix .
+          uv run ruff format .
+          uv run ty check .
+          rm 'Energy+.schema.epJSON'
+
+      - name: Run tests
+        if: steps.check.outputs.skip == 'false'
+        run: uv run pytest tests/ -v
+
+      - name: Update version metadata
+        if: steps.check.outputs.skip == 'false'
+        run: |
+          EP_VERSION="${{ steps.ep.outputs.version }}"
+          MAJOR_MINOR="${EP_VERSION%.*}"
+
+          OBJ_COUNT=$(grep -rh '_idf_object_type: ClassVar' idfpy/models/*.py \
+            | grep -cv '_base.py')
+          REF_COUNT=$(grep -c 'Ref = Annotated' idfpy/models/_refs.py)
+          PROP_COUNT=$(grep -rh '^    @property$' idfpy/models/*.py \
+            | grep -cv '_base.py')
+
+          sed -i "s/^version = .*/version = \"${EP_VERSION}\"/" pyproject.toml
+
+          # README badge: URL slug + alt text
+          sed -Ei "s|EnergyPlus-[0-9.]+-orange|EnergyPlus-${MAJOR_MINOR}-orange|" README.md
+          sed -Ei "s|\[!\[EnergyPlus [0-9.]+\]|[![EnergyPlus ${MAJOR_MINOR}]|" README.md
+
+          # Autoupdate badge: workflow filename (belt-and-braces; primary update is manual)
+          sed -Ei "s|update-models\.yml|sync-energyplus.yml|g" README.md
+
+          # Auto-generated schema version line
+          sed -Ei "s|version \*\*[0-9.]+\*\*|version **${EP_VERSION}**|" README.md
+
+          # Feature list counts + comparison table
+          sed -Ei "s|\*\*[0-9]+\+? object types\*\*|**${OBJ_COUNT} object types**|" README.md
+          sed -Ei "s|\*\*[0-9]+ reference types\*\*|**${REF_COUNT} reference types**|" README.md
+          sed -Ei "s|✅ [0-9]+ ref groups|✅ ${REF_COUNT} ref groups|" README.md
+          sed -Ei "s|✅ [0-9]+ properties|✅ ${PROP_COUNT} properties|" README.md
+
+      - name: Publish to latest branch and tag
+        id: push
+        if: steps.check.outputs.skip == 'false'
+        run: |
+          EP_VERSION="${{ steps.ep.outputs.version }}"
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Capture codegen + metadata changes before switching branch
+          git stash push --include-untracked -m "sync-${EP_VERSION}"
+
+          # Rebase latest on top of current master, then re-apply the stash
+          if git ls-remote --exit-code --heads origin latest > /dev/null; then
+            git fetch origin latest
+            git switch -C latest origin/master
+          else
+            git switch -C latest
+          fi
+
+          git stash pop
+
+          git add -A
+          if git diff --cached --quiet; then
+            echo "No changes to publish"
+            echo "updated=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          git commit -m "feat(models): sync to EnergyPlus ${EP_VERSION}"
+          git tag -a "v${EP_VERSION}" -m "EnergyPlus ${EP_VERSION} models"
+
+          git push origin latest --force-with-lease
+          git push origin "v${EP_VERSION}"
+
+          echo "updated=true" >> "$GITHUB_OUTPUT"
+
+      - name: Build distribution
+        if: steps.push.outputs.updated == 'true'
+        run: uv build
+
+      - name: Publish to PyPI
+        if: steps.push.outputs.updated == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Open PR to sync README to master
+        if: steps.push.outputs.updated == 'true'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          EP_VERSION="${{ steps.ep.outputs.version }}"
+          BRANCH="chore/sync-readme"
+          TITLE="docs: sync README for EnergyPlus ${EP_VERSION}"
+
+          # README on latest (HEAD) already has the sed-updated content
+          cp README.md /tmp/README.new
+
+          git fetch origin master
+          git switch -C "$BRANCH" origin/master
+          cp /tmp/README.new README.md
+
+          if git diff --quiet; then
+            echo "README already in sync with master, nothing to PR"
+            exit 0
+          fi
+
+          git add README.md
+          git commit -m "$TITLE"
+          git push -f origin "$BRANCH"
+
+          BODY=$(cat <<EOF
+          Auto-generated by the \`Sync EnergyPlus\` workflow.
+
+          Updates README badges, version line, and counts to match EnergyPlus ${EP_VERSION}.
+          Only \`README.md\` is touched — models and codegen products stay on the \`latest\` branch.
+          EOF
+          )
+
+          if PR_NUM=$(gh pr view "$BRANCH" --json number -q .number 2>/dev/null); then
+            gh pr edit "$PR_NUM" --title "$TITLE" --body "$BODY"
+          else
+            gh pr create --base master --head "$BRANCH" --title "$TITLE" --body "$BODY"
+          fi

idfpy-25.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+*.lock
+
+.claude/
+
+_dev/

idfpy-25.1.0/.vscode/launch.json

@@ -0,0 +1,58 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "save and load idf",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "console": "integratedTerminal",
+            "args": [
+                "tests/test_models.py::test_actual_idf_file",
+                "-s",
+                "--no-header"
+            ],
+        },
+        {
+            "name": "codegen",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "idfpy",
+            "console": "integratedTerminal",
+            "args": [
+                "codegen",
+                "--schema",
+                "Energy+.schema.epJSON",
+                "--output",
+                "${workspaceFolder}/idfpy/models"
+            ],
+        },
+        {
+            "name": "temp test",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "console": "integratedTerminal",
+            "args": [
+                "tests/test_models.py::test_to_dict_preserves_empty_string_name",
+                "-s",
+                "--no-header"
+            ],
+        },
+        {
+            "name": "All test",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "console": "integratedTerminal",
+            "args": [
+                "tests",
+                "-s",
+                "--no-header"
+            ],
+        },
+    ]
+}

idfpy-25.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ITOTI-Y
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.