Skip to content
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.

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

[Breaking change]: Python hosting integration preview parameter name changes in Aspire 9.1 #2559

Open
1 of 3 tasks
DamianEdwards opened this issue Feb 8, 2025 · 0 comments · May be fixed by #2566
Open
1 of 3 tasks
Assignees
Labels
⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 🗺️ reQUEST Triggers an issue to be imported into Quest.

Comments

@DamianEdwards
Copy link
Member

Description

The Python hosting integration preview for Aspire previously had methods that referred to the Python app as "projects" renamed to refer to them as "apps". That change missed some parameters on some methods which this change rectifies.

Version

Other (please put exact version in description textbox)

Previous behavior

Some parameter names on methods and constructors in the Python hosting integration preview for Aspire were named such that they referred to the Python app as a "project" rather than an "app".

New behavior

Parameter names on methods and constructors in the Python hosting integration preview for Aspire have changed to refer to the Python app as an "app" instead of "project" where applicable.

Type of breaking change

  • Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
  • Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
  • Behavioral change: Existing binaries might behave differently at run time.

Reason for change

Consistent naming.

Recommended action

Update application source as appropriate to use the new parameter names.

Affected APIs

  • Aspire.Hosting
    • PythonAppResourceBuilderExtensions
      • public static ApplicationModel.IResourceBuilder<Python.PythonAppResource> AddPythonApp(this IDistributedApplicationBuilder builder, ...) all overloads
  • Aspire.Hosting.Python
    • PythonAppResource
      • ctor
@DamianEdwards DamianEdwards added doc-idea Indicates issues that are suggestions for new topics [org][type][category] Pri1 High priority, do before Pri2 and Pri3 ⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. labels Feb 8, 2025
@dotnetrepoman dotnetrepoman bot added the ⌚ Not Triaged Not triaged label Feb 8, 2025
@IEvangelist IEvangelist added 🗺️ reQUEST Triggers an issue to be imported into Quest. okr-freshness OKR: Freshness of content and removed ⌚ Not Triaged Not triaged labels Feb 13, 2025
@dotnetrepoman dotnetrepoman bot added 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. and removed 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. labels Feb 13, 2025
@IEvangelist IEvangelist moved this from 🔖 Ready to 👀 In review in dotnet/docs February 2025 sprint project Feb 13, 2025
@dotnetrepoman dotnetrepoman bot added 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. and removed 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. labels Feb 13, 2025
@IEvangelist IEvangelist linked a pull request Feb 13, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 🗺️ reQUEST Triggers an issue to be imported into Quest.
Projects
Status: 👀 In review
Development

Successfully merging a pull request may close this issue.

2 participants