This is an attempt to make Configuration behave in some ways like a read-only dictionary, returning a joint value for a joint name key. It is also an attempt to make the attributes like joint_names and joint_values semi-immutable in the sense that their lengths cannot change but their values can. FixedLengthList subclasses list and overwrites many methods. Please look over that carefully, and suggest meaningful tests. That class is defined in configuration.py because it will only be there for a hot minute. It too will migrate to compas core. I haven't added an entry to the changelog for the same reason. But at the same time, I wonder where best to announce the breaking change of values to joint_values, and the removal of merge.
PS. I just noticed that as part of the move I should probably update the PR template.
What type of change is this?
[ ] Bug fix in a backwards-compatible manner.
[ ] New feature in a backwards-compatible manner.
[x] Breaking change: bug fix or new feature that involve incompatible API changes.
[ ] Other (e.g. doc update, configuration, etc)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
[x] I added a line to the CHANGELOG.rst file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
[x] I ran all tests on my computer and it's all green (i.e. invoke test).
[x] I ran lint on my computer and there are no errors (i.e. invoke lint).
[x] I added new functions/classes and made them available on a second-level import, e.g. compas_fab.robots.Configuration.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] I have added necessary documentation (if appropriate)
This is an attempt to make
Configuration
behave in some ways like a read-only dictionary, returning a joint value for a joint name key. It is also an attempt to make the attributes likejoint_names
andjoint_values
semi-immutable in the sense that their lengths cannot change but their values can.FixedLengthList
subclasseslist
and overwrites many methods. Please look over that carefully, and suggest meaningful tests. That class is defined inconfiguration.py
because it will only be there for a hot minute. It too will migrate to compas core. I haven't added an entry to the changelog for the same reason. But at the same time, I wonder where best to announce the breaking change ofvalues
tojoint_values
, and the removal ofmerge
.PS. I just noticed that as part of the move I should probably update the PR template.
What type of change is this?
Checklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.CHANGELOG.rst
file in theUnreleased
section under the most fitting heading (e.g.Added
,Changed
,Removed
).invoke test
).invoke lint
).compas_fab.robots.Configuration
.