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.

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

Attribute strings for various Element classes missing from Python API #1545

Open
kwokcb opened this issue Sep 29, 2023 · 2 comments · May be fixed by #2034
Open

Attribute strings for various Element classes missing from Python API #1545

kwokcb opened this issue Sep 29, 2023 · 2 comments · May be fixed by #2034
Assignees
@rherrera-ilm
Labels
good first issue help wanted

Comments

@kwokcb
Copy link
Contributor

kwokcb commented Sep 29, 2023

Issue

  • There are a number of classes which do not expose the static attribute enumeration strings.
  • This includes the Element class and various derived classes.

Effect

  • Without these exposed, users need to find out what these are called and hard-code them.
  • If the attribute names change in the future then their code may break due to hard-coded string usage.
  • This could help with performance as well by encouraging string reuse.

Proposal

  • Scan through and add these to the Python API.
@rherrera-ilm
Copy link

Hello, I would like to take this issue for Dev Days.

@jstone-lucasfilm
Copy link
Member

Sounds good, @rherrera-ilm, and welcome!

@rherrera-ilm rherrera-ilm linked a pull request Sep 27, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rherrera-ilm rherrera-ilm

Labels
good first issue help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added attribute strings to the Element class in the Python API rherrera-ilm/MaterialX
3 participants
@jstone-lucasfilm @kwokcb @rherrera-ilm