API Index

Subpackages

• tgram_dnd.actions package
  • Subpackages
    • tgram_dnd.actions.api package
      • Subpackages
      • Submodules
      • tgram_dnd.actions.api.raw module
      • tgram_dnd.actions.api.raw_call module
      • Module contents
  • Submodules
  • tgram_dnd.actions.action module
    • Action
      • Action.inject()
  • Module contents
• tgram_dnd.blocks package
  • Submodules
  • tgram_dnd.blocks.callback_block module
    • CallbackBlock
      • CallbackBlock.exec()
      • CallbackBlock.inject()
  • tgram_dnd.blocks.message_block module
    • MessageBlock
      • MessageBlock.exec()
      • MessageBlock.inject()
  • Module contents
• tgram_dnd.caching package
  • Submodules
  • tgram_dnd.caching.base module
    • BaseCache
      • BaseCache.get()
      • BaseCache.get_or_create()
      • BaseCache.set()
  • tgram_dnd.caching.cached_item module
    • CachedItem
      • CachedItem.get()
      • CachedItem.has_expired
  • tgram_dnd.caching.memory module
    • MemoryCache
      • MemoryCache.get()
      • MemoryCache.get_or_create()
      • MemoryCache.set()
  • Module contents
• tgram_dnd.enums package
  • Submodules
  • tgram_dnd.enums.bot_command_input module
    • BotCommandInput
      • BotCommandInput.command
      • BotCommandInput.description
      • BotCommandInput.language_code
  • tgram_dnd.enums.language_codes module
    • LANGUAGE_CODES
  • tgram_dnd.enums.reply_input module
    • ReplyInput
      • ReplyInput.audio
      • ReplyInput.caption
      • ReplyInput.document
      • ReplyInput.emoji
      • ReplyInput.photo
      • ReplyInput.reply_markup
      • ReplyInput.sticker
      • ReplyInput.text
      • ReplyInput.video
  • tgram_dnd.enums.reply_methods module
    • REPLY_METHODS
  • Module contents
• tgram_dnd.flows package
  • Submodules
  • tgram_dnd.flows.callback_flow module
    • CallbackFlow
      • CallbackFlow.inject()
      • CallbackFlow.load_plugin()
  • tgram_dnd.flows.message_flow module
    • MessageFlow
      • MessageFlow.inject()
      • MessageFlow.load_plugin()
  • Module contents
• tgram_dnd.conditions package
  • Submodules
  • tgram_dnd.conditions.base module
    • BaseCondition
      • BaseCondition.inject()
  • tgram_dnd.conditions.condition module
    • Condition
  • Module contents

Submodules

tgram_dnd.app module

class tgram_dnd.app.App(bot: TgBot, flows: List[MessageFlow | CallbackFlow] = [], config: BotConfig = None, cache: BaseCache = None)

Bases: object

The main class used to run your Flows

add_flows(flows: List[MessageFlow | CallbackFlow] | MessageFlow | CallbackFlow)

add flows to current app

run() → None

run the bot

tgram_dnd.config module

class tgram_dnd.config.BotConfig(strings: Dict[str, Dict[TypeAliasForwardRef('tgram_dnd.enums.language_codes.LANGUAGE_CODES'), str]] = None, keyboards: Dict[str, Dict[TypeAliasForwardRef('tgram_dnd.enums.language_codes.LANGUAGE_CODES'), InlineKeyboardMarkup]] = None, default_lang: tgram_dnd.enums.language_codes.LANGUAGE_CODES = 'en', bot_commands: List[BotCommandInput] = None, config_file: str = None)

Bases: object

Init BotConfig

# Importing data manually
config = BotConfig(
    strings={
        "start": ...
    },
    keyboards=...,
    commands=...
)

# importing from a file
config = BotConfig(config_file="data.json")

Parameters:

• strings (dict[str, dict[tgram_dnd.enums.language_codes.LANGUAGE_CODES, str]], optinal) – the pre-made text

• keyboards (dict[str, dict[tgram_dnd.enums.language_codes.LANGUAGE_CODES, tgram.types.InlineKeyboardMarkup]], optinal) – the pre-made keyboards

• default_lang (tgram_dnd.enums.language_codes.LANGUAGE_CODES, optinal) – the default language to fetch if the user language is not supported

• bot_commands (list[tgram_dnd.enums.bot_command_input.BotCommandInput], optinal) – pre-made bot menu buttons/commands

• config_file (str, optinal) – The path to the configuration file which contains all the strings,keyboards,bot_commands etc

Returns:

None

configure(bot: TgBot) → None

used to apply the configurations

Parameters:

bot (tgram.client.TgBot)

Returns:

None

keyboard(key: str, force_language: tgram_dnd.enums.language_codes.LANGUAGE_CODES = None) → Callable

used to return a keyboard based on the user language

Parameters:

• key (string) – the keyboard key

• force_language (tgram_dnd.enums.language_codes.LANGUAGE_CODES) – a specfic language to force it on the keyboard (despite user language)

Returns:

a decorator to get the keyboard based on user language

Return type:

Decorator

load_file_data(file: str) → None

Loads data from ConfigFile

Parameters:

file (string) – file path

Returns:

None

load_strings() → None

string(key: str, force_language: tgram_dnd.enums.language_codes.LANGUAGE_CODES = None) → Callable

used to return a string based on the user language

Parameters:

• key (string) – the string key

• force_language (tgram_dnd.enums.language_codes.LANGUAGE_CODES) – a specfic language to force it on the string (despite user language)

Returns:

a decorator to get the string based on user language

Return type:

Decorator

tgram_dnd.errors module

exception tgram_dnd.errors.InvalidStrings(msg: str)

Bases: Exception

raised when the given strings argument is invalid

exception tgram_dnd.errors.StopBlock

Bases: Exception

used to stop the block Execution

exception tgram_dnd.errors.StopExecution

Bases: Exception

used to stop action Execution

tgram_dnd.utils module

tgram_dnd.utils.get_target_function(obj: object, function_name: str) → Callable | None

used to get a specific function from obj by getting its attribuites

# example with first class method
obj = Message
target = "reply_text"
method = get_target_function(obj, target)

print(method)
# <function Message.reply_text at 0xSomeAddress>

# example with indented method
obj = Message
target = "user.mention"
method = get_target_function(obj, target)

print(method)
# <funtion Message.User.mention at 0xSomeAddress>

Parameters:

• obj (object)

• function_name (str) – the wanted method seperated by dots, eg: obj_property.method_x

Returns:

Callable

tgram_dnd.utils.render_vars(string: str, *data) → Any

used to render all jinja-style variables

Parameters:

• string (str) – the target string

• *data (dict) – the data to fill with

Returns

Any

async tgram_dnd.utils.run_function(func: Callable | Action, *args, **kwargs) → Any

Module contents