feat: Text Utils

[AlbertUnruh]

What type of pull request is this?

• Non-breaking code change
• Breaking code change
• Documentation change/addition
• Tests change

Description

Adds a function to check whether something was mentioned somewhere.

Changes

• add naff.client.utils.text_utils

Checklist

• I've formatted my code with Black
• I've ensured my code works on Python 3.10.x
• I've tested my code

[LordOfPolls]

Why are you checking if the username is in the text? LordOfPolls isn't a mention <@174918559539920897> is

Further, if you removed that superfluous check you could squash this and the below if statements into one

[AlbertUnruh]

I don't want to check for (Discord) mentions, but for the presence itself (if it makes sense).

[LordOfPolls]

That seems counter-intuitive to the feature's name, nor how most people would assume it works.

Assuming we did go that route, however, using display_name would be better surely.

[AlbertUnruh]

*at least I would check for BaseUser.tag -> LordOfPolls#1010

[AlbertUnruh]

That seems counter-intuitive to the feature's name, nor how most people would assume it works.

Assuming we did go that route, however, using display_name would be better surely.

Any other suggestions for the features name?

[LordOfPolls]

I would suggest removing the username detection and keeping the name as it is. ;)

[silasary]

Username detection really feels prone to false positives. I definitely wouldn't want it by default.

[AlbertUnruh]

like so?

NAFF/naff/client/utils/text_utils.py

Lines 23 to 25 in da514aa

	elif isinstance(query, models.BaseUser):
	# mentions with <@!ID> aren't detected without the replacement
	return (query.mention in text.replace("@!", "@")) or (query.tag in text if const.tag_as_mention else False)

[LordOfPolls]

Inconsequential bits, otherwise LGTM