Skip to content

feat: ignition 8.3 #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cesarcoatl merged 2 commits into from
Oct 11, 2025
Merged

feat: ignition 8.3 #283

cesarcoatl merged 2 commits into from
Oct 11, 2025

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Oct 11, 2025 •
edited by sourcery-ai bot
Loading

BREAKING CHANGE: drop support for Ignition 8.1

Summary by Sourcery

Upgrade the project to require Ignition 8.3 by updating dependencies, replacing legacy system.nav API calls with system.vision, adding user.username and locale-setting functionality, simplifying dataset iteration, and adjusting build, CI, and documentation accordingly

New Features:

  • Expose a username property on IncendiumUser
  • Add a set_locale helper to apply a user’s default locale via system.vision

Enhancements:

  • Use getOrDefault for retrieving user first and last names
  • Switch navigation API calls from system.nav to system.vision
  • Iterate datasets directly instead of converting to PyDataSet

Build:

  • Pin ignition-api and ignition-api-stubs to >=8.3.0 across requirements and stubs
  • Add a pip-compile tox environment for generating hashed requirements

CI:

  • Configure pre-commit hooks to use Python 3.12

Documentation:

  • Update README references to document Ignition 8.3 system functions

Chores:

  • Remove the legacy l10n module and stub
  • Drop support for Ignition 8.1

@cesarcoatl
feat: ignition 8.3
30acdc6 
BREAKING CHANGE: drop support for Ignition 8.1
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 11, 2025 •
edited
Loading

Reviewer's Guide

This PR upgrades support to Ignition 8.3 by dropping 8.1 compatibility, bumping API dependencies, migrating system calls to the vision module, enhancing the IncendiumUser wrapper, refactoring dataset iteration, and updating supporting configurations and stubs.

Sequence diagram for user retrieval with Ignition 8.3 vision module

sequenceDiagram
    participant System
    participant Vision
    participant UserModule
    System->>Vision: getUsername()
    UserModule->>System: getUser(user_source, username)
    System-->>UserModule: PyUser instance
Loading

Class diagram for updated IncendiumUser structure

classDiagram
    class IncendiumUser {
        - _contact_info: List[ContactInfo]
        - _email: Optional[AnyStr]
        - _first_name: AnyStr
        - _last_name: AnyStr
        - _locale: AnyStr
        - _roles: List[AnyStr]
        - _username: AnyStr
        + contact_info
        + email
        + first_name
        + last_name
        + locale
        + roles
        + username
    }
Loading

File-Level Changes

Change Details Files
Upgrade and constrain Ignition API dependencies to 8.3
  • Bump ignition-api and ignition-api-stubs versions across requirements, stubs, pyproject, tox and setup
  • Add a new pip-compile testenv in tox.ini
  • Update lockfile hashes for the new API versions
 incendium/tox.ini
incendium-stubs/requirements.txt
incendium/requirements.txt
incendium-stubs/pyproject.toml
incendium/setup.py
Migrate system API calls from nav/security to vision
  • Replace system.security.getUsername with system.vision.getUsername
  • Replace system.nav.swapWindow and getCurrentWindow calls with system.vision equivalents
 incendium/src/incendium/vision/user.py
incendium/src/incendium/vision/nav.py
Enhance IncendiumUser with safer getters and username support
  • Reorder private attributes for clarity
  • Switch user.get() calls to user.getOrDefault() for first and last names
  • Add a _username attribute and public username property
 incendium/src/incendium/vision/user.py
incendium-stubs/stubs/incendium/vision/user.pyi
Add set_locale utility function for vision module
  • Implement set_locale to apply a user's locale or default constant
  • Expose set_locale in type stubs
 incendium/src/incendium/vision/user.py
incendium-stubs/stubs/incendium/vision/user.pyi
Refactor dataset conversion by iterating dataset directly
  • Remove system.dataset.toPyDataSet usage
  • Iterate over the dataset object in place
 incendium/src/incendium/dataset.py
Update development tooling and code style configs for Python 3.12
  • Set language_version to python3.12 for pre-commit hooks
  • Ensure docformatter and pydoclint hooks target the updated config
 .pre-commit-config.yaml
Remove legacy localization modules
  • Delete src/incendium/l10n.py
  • Remove corresponding l10n.pyi stub
 incendium/src/incendium/l10n.py
incendium-stubs/stubs/incendium/l10n.pyi
Update README to reference Ignition 8.3
  • Change guidance links and text from 8.1 to 8.3 system functions
 incendium/README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Oct 11, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@cesarcoatl cesarcoatl merged commit 463b922 into main Oct 11, 2025
9 checks passed
@cesarcoatl cesarcoatl deleted the feat/ignition-8.3 branch October 11, 2025 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cesarcoatl