V1.5.0

[hikariatama]

• Fix on_change param processing in config
• Fix hikka.types.CoreOverwriteError
• Fix incorrect commit in info for users with multiple origins
• Fix error with module configs not being updated to values which were set by user
• Fix core unload and core overwrite errors not being raised correctly
• Fix config descriptions in APIRatelimiter
• Fix CoreOverwriteError handling
• Fix TelegramID validator to work with values between 2^32 and 2^64 - 1
• Fix web authorization messages being sent twice
• Fix duplicated animations in web
• Fix installation banner being shown after auth in web
• Fix form placeholder button being shown when not necessary
• Add @loader.tag(thumb_url="") decorator
• Add new inline help format
• Add internal method for debug calls (.invoke)
• Add Internal Debug Method (IDM) to inspect cache (inspect_cache)
• Add IDM inspect_modules
• Add IDM clear_cache, clear_entity_cache, clear_fulluser_cache, clear_fullchannel_cache, clear_perms_cache
• Add IDM reload_core to automatically reload core modules from disk
• Add ability to create custom IDMs
• Add fields flags and description to RegExp validator
• Add fields min_len and max_len to String validator
• Add Emoji validator
• Add EntityLike validator
• Add hikka.validators.MultiChoice
• Add utils.get_args_html to get arguments of command with HTML
• Add switch to mute @BotFather only once in hikka inline
• Add ability to forbid certain tl methods using .config APIRatelimiter
• Add new web interface design
• Add new code input design
• Add new 2fa password input design
• Add ability to set custom emojis in .info using command .setinfo. In order to use it, remove buttons using config
• Add full trace locals length limit
• Rework full trace locals to hashable converter
• Patch internal help module with bugfixes
• Clean type-hint mess, document utils and other methods, which were undocumented
• Remove redundant non-working code from configurator
• Remove redundant useless params --hosting, --no-nickname, --token, --web-only, --docker-deps-internal
• Migrate to lazy string interpolation in logging
• Reformat the whole code to match the desired code style
• Rename APIRatelimiter -> APILimiter
• Enable joinChannel and importChatInvite calls-by-external-modules blockage for all users by default
• Change inline query placeholder to user@hikka:~$ + legacy migration
• Completely drop Heroku support due to legacy code, limits and removing of free tier
• Allow user to send code only once to prevent FloodWaits
• Remove junk collector from tl cacher to keep old records so devs can access them w\o making new requests
• Remove FTG License in fully changed files
• Add official GoormIDE support

[sourcery-ai[bot]]

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.02%.

Quality metrics	Before	After	Change
Complexity	22.16 😞	22.33 😞	0.17 👎
Method Length	100.35 🙂	100.62 🙂	0.27 👎
Working memory	8.17 🙂	8.11 🙂	-0.06 👍
Quality	50.65% 🙂	50.67% 🙂	0.02% 👍

Other metrics	Before	After	Change
Lines	17304	17704	400

Changed files	Quality Before	Quality After	Quality Change
hikka/main.py	62.73% 🙂	57.97% 🙂	-4.76% 👎
hikka/configurator.py	74.12% 🙂	78.61% ⭐	4.49% 👍
hikka/database.py	71.01% 🙂	75.08% ⭐	4.07% 👍
hikka/dispatcher.py	32.16% 😞	32.59% 😞	0.43% 👍
hikka/loader.py	43.25% 😞	44.31% 😞	1.06% 👍
hikka/log.py	53.78% 🙂	55.36% 🙂	1.58% 👍
hikka/main.py	68.37% 🙂	72.94% 🙂	4.57% 👍
hikka/pointers.py	93.60% ⭐	93.60% ⭐	0.00%
hikka/security.py	40.51% 😞	40.50% 😞	-0.01% 👎
hikka/tl_cache.py	41.13% 😞	43.96% 😞	2.83% 👍
hikka/translations.py	69.42% 🙂	70.01% 🙂	0.59% 👍
hikka/types.py	81.29% ⭐	81.20% ⭐	-0.09% 👎
hikka/utils.py	56.71% 🙂	57.61% 🙂	0.90% 👍
hikka/validators.py	69.77% 🙂	67.76% 🙂	-2.01% 👎
hikka/version.py	86.81% ⭐	86.81% ⭐	0.00%
hikka/compat/geek.py	82.62% ⭐	82.62% ⭐	0.00%
hikka/inline/bot_pm.py	82.64% ⭐	81.93% ⭐	-0.71% 👎
hikka/inline/core.py	47.77% 😞	50.40% 🙂	2.63% 👍
hikka/inline/events.py	27.50% 😞	26.17% 😞	-1.33% 👎
hikka/inline/form.py	5.74% ⛔	5.78% ⛔	0.04% 👍
hikka/inline/gallery.py	35.26% 😞	35.09% 😞	-0.17% 👎
hikka/inline/list.py	18.39% ⛔	18.38% ⛔	-0.01% 👎
hikka/inline/query_gallery.py	18.50% ⛔	18.20% ⛔	-0.30% 👎
hikka/inline/token_obtainment.py	42.26% 😞	42.09% 😞	-0.17% 👎
hikka/inline/types.py	87.81% ⭐	88.04% ⭐	0.23% 👍
hikka/inline/utils.py	30.28% 😞	30.32% 😞	0.04% 👍
hikka/modules/api_protection.py	66.90% 🙂	68.35% 🙂	1.45% 👍
hikka/modules/help.py	21.19% ⛔	22.41% ⛔	1.22% 👍
hikka/modules/hikka_backup.py	68.12% 🙂	70.03% 🙂	1.91% 👍
hikka/modules/hikka_config.py	47.69% 😞	47.78% 😞	0.09% 👍
hikka/modules/hikka_info.py	65.32% 🙂	65.49% 🙂	0.17% 👍
hikka/modules/hikka_security.py	54.68% 🙂	55.72% 🙂	1.04% 👍
hikka/modules/hikka_settings.py	54.91% 🙂	51.75% 🙂	-3.16% 👎
hikka/modules/inline_stuff.py	62.90% 🙂	65.76% 🙂	2.86% 👍
hikka/modules/loader.py	32.23% 😞	33.70% 😞	1.47% 👍
hikka/modules/okteto_waker.py	60.31% 🙂	60.39% 🙂	0.08% 👍
hikka/modules/presets.py	78.79% ⭐	77.51% ⭐	-1.28% 👎
hikka/modules/python.py	51.80% 🙂	53.06% 🙂	1.26% 👍
hikka/modules/quickstart.py	75.49% ⭐	76.70% ⭐	1.21% 👍
hikka/modules/settings.py	74.27% 🙂	74.27% 🙂	0.00%
hikka/modules/test.py	39.91% 😞	40.40% 😞	0.49% 👍
hikka/modules/update_notifier.py	73.50% 🙂	74.00% 🙂	0.50% 👍
hikka/modules/updater.py	51.71% 🙂	57.86% 🙂	6.15% 👍
hikka/web/core.py	76.72% ⭐	77.13% ⭐	0.41% 👍
hikka/web/root.py	54.00% 🙂	54.51% 🙂	0.51% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
hikka/modules/loader.py	LoaderMod.load_module	148 ⛔	1924 ⛔		0.01% ⛔	Refactor to reduce nesting. Try splitting into smaller methods
hikka/inline/form.py	Form.form	86 ⛔	1043 ⛔		0.57% ⛔	Refactor to reduce nesting. Try splitting into smaller methods
hikka/inline/gallery.py	Gallery.gallery	78 ⛔	915 ⛔		0.93% ⛔	Refactor to reduce nesting. Try splitting into smaller methods
hikka/security.py	SecurityManager.check	110 ⛔	743 ⛔	27 ⛔	1.54% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
hikka/inline/list.py	List.list	55 ⛔	699 ⛔		3.66% ⛔	Refactor to reduce nesting. Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!