AdvancedTagScript 3.2.4__py3-none-any.whl → 3.2.5__py3-none-any.whl

TagScriptEngine/__init__.py

@@ -24,6 +24,7 @@ from .block import (
     helper_parse_if as helper_parse_if,
     helper_parse_list_if as helper_parse_list_if,
     helper_split as helper_split,
+    easier_helper_split as easier_helper_split,
     AllowedMentionsBlock as AllowedMentionsBlock,
     AllBlock as AllBlock,
     AnyBlock as AnyBlock,
@@ -55,6 +56,8 @@ from .block import (
     CountBlock as CountBlock,
     LengthBlock as LengthBlock,
     CooldownBlock as CooldownBlock,
+    JoinBlock as JoinBlock,
+
 )
 from .interface import (
     Adapter as Adapter,
@@ -97,6 +100,8 @@ __all__: Tuple[str, ...] = (
     "helper_parse_if",
     "helper_parse_list_if",
     "helper_split",
+    "easier_helper_split",
+    "AllowedMentionsBlock",
     "AllBlock",
     "AnyBlock",
     "AssignmentBlock",
@@ -127,6 +132,8 @@ __all__: Tuple[str, ...] = (
     "LowerBlock",
     "CountBlock",
     "LengthBlock",
+    "JoinBlock",
+
     "SafeObjectAdapter",
     "StringAdapter",
     "IntAdapter",
@@ -170,7 +177,7 @@ __all__: Tuple[str, ...] = (
 )
 
 
-__version__: Final[str] = "3.2.4"
+__version__: Final[str] = "3.2.5"
 
 
 class VersionNamedTuple(NamedTuple):

TagScriptEngine/block/__init__.py

@@ -89,6 +89,9 @@ from .count import (
     CountBlock as CountBlock,
     LengthBlock as LengthBlock,
 )
+from .joinblock import (
+    JoinBlock as JoinBlock,
+)
 
 __all__: Tuple[str, ...] = (
     "implicit_bool",
@@ -127,4 +130,5 @@ __all__: Tuple[str, ...] = (
     "LowerBlock",
     "CountBlock",
     "LengthBlock",
+    "JoinBlock",
 )

TagScriptEngine/block/case.py

@@ -12,7 +12,7 @@ __all__: Tuple[str, ...] = ("UpperBlock", "LowerBlock")
 class UpperBlock(Block):
     """Converts the given text to uppercase.
 
-    **Usage:**  ``{upper([text]))}``
+    **Usage:**  ``{upper([text])}``
 
     **Aliases:**  ``uppercase, upper``
 
@@ -22,10 +22,10 @@ class UpperBlock(Block):
 
     **Examples:**  ::
 
-        The text is {lower(ThIs Is A TeXt)}!
+        The text is {upper(ThIs Is A TeXt)}!
         # The text is THIS IS A TEXT!
 
-        You have entered {lower({args})}!
+        You have entered {upper({args})}!
         # You have entered HELLO WORLD!
     """
 

TagScriptEngine/block/count.py

@@ -11,25 +11,35 @@ __all__: Tuple[str, ...] = ("CountBlock", "LengthBlock")
 
 class CountBlock(verb_required_block(True, payload=True)):  # type: ignore
     """
-    The count block will count how much of text is in message.
-    This is case sensitive and will include substrings, if you
-    don't provide a parameter, it will count the spaces in the
-    message.
+    The count block counts occurrences of a substring within a message.
+    The search is case sensitive and includes overlapping substrings.
+
+    A payload (the message to search in) is **required**. Optionally,
+    pass the text to search for as a parameter. If no parameter is
+    provided, the block counts the number of words in the message
+    (spaces + 1).
 
     **Usage:** ``{count([text]):<message>}``
 
     **Aliases:** ``None``
 
-    **Payload:** ``message``
+    **Payload:** ``message`` (required)
+
+    **Parameter:** ``text`` (optional, the substring to count)
 
-    **Parameter:** text
+    **Examples:** ::
 
-    .. tagscript::
         {count(Tag):TagScriptEngine}
         # 1
 
-        {count(Tag): Tag Script Engine TagScriptEngine}
+        {count(Tag):Tag Script Engine TagScriptEngine}
         # 2
+
+        {count:hello world}
+        # 2 (word count: 1 space + 1)
+
+        {count(123)}
+        # Returns {count(123)} — rejected because no payload was provided
     """
 
     ACCEPTED_NAMES: Tuple[str, ...] = ("count",)
@@ -38,28 +48,28 @@ class CountBlock(verb_required_block(True, payload=True)):  # type: ignore
         if ctx.verb.parameter:
             payload: str = cast(str, ctx.verb.payload)
             return str(payload.count(ctx.verb.parameter))
-        return str(len(cast(str, ctx.verb.payload)) + 1)
+        return str(cast(str, ctx.verb.payload).count(" ") + 1)
 
 
-class LengthBlock(verb_required_block(True, payload=True)):  # type: ignore
+class LengthBlock(verb_required_block(True, parameter=True)):  # type: ignore
     """
-    The length block will check the length of the given String.
-    If a parameter is passed in, the block will check the length
-    based on what you passed in, w for word, s for spaces.
-    If you provide an invalid parameter, the block will return -1.
+    The length block returns the character count of the given text.
 
     **Usage:** ``{length(<text>)}``
 
     **Aliases:** ``len``
 
-    **Payload:** None
+    **Payload:** ``None``
+
+    **Parameter:** ``text`` (required)
 
-    **Parameter:** ``text``
+    **Examples:** ::
 
-    .. tagscript::
+        {len(TagScriptEngine)}
+        # 15
 
-        {len("TagScriptEngine")}
-        15
+        {len(hello world)}
+        # 11
     """
 
     ACCEPTED_NAMES: Tuple[str, ...] = ("length", "len")

TagScriptEngine/block/joinblock.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Optional, Tuple, cast
+
+from ..interface import verb_required_block
+from ..interpreter import Context
+
+
+__all__: Tuple[str, ...] = ("JoinBlock",)
+
+
+class JoinBlock(verb_required_block(False, payload=True, parameter=True)):  # type: ignore
+    """
+    The join block replaces every space in the payload with the parameter string.
+    These blocks only function in Tags.
+
+    The parameter must be set, even if it is an empty string.
+    Cannot use the symbols ``)`` or ``}`` as parameters.
+
+    **Usage:** ``{join(<string>):<payload>}``
+
+    **Aliases:** ``None``
+
+    **Payload:** payload
+
+    **Parameter:** string (required, can be empty)
+
+    **Examples:** ::
+
+        {join(_):hello friends}
+        # hello_friends
+
+        {join():an example sentence}
+        # anexamplesentence
+
+        {join(-):one two three}
+        # one-two-three
+    """
+
+    ACCEPTED_NAMES: Tuple[str, ...] = ("join",)
+
+    def process(self, ctx: Context) -> Optional[str]:
+        return cast(str, ctx.verb.payload).replace(" ", cast(str, ctx.verb.parameter))

TagScriptEngine/block/replaceblock.py

@@ -53,16 +53,19 @@ class PythonBlock(verb_required_block(True, payload=True, parameter=True)):  # t
 
     The ``in`` alias checks if the parameter is anywhere in the payload.
 
-    ``contain`` strictly checks if the parameter is the payload, split by whitespace.
+    The ``contains`` alias strictly checks if the parameter is in the payload, split by whitespace.
 
-    ``index`` finds the location of the parameter in the payload, split by whitespace.
-    If the parameter string is not found in the payload, it returns 1.
+    The ``index`` alias finds the location/index of the parameter in the payload, split by whitespace.
+    If the parameter string is not found in the payload, it returns -1.
 
-    index is used to return the value of the string form the given list of
+    .. note::
+
+        Both ``contains`` and ``index`` perform **exact** matching on whitespace-split words.
+        For example, ``food`` will **not** match ``food.`` (with trailing punctuation).
 
     **Usage:** ``{in(<string>):<payload>}``
 
-    **Aliases:** ``index``, ``contains``
+    **Aliases:** ``in``, ``contains``, ``index``
 
     **Payload:** payload
 
@@ -80,12 +83,16 @@ class PythonBlock(verb_required_block(True, payload=True, parameter=True)):  # t
         {contains(mute):How does it feel to be muted?}
         # false
         {contains(muted?):How does it feel to be muted?}
-        # false
+        # true
 
         {index(food):I love to eat food. everyone does.}
-        # 4
-        {index(pie):I love to eat food. everyone does.}
-        # -1
+        # -1 # because of the period. "food" != "food."
+        {index(food):I love to eat food everyone does}
+        # 4 # because "food" is the 4th word in the payload
+        {index(love):I love to eat food}
+        # 1 # because "love" is the 2nd word in the payload
+        {index(pie):I love to eat food}
+        # -1 # because "pie" is not in the payload
     """
 
     def will_accept(self, ctx: Context) -> bool:  # type: ignore

TagScriptEngine/block/stopblock.py

@@ -24,7 +24,7 @@ class StopBlock(verb_required_block(True, parameter=True)):  # type: ignore
 
     **Parameter:** bool
 
-    **Example:** ::
+    **Examples:** ::
 
         {stop({args}==):You must provide arguments for this tag.}
         # enforces providing arguments for a tag

TagScriptEngine/block/strf.py

@@ -16,7 +16,7 @@ class StrfBlock(Block):
     Two types of timestamps are supported: ISO and epoch.
     If a timestamp isn't passed, the current UTC time is used.
 
-    Invoking this block with `unix` will return the current Unix timestamp.
+    Invoking this block with ``unix`` will return the current Unix timestamp.
 
     **Usage:** ``{strf([timestamp]):<format>}``
 

TagScriptEngine/block/urlencodeblock.py

@@ -30,8 +30,8 @@ class URLEncodeBlock(verb_required_block(True, payload=True)):  # type: ignore
 
         # the following tagscript can be used to search up tag blocks
         # assume {args} = "command block"
-        # <https://seina-cogs.readthedocs.io/en/latest/search.html?q={urlencode(+):{args}}&check_keywords=yes&area=default>
-        # <https://seina-cogs.readthedocs.io/en/latest/search.html?q=command+block&check_keywords=yes&area=default>
+        # <https://cool-cogs.readthedocs.io/en/latest/search.html?q={urlencode(+):{args}}&check_keywords=yes&area=default>
+        # <https://cool-cogs.readthedocs.io/en/latest/search.html?q=command+block&check_keywords=yes&area=default>
     """
 
     ACCEPTED_NAMES: Tuple[str, ...] = ("urlencode",)

{advancedtagscript-3.2.4.dist-info → advancedtagscript-3.2.5.dist-info}/METADATA

@@ -1,15 +1,14 @@
 Metadata-Version: 2.4
 Name: AdvancedTagScript
-Version: 3.2.4
+Version: 3.2.5
 Summary: An easy drop in user-provided Templating system.
 Home-page: https://github.com/cool-aid-man/TagScriptEngine
 Author: cool-aid-man, inthedark.org, PhenoM4n4n
 Author-email: coolaid@duskybot.xyz
-License: Creative Commons Attribution 4.0 International License
+License: CC-BY-4.0
 Keywords: tagscript,string-templating,discord.py
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: Freely Distributable
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.8
@@ -41,7 +40,7 @@ Dynamic: license-file
     <img src="https://img.shields.io/pypi/v/AdvancedTagScript" alt="PyPI - Version">
 </a>
 <a href="https://advancedtagscript.readthedocs.io/en/latest/?badge=latest">
-    <img src="https://readthedocs.org/projects/tagscriptengine/badge/?version=latest" alt="Documentation Status" />
+    <img src="https://readthedocs.org/projects/AdvancedTagScript/badge/?version=latest" alt="Documentation Status" />
 </a>
 <a href="https://pypi.python.org/pypi/AdvancedTagScript/">
     <img src="https://img.shields.io/pypi/dm/AdvancedTagScript" alt="PyPI - Downloads" />

{advancedtagscript-3.2.4.dist-info → advancedtagscript-3.2.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-TagScriptEngine/__init__.py,sha256=PEJ3kfpYf2UUBeQCP_GNjLWQlSmSHo5kLKPMH_2QYQw,5911
+TagScriptEngine/__init__.py,sha256=X27OiTa2SvbM_SmT0rETVxgXJD_baJ6HLqE6X9AnKeE,6068
 TagScriptEngine/_warnings.py,sha256=pfMXaEVGpIue0eqgzZ6HkLXEka1UGl61-yuH9uEnVe4,2662
 TagScriptEngine/exceptions.py,sha256=lhvskKi2AySE5pul_iAA251jdMv-92QkjodR4X-G27Y,2833
 TagScriptEngine/interpreter.py,sha256=oiyKNXgZCsMmcCTkRnszVIqG_to7PmQKomCn_pX5sb8,16604
@@ -12,37 +12,37 @@ TagScriptEngine/adapter/intadapter.py,sha256=jENx5ah8k0U1PjJccV0NiYFsWFU9ZXTFgz3
 TagScriptEngine/adapter/objectadapter.py,sha256=7bW-Qd6gujq2ALdK3p0ONoCSPWCTv6srkkDNjzkvDEU,1017
 TagScriptEngine/adapter/redbotadapters.py,sha256=AFCu4QZGSHAMwyDFHBPT9XS5aaWVzj9Hu-pwI87DXi8,5934
 TagScriptEngine/adapter/stringadapter.py,sha256=VaJzkm1b8b7w1T90DjR3gOH0DIsZlWtcFe1YG7DOqBQ,1710
-TagScriptEngine/block/__init__.py,sha256=pWsnL9GJ69UmZf-VCxwdAb9Kv89KNyVw_fFM7MV0NkM,2994
+TagScriptEngine/block/__init__.py,sha256=JPyfutqST14cpSE8YgeY9PsM9cY2s5CkoNBMf3h5bmE,3070
 TagScriptEngine/block/allowedmentions.py,sha256=WMGWi1Fe0U_vUBsc4uyiX1XfQjGkhpdlyvq3HhCCLd4,2219
 TagScriptEngine/block/assign.py,sha256=l3DO41BVoXZbGSHsscSdNiSLddT7ggt1bPQoJdM1Iuo,1202
 TagScriptEngine/block/breakblock.py,sha256=nt3T7fDhTxH0jpO8lu0_3oC4XwVuKKg9cmkdLsZwzL8,1288
-TagScriptEngine/block/case.py,sha256=0DDWG9iN1uI5kE_NaZ2Ewfwg5Ki0nph0jHL2W1YQqdY,1442
+TagScriptEngine/block/case.py,sha256=KAayT5RGLOMV7g6glu9AV9DijErdT-2ph7yIleGLjZw,1441
 TagScriptEngine/block/command.py,sha256=1ljbZd_Mgg6Woqi6giz26coCRej-jyh4ENY_cdTwjK8,4307
-TagScriptEngine/block/comment.py,sha256=wsie7-PTupqDcuHNCflYiVip4sehR7S28GQzuXIJOQo,675
 TagScriptEngine/block/control.py,sha256=tALrHN0vbEXheMhoQOI_C0X_WjL3c-Qqd2zEd0rAZrE,5699
 TagScriptEngine/block/cooldown.py,sha256=F4HmFoIlxIhDWw8Z8PFZqP1FoEEBmAW4aipByZKZocY,4022
-TagScriptEngine/block/count.py,sha256=J_9t1N7huGktOvJTvs9jxS9z8ayK3BpB35MWbmuba2s,1867
+TagScriptEngine/block/count.py,sha256=URa5xadQ56X7uaBkhMew6KyMdlZDwuj3xKjIH_PK37U,2135
 TagScriptEngine/block/embedblock.py,sha256=NbudZCln0lEKO8WD5Zmh3W56E5jzmwBMezEaIbGcyqU,11008
 TagScriptEngine/block/fiftyfifty.py,sha256=QjQP96vpQPRVpuVcF5iI1kTCkM54vUBpKgK2TEZU6vQ,827
 TagScriptEngine/block/helpers.py,sha256=Zevy0tWzDAUKSD9hc6-nW7WTreRhqENgalfySwqhF7U,4386
+TagScriptEngine/block/joinblock.py,sha256=-TlxO-q8clBZIu0TJg7qT2i2ti6nLAVsev_zz0lGrI4,1096
 TagScriptEngine/block/loosevariablegetter.py,sha256=ym6u9HTWKN-Cgk6OQH5FVIiGnxsND2g5o4r3kRBGH9M,1231
 TagScriptEngine/block/mathblock.py,sha256=r69oCNUAjcGNO0QFBG7w9XCv7mvMrq__GoyhR7pW6fA,5802
 TagScriptEngine/block/randomblock.py,sha256=udC7mCGYrtN_Exg1XZZvqvvi8KkGNnRyTkuh-6rbeSo,1594
 TagScriptEngine/block/range.py,sha256=3dz6jgTIBloZyXgN7eXGsB7SBjK3Y-OJROmHOeOaJT4,1836
 TagScriptEngine/block/redirect.py,sha256=BobWl6xKqVV4FZlihmJoLPwI_i0P6Sn6G6fWFf9d8CE,1140
-TagScriptEngine/block/replaceblock.py,sha256=JbW-TEIQO4EgeZ3KKPKY2oIKKkVOq-syI4sIzN--OVk,3372
+TagScriptEngine/block/replaceblock.py,sha256=NXx6wdgI4r3MOw-E5oIbtrMEc9BdxpM9RipNRAkVhQU,3821
 TagScriptEngine/block/require_blacklist.py,sha256=3jFK8Ap_ataHZrqF3MWrmXrBI5CkIXq8G6QMEq0QQXY,2810
 TagScriptEngine/block/shortcutredirect.py,sha256=2F20L_7hYMxJY9s02XwxJQIWXaBQM_dwBNZKsOJQsk8,683
-TagScriptEngine/block/stopblock.py,sha256=eqNmy9ZUgstU-D7Vg5E5aOXxQSD1Dd1D1wH4rcXQEZQ,1090
-TagScriptEngine/block/strf.py,sha256=xL5HL8ADRnb2bYTCaRjZkV4K4y6ZMIb_HEONfTCdT4k,2048
+TagScriptEngine/block/stopblock.py,sha256=C10JCaajiVetEwnP_1T7SwhT8UmBQzWCPpdtDF16nZY,1091
+TagScriptEngine/block/strf.py,sha256=54oVyt8zVlnBWa9iSXtV7szc4eFcY-hUpjRSewzkm7M,2050
 TagScriptEngine/block/strictvariablegetter.py,sha256=XMwqGad3iy5esB2aTiD5v1EaCLGDFMvB1RF11G0-l2M,1251
 TagScriptEngine/block/substr.py,sha256=QNtoOIBBC-tD2v4vT1NzmrSA5THJ_pOqQLezxWED8ek,835
-TagScriptEngine/block/urlencodeblock.py,sha256=NlCSAbAgfPvG4Jh0L1ct8VyS9i4ow6V_5VXKsM36mNk,1398
+TagScriptEngine/block/urlencodeblock.py,sha256=sWqdSBk-uTZZjebKhAFmlROvnQvLcjvyISPTiWb4nwM,1396
 TagScriptEngine/interface/__init__.py,sha256=37lAOMONKmWDLiC5Ox9Y3TNQUQbzW54oUugbQe0e9gc,341
 TagScriptEngine/interface/adapter.py,sha256=4jBBz7hc-8fsRSZ5DWOrUxrhXqS0SvJCdW57TZl8sQo,1967
 TagScriptEngine/interface/block.py,sha256=S0hWRH6uqBz_cYRIh3LGMyo63UK6gNidtf6EiLUKL0c,3653
-advancedtagscript-3.2.4.dist-info/licenses/LICENSE,sha256=NvdimESU3jrNgd_8E4i-eTecQ_jGegRrrWk1v2gOnHY,252
-advancedtagscript-3.2.4.dist-info/METADATA,sha256=qa42aduC-bFUe0vJJUaBXSqdycyD_V4QpEkE_UZPafU,3653
-advancedtagscript-3.2.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-advancedtagscript-3.2.4.dist-info/top_level.txt,sha256=6lY4lZDvWxraERrit1lvDsCCDdfo9e83kk_tBemAJCo,16
-advancedtagscript-3.2.4.dist-info/RECORD,,
+advancedtagscript-3.2.5.dist-info/licenses/LICENSE,sha256=NvdimESU3jrNgd_8E4i-eTecQ_jGegRrrWk1v2gOnHY,252
+advancedtagscript-3.2.5.dist-info/METADATA,sha256=oAjLywIMfGdHeRzKxJJkHQn-I11q8ya5haXYGylIe_Y,3565
+advancedtagscript-3.2.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+advancedtagscript-3.2.5.dist-info/top_level.txt,sha256=6lY4lZDvWxraERrit1lvDsCCDdfo9e83kk_tBemAJCo,16
+advancedtagscript-3.2.5.dist-info/RECORD,,

TagScriptEngine/block/comment.py

@@ -1,29 +0,0 @@
-from typing import Optional, Tuple
-from ..interface import Block
-from ..interpreter import Context
-
-
-class CommentBlock(Block):
-    """
-    The comment block is just for comments, it will not be parsed,
-    however it will be removed from your tag's output.
-
-    **Usage:** ``{comment([other]):[text]}``
-
-    **Aliases:** /, Comment, comment, //, #
-
-    **Payload:** ``text``
-
-    **Parameter:** ``other``
-
-    .. tagscript::
-
-        {#:Comment!}
-
-        {Comment(Something):Comment!}
-    """
-
-    ACCEPTED_NAMES: Tuple[str, ...] = ("/", "Comment", "comment", "//", "#")
-
-    def process(self, ctx: Context) -> Optional[str]:
-        return ""