GPencil: Rename intermal layer info variable/prop to name #96341

New Issue

Antonio Vazquez · 2022-03-11T17:14:52+01:00

Antonio Vazquez commented

2022-03-11 17:14:52 +01:00

Actually, the layer name is defined as info at C code level, but also as python api level and this breaks all naming conventions.

The objective of this task is to do a full rename of this variable and discuss what is the best approach for python API because if we rename this prop, we are going to break a lot of add-ons.

My initial idea for the python API was to create a duplicated name prop and use this new prop in all Blender python code. For the old infoprop, the ideal would be marked as deprecated and allow the users to run add-ons with old prop, but with a warning. In future versions we could remove this deprecated option.

As an alternative plan, we could wait for a planned release number and break the API, but IMHO this would be the last option.

Actually, the layer name is defined as `info` at C code level, but also as python api level and this breaks all naming conventions. The objective of this task is to do a full rename of this variable and discuss what is the best approach for python API because if we rename this prop, we are going to break a lot of add-ons. My initial idea for the python API was to create a duplicated `name` prop and use this new prop in all Blender python code. For the old `info`prop, the ideal would be marked as deprecated and allow the users to run add-ons with old prop, but with a warning. In future versions we could remove this deprecated option. As an alternative plan, we could wait for a planned release number and break the API, but IMHO this would be the last option.

Antonio Vazquez self-assigned this 2022-03-11 17:14:52 +01:00

Antonio Vazquez commented

2022-03-11 17:14:52 +01:00

Changed status from 'Needs Triage' to: 'Confirmed'

Antonio Vazquez commented

2022-03-11 17:14:52 +01:00

Added subscriber: @antoniov

Antonio Vazquez changed title from ~~GPencil: Rename intermal layer `info`variable to `name`~~ to GPencil: Rename intermal layer `info` variable/prop to `name`

2022-03-11 17:15:59 +01:00

Antonio Vazquez commented

2022-03-11 17:16:11 +01:00

Added subscribers: @mont29, @ideasman42

Antonio Vazquez commented

2022-03-11 17:16:11 +01:00

@ideasman42 @mont29 What is your advice here?

Jason van Gumster commented

2022-03-11 17:21:12 +01:00

Added subscriber: @JasonvanGumster

Bastien Montagne commented

2022-03-15 09:39:31 +01:00

Am not sure how critical this renaming is... In general we try to avoid those as much as possible...

But if this absolutely has to be done, then think the proper process is:

For next release (3.2):
Add new RNA prop Keep existing old one, add deprecation warning.
** Keep name in the DNA struct as it is, with clear comment it will be changed.
For next compatibility-breaking release (which would be 4.0 if I am correct):
Remove the old RNA property Do rename in DNA struct (since afaik DNA rename ensures backward compatibility, but not forward one).

Am not sure how critical this renaming is... In general we try to avoid those as much as possible... But if this absolutely has to be done, then think the proper process is: * For next release (3.2): **Add new RNA prop** Keep existing old one, add deprecation warning. ** Keep name in the DNA struct as it is, with clear comment it will be changed. * For next compatibility-breaking release (which would be 4.0 if I am correct): **Remove the old RNA property** Do rename in DNA struct (since afaik DNA rename ensures backward compatibility, but not forward one).

Antonio Vazquez commented

2022-03-15 11:18:54 +01:00

Added subscriber: @dfelinto

Antonio Vazquez commented

2022-03-15 11:18:54 +01:00

@mont29 Thanks for the detailed steps for doing the rename. Really, this is something that is not critical, but IMHO it would be better to harmonize this prop name asap. Maybe we would need the opinion about this by @dfelinto before doing it.

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

GPencil: Rename intermal layer info variable/prop to name #96341

GPencil: Rename intermal layer `info` variable/prop to `name` #96341