Enum Generator: allow passing strings for parameters which are enums to make calling more pythonic #21

Activity

1. grusin-db commented on Mar 1, 2023

   

   grusin-db

   on Mar 1, 2023

   ContributorAuthor

   More actions

   I am not sure what is the neat/correct way of solving it, SO has all sort of answers (https://stackoverflow.com/questions/41407414/convert-string-to-enum-in-python)

   this stands out as a neat one: https://stackoverflow.com/a/56567247
2. grusin-db

   changed the title [-]allow passing strings for parameters which are enums to make calling more pythonic[/-] [+]Enum Generator: allow passing strings for parameters which are enums to make calling more pythonic[/+] on Mar 1, 2023
3. grusin-db commented on Mar 1, 2023

   

   grusin-db

   on Mar 1, 2023

   Last edited by grusin-db

   ContributorAuthor

   More actions

   from enum import Enum
   
   class YetAnotherStrEnum(Enum):
     @classmethod
     def from_str(cls, s: str):
       return cls.__members__.get(s)
   
     @classmethod
     def from_enum_or_str(cls, s_or_e):
       if isinstance(s_or_e, str):
         return cls.from_str(s_or_e)
       else:
         return s_or_e
   
   class ExportFormat(YetAnotherStrEnum):
       """This specifies the format of the file to be imported. By default, this is `SOURCE`. However it
       may be one of: `SOURCE`, `HTML`, `JUPYTER`, `DBC`. The value is case sensitive."""
   
       DBC = 'DBC'
       HTML = 'HTML'
       JUPYTER = 'JUPYTER'
       R_MARKDOWN = 'R_MARKDOWN'
       SOURCE = 'SOURCE'
       aaa = 'bbb'
   
   assert ExportFormat.from_str('SOURCE') == ExportFormat.SOURCE
   assert ExportFormat.from_enum_or_str('SOURCE') == ExportFormat.SOURCE
   assert ExportFormat.from_enum_or_str(ExportFormat.SOURCE) == ExportFormat.SOURCE

   hence calling code can be change from:

   if format: query['format'] = request.format.value

   to:

   if format: query['format'] = ExportFormat.from_enum_or_str(request.format).value

   this way both ExportFormat Enum and str would be handled.
4. grusin-db commented on Mar 1, 2023

   

   grusin-db

   on Mar 1, 2023

   Last edited by grusin-db

   ContributorAuthor

   More actions

   Another issue

   ...with displaying/repr for classes having enums, displayed text has nasty looking object_type and language, making copy & paste unfriendly

   ObjectInfo(created_at=1677658169185, language=<Language.SQL: 'SQL'>, modified_at=1677658409090, object_id=3538949529947478, object_type=<ObjectType.NOTEBOOK: 'NOTEBOOK'>, path='/Users/grzegorz.rusin@databricks.com/auto-dlt/generated/gr_products/gr_silver-incremental', size=None)]

   displayed text should look like this, so it can be copied and run to created object back:

   from databricks.sdk.service.workspace import ObjectType, Language, ObjectInfo
   
   ObjectInfo(created_at=1677658169185, language=Language.SQL, modified_at=1677658409090, object_id=3538949529947478, object_type=ObjectType.NOTEBOOK, path='/Users/grzegorz.rusin@databricks.com/auto-dlt/generated/gr_products/gr_silver-incremental', size=None)

   Solution:

   adding custom string formatter:

   class YetAnotherStrEnum(Enum):
     ...
   
     def __repr__(self):
       return str(self)

   gets rid of nasty EnumType.FieldName: FieldValue formatting, in favour of just EnumType.FieldName
5. nfx

   added

   discussion

   on Apr 19, 2023
6. databricks

   locked and limited conversation to collaborators on Apr 19, 2023
7. nfx

   converted this issue into a discussion #76 on Apr 19, 2023