Skip to content

PNE-9647: state that allowed_names is deprecated - #240

Merged
kroenlein merged 5 commits into
mainfrom
feature/PNE-9647-dynamic-ingredient-names
Nov 2, 2026
Merged

kroenlein merged 5 commits into
mainfrom
feature/PNE-9647-dynamic-ingredient-names

Conversation

@wjohnald

@wjohnald wjohnald commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

GEMD Python PR

Description

Ticket: https://citrine.atlassian.net/browse/PNE-9647

Deprecate ProcessTemplate.allowed_names as part of PNE-9643. Users can choose ingredient names without this field.

GEMD Python keeps the field to give users time to migrate code and JSON away from it. This PR documents how the Citrine Platform treats it:

  • When you save a template, the names you send in this field have no effect.
  • When you fetch a template, the list has the distinct ingredient names from process specs that use it.
  • Names come from datasets you can read.

To satisfy a sphinx build with Python 3.14, sphinx version is bumped as well.

Release notes

ProcessTemplate.allowed_names is deprecated but remains in GEMD Python to give users time to migrate code and JSON away from it.

PR Type

  • Breaking change
  • Bug fix
  • New feature
  • Maintenance

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.
  • I have bumped the version in __version__.py

wjohnald and others added 2 commits October 28, 2026 08:22
The ProcessTemplate docstring states that the Citrine Platform ignores a
supplied allowed_names list and fills the field on read with the
distinct names from the template's ingredient specs.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@wjohnald wjohnald changed the title PNE-9647: Say how the server fills allowed_names PNE-9647: state that allowed_names is deprecated Oct 28, 2026
@wjohnald
wjohnald marked this pull request as ready for review October 29, 2026 15:14
kroenlein and others added 2 commits November 2, 2026 10:49
GitHub's ubuntu-latest image now ships Python 3.14, and the docs job
builds with the runner's default interpreter. Sphinx 5.0.0 imports
imghdr, which Python 3.13 removed, so the docs gate failed.

Sphinx 8.1.3 is the newest release that still supports Python 3.10.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kroenlein
kroenlein self-requested a review November 2, 2026 18:14

@kroenlein kroenlein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good. I bumped the sphinx version as we were shipping w/ a Sphinx version incompatible with Python 3.14.

@kroenlein
kroenlein merged commit babde56 into main Nov 2, 2026
44 checks passed
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.

2 participants