Skip to content

feat: check workspace version on import - #1241

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/workspace-version-config-check
Apr 30, 2026
Merged

Jammy2211 merged 1 commit into
mainfrom
feature/workspace-version-config-check

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Add a check_version(__version__) call to autofit/__init__.py so workspace/library version mismatches surface on every script run, not just welcome.py. Pairs with the upstream PyAutoConf change (PyAutoLabs/PyAutoNerves#100) which extends check_version to read from config/general.yaml and adds a YAML-driven bypass for main-branch users.

API Changes

None to autofit's public API. Importing autofit now triggers a workspace-version check via autoconf.workspace.check_version, which may emit a warning (no version source found) or raise autoconf.workspace.WorkspaceVersionMismatchError (workspace and library versions disagree). Users on main-branch clones who hit this should disable via version.workspace_version_check: False in config/general.yaml — see PyAutoLabs/PyAutoNerves#100 for the full rationale.

See full details below.

Test Plan

  • pytest test_autofit/ stays green (collection imports autofit; no version.txt or general.yaml at the repo root, so the check warns and continues)
  • python -c "import autofit" from autofit_workspace/ succeeds silently
  • python -c "import autofit" from /tmp warns with the new message text
Full API Changes (for automation & release notes)

Changed Behaviour

  • import autofit now calls autoconf.workspace.check_version(autofit.__version__) at the end of autofit/__init__.py. May warn (no version.workspace_version in config and no version.txt) or raise autoconf.workspace.WorkspaceVersionMismatchError (versions disagree).

Migration

  • Users on main-branch workspace clones should add to config/general.yaml:
    version:
      workspace_version_check: False

🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant