mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-11 18:01:04 +00:00
More correct names for writing styles in HelperMode
This commit is contained in:
parent
2346ade309
commit
b65f181402
7 changed files with 31 additions and 21 deletions
|
|
@ -157,7 +157,7 @@ class Methods(Helper):
|
||||||
|
|
||||||
List is updated to Bot API 3.2
|
List is updated to Bot API 3.2
|
||||||
"""
|
"""
|
||||||
mode = HelperMode.camelCase
|
mode = HelperMode.lowerCamelCase
|
||||||
|
|
||||||
# Getting Updates
|
# Getting Updates
|
||||||
GET_UPDATES = Item() # getUpdates
|
GET_UPDATES = Item() # getUpdates
|
||||||
|
|
|
||||||
|
|
@ -154,7 +154,7 @@ def generate_default_filters(dispatcher, *args, **kwargs):
|
||||||
|
|
||||||
|
|
||||||
class DefaultFilters(Helper):
|
class DefaultFilters(Helper):
|
||||||
mode = HelperMode.lower_case
|
mode = HelperMode.snake_case
|
||||||
|
|
||||||
COMMANDS = Item() # commands
|
COMMANDS = Item() # commands
|
||||||
REGEXP = Item() # regexp
|
REGEXP = Item() # regexp
|
||||||
|
|
|
||||||
|
|
@ -127,7 +127,7 @@ class ChatActions(Helper):
|
||||||
:key: UPLOAD_VIDEO_NOTE
|
:key: UPLOAD_VIDEO_NOTE
|
||||||
"""
|
"""
|
||||||
|
|
||||||
mode = HelperMode.lower_case
|
mode = HelperMode.snake_case
|
||||||
|
|
||||||
TYPING = Item() # typing
|
TYPING = Item() # typing
|
||||||
UPLOAD_PHOTO = Item() # upload_photo
|
UPLOAD_PHOTO = Item() # upload_photo
|
||||||
|
|
|
||||||
|
|
@ -253,7 +253,7 @@ class ContentType(Helper):
|
||||||
:key: SUCCESSFUL_PAYMENT
|
:key: SUCCESSFUL_PAYMENT
|
||||||
:key: UNKNOWN
|
:key: UNKNOWN
|
||||||
"""
|
"""
|
||||||
mode = HelperMode.lower_case
|
mode = HelperMode.snake_case
|
||||||
|
|
||||||
TEXT = ListItem() # text
|
TEXT = ListItem() # text
|
||||||
AUDIO = ListItem() # audio
|
AUDIO = ListItem() # audio
|
||||||
|
|
|
||||||
|
|
@ -80,7 +80,7 @@ class MessageEntityType(Helper):
|
||||||
:key: TEXT_LINK
|
:key: TEXT_LINK
|
||||||
:key: TEXT_MENTION
|
:key: TEXT_MENTION
|
||||||
"""
|
"""
|
||||||
mode = HelperMode.lower_case
|
mode = HelperMode.snake_case
|
||||||
|
|
||||||
MENTION = Item() # mention - @username
|
MENTION = Item() # mention - @username
|
||||||
HASHTAG = Item() # hashtag
|
HASHTAG = Item() # hashtag
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,7 @@ class AllowedUpdates(Helper):
|
||||||
Example:
|
Example:
|
||||||
>>> bot.get_updates(allowed_updates=AllowedUpdates.MESSAGE + AllowedUpdates.EDITED_MESSAGE)
|
>>> bot.get_updates(allowed_updates=AllowedUpdates.MESSAGE + AllowedUpdates.EDITED_MESSAGE)
|
||||||
"""
|
"""
|
||||||
mode = HelperMode.lower_case
|
mode = HelperMode.snake_case
|
||||||
|
|
||||||
MESSAGE = ListItem() # message
|
MESSAGE = ListItem() # message
|
||||||
EDITED_MESSAGE = ListItem() # edited_message
|
EDITED_MESSAGE = ListItem() # edited_message
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
Example:
|
Example:
|
||||||
>>> from aiogram.utils.helper import Helper, ListItem, HelperMode, Item
|
>>> from aiogram.utils.helper import Helper, ListItem, HelperMode, Item
|
||||||
>>> class MyHelper(Helper):
|
>>> class MyHelper(Helper):
|
||||||
... mode = HelperMode.camelCase
|
... mode = HelperMode.lowerCamelCase
|
||||||
... FOO_ITEM = ListItem()
|
... FOO_ITEM = ListItem()
|
||||||
... BAR_ITEM = ListItem()
|
... BAR_ITEM = ListItem()
|
||||||
... BAZ_ITEM = ListItem()
|
... BAZ_ITEM = ListItem()
|
||||||
|
|
@ -39,16 +39,26 @@ class Helper:
|
||||||
class HelperMode(Helper):
|
class HelperMode(Helper):
|
||||||
mode = 'original'
|
mode = 'original'
|
||||||
|
|
||||||
UPPER_CASE = 'upperCase'
|
SCREAMING_SNAKE_CASE = 'SCREAMING_SNAKE_CASE'
|
||||||
camelCase = 'camelCase'
|
lowerCamelCase = 'lowerCamelCase'
|
||||||
CamelCase = 'CamelCase'
|
CamelCase = 'CamelCase'
|
||||||
lower_case = 'lower_case'
|
snake_case = 'snake_case'
|
||||||
lowercase = 'lowercase'
|
lowercase = 'lowercase'
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _upper_case(cls, text):
|
def all(cls):
|
||||||
|
return [
|
||||||
|
cls.SCREAMING_SNAKE_CASE,
|
||||||
|
cls.lowerCamelCase,
|
||||||
|
cls.CamelCase,
|
||||||
|
cls.snake_case,
|
||||||
|
cls.lowercase,
|
||||||
|
]
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _screaming_snake_case(cls, text):
|
||||||
"""
|
"""
|
||||||
Transform text to UPPER_CASE
|
Transform text to SCREAMING_SNAKE_CASE
|
||||||
|
|
||||||
:param text:
|
:param text:
|
||||||
:return:
|
:return:
|
||||||
|
|
@ -64,16 +74,16 @@ class HelperMode(Helper):
|
||||||
return result
|
return result
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _lower_case(cls, text):
|
def _snake_case(cls, text):
|
||||||
"""
|
"""
|
||||||
Transform text to lower_case (Based on UPPER_CASE)
|
Transform text to snake cale (Based on SCREAMING_SNAKE_CASE)
|
||||||
|
|
||||||
:param text:
|
:param text:
|
||||||
:return:
|
:return:
|
||||||
"""
|
"""
|
||||||
if text.islower():
|
if text.islower():
|
||||||
return text
|
return text
|
||||||
return cls._upper_case(text).lower()
|
return cls._screaming_snake_case(text).lower()
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _camel_case(cls, text, first_upper=False):
|
def _camel_case(cls, text, first_upper=False):
|
||||||
|
|
@ -108,13 +118,13 @@ class HelperMode(Helper):
|
||||||
:param mode:
|
:param mode:
|
||||||
:return:
|
:return:
|
||||||
"""
|
"""
|
||||||
if mode == cls.UPPER_CASE:
|
if mode == cls.SCREAMING_SNAKE_CASE:
|
||||||
return cls._upper_case(text)
|
return cls._screaming_snake_case(text)
|
||||||
elif mode == cls.lower_case:
|
elif mode == cls.snake_case:
|
||||||
return cls._lower_case(text)
|
return cls._snake_case(text)
|
||||||
elif mode == cls.lowercase:
|
elif mode == cls.lowercase:
|
||||||
return cls._lower_case(text).replace('_', '')
|
return cls._snake_case(text).replace('_', '')
|
||||||
elif mode == cls.camelCase:
|
elif mode == cls.lowerCamelCase:
|
||||||
return cls._camel_case(text)
|
return cls._camel_case(text)
|
||||||
elif mode == cls.CamelCase:
|
elif mode == cls.CamelCase:
|
||||||
return cls._camel_case(text, True)
|
return cls._camel_case(text, True)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue