refactor: change services/default from string to list format #155
Conversation
There was a problem hiding this comment.
Thanks, @iprasannamb! This PR contains changes from #154 too. Could you make this branch from main and not from your index branch? Rebasing on top of main would help!
| @@ -123,8 +125,8 @@ Some examples of how to use it: | |||
| `sugar ext restart --profile profile1 --all` | |||
|
|
|||
| - restart service1 and service2 for profile1: | |||
| `sugar ext restart --profile profile1 --services service1,service2` | |||
| `sugar ext restart --profile profile1 --services service1 service2` | |||
There was a problem hiding this comment.
I guess that the cli will not change
| @@ -1,127 +0,0 @@ | |||
| # Get Started | |||
There was a problem hiding this comment.
it seems that this change is the same as your previous PR
please ensure every time you start a new branch from upstream/main
take a look into this blog post for more information about our workflow with github https://opensciencelabs.org/blog/first-time-contributors/
| @@ -216,13 +216,18 @@ def _load_root_services(self) -> None: | |||
| if not services: | |||
| return | |||
|
|
|||
| # Handle the case where 'default' comes as a string (for backward compatibility) | |||
| default_services = services.get('default', []) | |||
| if isinstance(default_services, str) and default_services: | |||
There was a problem hiding this comment.
although the backward compatibility is a nice thing, but in the schema.json you changed from string to array ... so this value will never be a string, so this code will not be necessary
| else: | ||
| # Handle the case where 'default' comes as a string (for backward compatibility) | ||
| default_services = profile_data.get('services', {}).get('default', []) | ||
| if isinstance(default_services, str) and default_services: |
There was a problem hiding this comment.
same here, the default_services will be always a list
| services_default = services_config.get('default', []) | ||
|
|
||
| # Handle the case where 'default' comes as a string (for backward compatibility) | ||
| if isinstance(services_default, str) and services_default: |
|
@iprasannamb , are you still working on that? |
Change services/default from string to list format
This pull request changes the
services/defaultconfiguration from a comma-separated string format to a list of strings format, making the code more robust and easier to use.Resolves: #153
Changes
schema.jsonto define 'default' as an array of strings instead of a stringSugarBasemethods inbase.pyto work with lists instead of comma-separated strings:_load_root_services()_filter_service_profile()_get_services_names()README.md) to reflect the new list format in examplesBefore
After
Backward Compatibility
Backward compatibility has been maintained by automatically detecting and converting string formats to lists when encountered in existing configurations. This ensures that existing configurations with comma-separated strings will continue to work during the transition period.
Testing
The implementation has been tested with both the new list format and the legacy string format to ensure backward compatibility.