Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upTurn all States into string values instead of ints #624
Conversation
|
Thanks. We should just wait with merging this until we decide when to include it in a release since it's a breaking change if people used integers directly. I'm fine with including it in 0.20.0 (next "major" release), but we also need to update documentation (upgrade notes) to reflect this change. |
| ERROR = 7 | ||
| PAUSED = 8 | ||
| RUNNING = "running" | ||
| REBOOTING = "rebooting" |
Kami
Nov 3, 2015
Member
Minor style thing - for consistency, please use single quotes around simple strings :)
Minor style thing - for consistency, please use single quotes around simple strings :)
| for item_key, item_value in values.items(): | ||
| if value == item_value: | ||
| return item_key | ||
| return value | ||
|
|
||
| @classmethod | ||
| def fromstring(cls, value): |
Kami
Nov 3, 2015
Member
Is this still needed?
Is this still needed?
Kami
Nov 3, 2015
Member
Would also be good to add some small test case for tostring and fromstring.
Would also be good to add some small test case for tostring and fromstring.
jimbobhickville
Dec 2, 2015
Contributor
Yes, please leave this in. We have a lot of code that uses these method to convert to/from the libcloud expected values, and removing this will break us.
Yes, please leave this in. We have a lot of code that uses these method to convert to/from the libcloud expected values, and removing this will break us.
allardhoeve
Dec 10, 2015
Author
Contributor
I will create tests for this
I will create tests for this
allardhoeve
Dec 10, 2015
Author
Contributor
Mmmm, there are no current tests for this 😢
Mmmm, there are no current tests for this
| SUSPENDED = 6 | ||
| ERROR = 7 | ||
| PAUSED = 8 | ||
| RUNNING = "running" |
jimbobhickville
Dec 2, 2015
Contributor
These were ALL_CAPS before, I don't think we should change the case on them.
These were ALL_CAPS before, I don't think we should change the case on them.
allardhoeve
force-pushed the
ByteInternet:all-states-are-string
branch
from
6518c92
to
0428067
|
So I added tests for all the objects that have strings as values now. All tests pass. @Kami: I'd like for this to go into 0.20. Do you think that is still possible? |
|
Also, I think the changes involved are minimal. I cannot imagine a use case where you would actually use the integers in normal code. I think everyone involved either used |
|
|
||
|
|
||
| class StorageVolumeState(object): | ||
| RUNNING = 'running' |
jimbobhickville
Dec 10, 2015
Contributor
Are we ok with this behavior change? The NodeState.tostring(node.state) values previously were all-caps, now they're all lower-case. I know this means my team's codebase will require changes to keep existing behavior. Could we make Type.tostring return value.upper()?
Are we ok with this behavior change? The NodeState.tostring(node.state) values previously were all-caps, now they're all lower-case. I know this means my team's codebase will require changes to keep existing behavior. Could we make Type.tostring return value.upper()?
allardhoeve
Dec 10, 2015
Author
Contributor
Ah! That is true. Let me add that test. We should've had tests for this stuff all along 😢 That would've made this much easier. Ah well, moving forward 😄
Ah! That is true. Let me add that test. We should've had tests for this stuff all along
allardhoeve
Dec 10, 2015
Author
Contributor
Done
Done
|
Thanks @allardhoeve - lgtm |
allardhoeve
force-pushed the
ByteInternet:all-states-are-string
branch
from
734ae6d
to
b2f17f7
|
I added docs for 0.20 |
- Let all types derive from Type - Turn all type attributes into strings - Keep things backwards-compatible by having - tostring - fromstring - Add tests for tostring, fromstring closes #624 Signed-off-by: Allard Hoeve <allardhoeve@gmail.com>
allardhoeve
force-pushed the
ByteInternet:all-states-are-string
branch
from
7c6fce3
to
bef1f94
| * All NodeState, StorageVolumeState, VolumeSnapshotState and Provider attributes | ||
| are now strings instead of integers. | ||
|
|
||
| If you are using the ``tostring`` and ``fromstring`` methods of NodeState, |
Kami
Dec 10, 2015
Member
It would also be good to note that you are affected if you directly store the enum value in the database (integer) - I know some users who do that.
For that scenario this is a backward incompatible change. We don't have any automatic migration path for it - users need to handle that in their code - so for users who do that it's quite an invasive change.
It would also be good to note that you are affected if you directly store the enum value in the database (integer) - I know some users who do that.
For that scenario this is a backward incompatible change. We don't have any automatic migration path for it - users need to handle that in their code - so for users who do that it's quite an invasive change.
| :return: the uppercase string that represents the state object | ||
| :rtype: str | ||
| """ | ||
| return value.upper() |
Kami
Dec 10, 2015
Member
I think I'm fine with this change, but since it's a class method it might also also be a good idea to throw if users passes in an invalid enum value.
In any case, current approach works for now.
I think I'm fine with this change, but since it's a class method it might also also be a good idea to throw if users passes in an invalid enum value.
In any case, current approach works for now.
@Kami
Luckily, most tests already used the constants. I found a couple sloppy drivers, especially the ProfitBricks driver, which uses NodeState for everything, including Volumes and Snapshots. Maybe we fix that, maybe we leave it. It doesn't really matter.